Class: OCI::DataCatalog::DataCatalogClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/data_catalog_client.rb

Overview

Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata. For more information, see Data Catalog.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DataCatalogClient

Creates a new DataCatalogClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 56

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190325'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DataCatalogClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 30

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



26
27
28
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#add_catalog_lock(catalog_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_catalog_lock API.

Adds a lock to a Catalog resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 119

def add_catalog_lock(catalog_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#add_catalog_lock.' if logger

  raise "Missing the required parameter 'catalog_id' when calling add_catalog_lock." if catalog_id.nil?
  raise "Missing the required parameter 'add_resource_lock_details' when calling add_catalog_lock." if add_resource_lock_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/addLock'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#add_catalog_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Catalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_catalog_private_endpoint_lock(catalog_private_endpoint_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_catalog_private_endpoint_lock API.

Adds a lock to a CatalogPrivateEndpoint resource.

Parameters:

  • catalog_private_endpoint_id (String) —

    Unique private reverse connection identifier.

  • add_resource_lock_details (OCI::DataCatalog::Models::AddResourceLockDetails) —

    AddResourceLockDetails body parameter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 182

def add_catalog_private_endpoint_lock(catalog_private_endpoint_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#add_catalog_private_endpoint_lock.' if logger

  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling add_catalog_private_endpoint_lock." if catalog_private_endpoint_id.nil?
  raise "Missing the required parameter 'add_resource_lock_details' when calling add_catalog_private_endpoint_lock." if add_resource_lock_details.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/addLock'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#add_catalog_private_endpoint_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CatalogPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_data_selector_patterns API.

Add data selector pattern to the data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • data_selector_pattern_details (OCI::DataCatalog::Models::DataSelectorPatternDetails) —

    The information used to add the patterns for deriving logical entities.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 252

def add_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#add_data_selector_patterns.' if logger

  raise "Missing the required parameter 'catalog_id' when calling add_data_selector_patterns." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling add_data_selector_patterns." if data_asset_key.nil?
  raise "Missing the required parameter 'data_selector_pattern_details' when calling add_data_selector_patterns." if data_selector_pattern_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/addDataSelectorPatterns'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(data_selector_pattern_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#add_data_selector_patterns') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_metastore_lock(metastore_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_metastore_lock API.

Adds a lock to a Metastore resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 319

def add_metastore_lock(metastore_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#add_metastore_lock.' if logger

  raise "Missing the required parameter 'metastore_id' when calling add_metastore_lock." if metastore_id.nil?
  raise "Missing the required parameter 'add_resource_lock_details' when calling add_metastore_lock." if add_resource_lock_details.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}/actions/addLock'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#add_metastore_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Metastore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#associate_custom_property(catalog_id, type_key, associate_custom_property_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use associate_custom_property API.

Associate the custom property for the given type

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • type_key (String) —

    Unique type key.

  • associate_custom_property_details (OCI::DataCatalog::Models::TypeCustomPropertyDetails) —

    The information used to associate the custom property for the type.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 390

def associate_custom_property(catalog_id, type_key, associate_custom_property_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#associate_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling associate_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'type_key' when calling associate_custom_property." if type_key.nil?
  raise "Missing the required parameter 'associate_custom_property_details' when calling associate_custom_property." if associate_custom_property_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'type_key' must not be blank" if OCI::Internal::Util.blank_string?(type_key)

  path = '/catalogs/{catalogId}/types/{typeKey}/actions/associateCustomProperties'.sub('{catalogId}', catalog_id.to_s).sub('{typeKey}', type_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(associate_custom_property_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#associate_custom_property') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Type'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#asynchronous_export_data_asset(catalog_id, data_asset_key, asynchronous_export_data_asset_details, export_type, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use asynchronous_export_data_asset API.

Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • asynchronous_export_data_asset_details (OCI::DataCatalog::Models::AsynchronousExportDataAssetDetails) —

    Details needed by the Data Asset export request.

  • export_type (Array<String>) —

    Type of export. Allowed values are: CUSTOM_PROPERTY_VALUES, ALL

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 460

def asynchronous_export_data_asset(catalog_id, data_asset_key, asynchronous_export_data_asset_details, export_type, opts = {})
  logger.debug 'Calling operation DataCatalogClient#asynchronous_export_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling asynchronous_export_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling asynchronous_export_data_asset." if data_asset_key.nil?
  raise "Missing the required parameter 'asynchronous_export_data_asset_details' when calling asynchronous_export_data_asset." if asynchronous_export_data_asset_details.nil?
  raise "Missing the required parameter 'export_type' when calling asynchronous_export_data_asset." if export_type.nil?

  export_type_allowable_values = %w[CUSTOM_PROPERTY_VALUES ALL]
  export_type.each do |val_to_check|
    unless export_type_allowable_values.include?(val_to_check)
      raise "Invalid value for 'export_type', must be one of CUSTOM_PROPERTY_VALUES, ALL."
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/asynchronousExport'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:exportType] = OCI::ApiClient.build_collection_params(export_type, :multi)

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(asynchronous_export_data_asset_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#asynchronous_export_data_asset') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AsynchronousExportDataAssetResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#asynchronous_export_glossary(catalog_id, glossary_key, asynchronous_export_glossary_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use asynchronous_export_glossary API.

Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • asynchronous_export_glossary_details (OCI::DataCatalog::Models::AsynchronousExportGlossaryDetails) —

    Details needed by the glossary export request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 537

def asynchronous_export_glossary(catalog_id, glossary_key, asynchronous_export_glossary_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#asynchronous_export_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling asynchronous_export_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling asynchronous_export_glossary." if glossary_key.nil?
  raise "Missing the required parameter 'asynchronous_export_glossary_details' when calling asynchronous_export_glossary." if asynchronous_export_glossary_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/actions/asynchronousExport'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(asynchronous_export_glossary_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#asynchronous_export_glossary') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AsynchronousExportGlossaryResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#attach_catalog_private_endpoint(attach_catalog_private_endpoint_details, catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use attach_catalog_private_endpoint API.

Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 610

def attach_catalog_private_endpoint(attach_catalog_private_endpoint_details, catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#attach_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'attach_catalog_private_endpoint_details' when calling attach_catalog_private_endpoint." if attach_catalog_private_endpoint_details.nil?
  raise "Missing the required parameter 'catalog_id' when calling attach_catalog_private_endpoint." if catalog_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/attachCatalogPrivateEndpoint'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(attach_catalog_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#attach_catalog_private_endpoint') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_catalog_compartment(change_catalog_compartment_details, catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_catalog_compartment API.

Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 676

def change_catalog_compartment(change_catalog_compartment_details, catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#change_catalog_compartment.' if logger

  raise "Missing the required parameter 'change_catalog_compartment_details' when calling change_catalog_compartment." if change_catalog_compartment_details.nil?
  raise "Missing the required parameter 'catalog_id' when calling change_catalog_compartment." if catalog_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/changeCompartment'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_catalog_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#change_catalog_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_catalog_private_endpoint_compartment(change_catalog_private_endpoint_compartment_details, catalog_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_catalog_private_endpoint_compartment API.

Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 740

def change_catalog_private_endpoint_compartment(change_catalog_private_endpoint_compartment_details, catalog_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#change_catalog_private_endpoint_compartment.' if logger

  raise "Missing the required parameter 'change_catalog_private_endpoint_compartment_details' when calling change_catalog_private_endpoint_compartment." if change_catalog_private_endpoint_compartment_details.nil?
  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling change_catalog_private_endpoint_compartment." if catalog_private_endpoint_id.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/changeCompartment'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_catalog_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#change_catalog_private_endpoint_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_metastore_compartment(change_metastore_compartment_details, metastore_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_metastore_compartment API.

Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 804

def change_metastore_compartment(change_metastore_compartment_details, metastore_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#change_metastore_compartment.' if logger

  raise "Missing the required parameter 'change_metastore_compartment_details' when calling change_metastore_compartment." if change_metastore_compartment_details.nil?
  raise "Missing the required parameter 'metastore_id' when calling change_metastore_compartment." if metastore_id.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}/actions/changeCompartment'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_metastore_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#change_metastore_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_attribute(catalog_id, data_asset_key, entity_key, create_attribute_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_attribute API.

Creates a new entity attribute.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • create_attribute_details (OCI::DataCatalog::Models::CreateAttributeDetails) —

    The information used to create an entity attribute.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 869

def create_attribute(catalog_id, data_asset_key, entity_key, create_attribute_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_attribute.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_attribute." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_attribute." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling create_attribute." if entity_key.nil?
  raise "Missing the required parameter 'create_attribute_details' when calling create_attribute." if create_attribute_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_attribute_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_attribute') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Attribute'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, create_attribute_tag_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_attribute_tag API.

Creates a new entity attribute tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • create_attribute_tag_details (OCI::DataCatalog::Models::CreateTagDetails) —

    The information used to create an entity attribute tag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 940

def create_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, create_attribute_tag_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_attribute_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_attribute_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_attribute_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling create_attribute_tag." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling create_attribute_tag." if attribute_key.nil?
  raise "Missing the required parameter 'create_attribute_tag_details' when calling create_attribute_tag." if create_attribute_tag_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_attribute_tag_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_attribute_tag') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AttributeTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_catalog(create_catalog_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_catalog API.

Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. For more information, please see the documentation.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1011

def create_catalog(create_catalog_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_catalog.' if logger

  raise "Missing the required parameter 'create_catalog_details' when calling create_catalog." if create_catalog_details.nil?

  path = '/catalogs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_catalog_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_catalog') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_catalog_private_endpoint(create_catalog_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_catalog_private_endpoint API.

Create a new private reverse connection endpoint.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1071

def create_catalog_private_endpoint(create_catalog_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'create_catalog_private_endpoint_details' when calling create_catalog_private_endpoint." if create_catalog_private_endpoint_details.nil?

  path = '/catalogPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_catalog_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_catalog_private_endpoint') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_connection(catalog_id, data_asset_key, create_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_connection API.

Creates a new connection.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • create_connection_details (OCI::DataCatalog::Models::CreateConnectionDetails) —

    The information used to create the connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1133

def create_connection(catalog_id, data_asset_key, create_connection_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'create_connection_details' when calling create_connection." if create_connection_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_custom_property(catalog_id, namespace_id, create_custom_property_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_custom_property API.

Create a new Custom Property

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • create_custom_property_details (OCI::DataCatalog::Models::CreateCustomPropertyDetails) —

    The information used to create the Custom Property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1201

def create_custom_property(catalog_id, namespace_id, create_custom_property_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling create_custom_property." if namespace_id.nil?
  raise "Missing the required parameter 'create_custom_property_details' when calling create_custom_property." if create_custom_property_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}/customProperties'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_custom_property_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_custom_property') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CustomProperty'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_data_asset(catalog_id, create_data_asset_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_data_asset API.

Create a new data asset.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1267

def create_data_asset(catalog_id, create_data_asset_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'create_data_asset_details' when calling create_data_asset." if create_data_asset_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/dataAssets'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_data_asset_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_data_asset') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_data_asset_tag(catalog_id, data_asset_key, create_data_asset_tag_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_data_asset_tag API.

Creates a new data asset tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • create_data_asset_tag_details (OCI::DataCatalog::Models::CreateTagDetails) —

    The information used to create the data asset tag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1332

def create_data_asset_tag(catalog_id, data_asset_key, create_data_asset_tag_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_data_asset_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_data_asset_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_data_asset_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'create_data_asset_tag_details' when calling create_data_asset_tag." if create_data_asset_tag_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_data_asset_tag_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_data_asset_tag') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAssetTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_entity(catalog_id, data_asset_key, create_entity_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_entity API.

Creates a new data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • create_entity_details (OCI::DataCatalog::Models::CreateEntityDetails) —

    The information used to create the data entity.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1399

def create_entity(catalog_id, data_asset_key, create_entity_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_entity.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_entity." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_entity." if data_asset_key.nil?
  raise "Missing the required parameter 'create_entity_details' when calling create_entity." if create_entity_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_entity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_entity') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Entity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_entity_tag(catalog_id, data_asset_key, entity_key, create_entity_tag_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_entity_tag API.

Creates a new entity tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • create_entity_tag_details (OCI::DataCatalog::Models::CreateTagDetails) —

    The information used to create the entity tag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1467

def create_entity_tag(catalog_id, data_asset_key, entity_key, create_entity_tag_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_entity_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_entity_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_entity_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling create_entity_tag." if entity_key.nil?
  raise "Missing the required parameter 'create_entity_tag_details' when calling create_entity_tag." if create_entity_tag_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_entity_tag_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_entity_tag') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_folder(catalog_id, data_asset_key, create_folder_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_folder API.

Creates a new folder.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • create_folder_details (OCI::DataCatalog::Models::CreateFolderDetails) —

    The information used to create the folder.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1536

def create_folder(catalog_id, data_asset_key, create_folder_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_folder.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_folder." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_folder." if data_asset_key.nil?
  raise "Missing the required parameter 'create_folder_details' when calling create_folder." if create_folder_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_folder_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_folder') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Folder'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_folder_tag(catalog_id, data_asset_key, folder_key, create_folder_tag_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_folder_tag API.

Creates a new folder tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • create_folder_tag_details (OCI::DataCatalog::Models::CreateTagDetails) —

    The information used to create the folder tag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1604

def create_folder_tag(catalog_id, data_asset_key, folder_key, create_folder_tag_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_folder_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_folder_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling create_folder_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling create_folder_tag." if folder_key.nil?
  raise "Missing the required parameter 'create_folder_tag_details' when calling create_folder_tag." if create_folder_tag_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_folder_tag_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_folder_tag') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::FolderTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_glossary(catalog_id, create_glossary_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_glossary API.

Creates a new glossary.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1672

def create_glossary(catalog_id, create_glossary_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'create_glossary_details' when calling create_glossary." if create_glossary_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/glossaries'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_glossary_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_glossary') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Glossary'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job(catalog_id, create_job_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_job API.

Creates a new job.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • create_job_details (OCI::DataCatalog::Models::CreateJobDetails) —

    The information used to create the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type Job



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1736

def create_job(catalog_id, create_job_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_job.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_job." if catalog_id.nil?
  raise "Missing the required parameter 'create_job_details' when calling create_job." if create_job_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/jobs'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_job') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job_definition(catalog_id, create_job_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_job_definition API.

Creates a new job definition.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1800

def create_job_definition(catalog_id, create_job_definition_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_job_definition.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_job_definition." if catalog_id.nil?
  raise "Missing the required parameter 'create_job_definition_details' when calling create_job_definition." if create_job_definition_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/jobDefinitions'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_job_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_job_definition') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job_execution(catalog_id, job_key, create_job_execution_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_job_execution API.

Creates a new job execution.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • create_job_execution_details (OCI::DataCatalog::Models::CreateJobExecutionDetails) —

    The information used to create the job execution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1865

def create_job_execution(catalog_id, job_key, create_job_execution_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_job_execution.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_job_execution." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling create_job_execution." if job_key.nil?
  raise "Missing the required parameter 'create_job_execution_details' when calling create_job_execution." if create_job_execution_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_job_execution_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_job_execution') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobExecution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_metastore(create_metastore_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_metastore API.

Creates a new metastore.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1931

def create_metastore(create_metastore_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_metastore.' if logger

  raise "Missing the required parameter 'create_metastore_details' when calling create_metastore." if create_metastore_details.nil?

  path = '/metastores'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_metastore_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_metastore') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_namespace(catalog_id, create_namespace_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_namespace API.

Create a new Namespace to be used by a custom property

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 1993

def create_namespace(catalog_id, create_namespace_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_namespace.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_namespace." if catalog_id.nil?
  raise "Missing the required parameter 'create_namespace_details' when calling create_namespace." if create_namespace_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/namespaces'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_namespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_namespace') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Namespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_pattern(catalog_id, create_pattern_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_pattern API.

Create a new pattern.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • create_pattern_details (OCI::DataCatalog::Models::CreatePatternDetails) —

    The information used to create the pattern.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2057

def create_pattern(catalog_id, create_pattern_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_pattern.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_pattern." if catalog_id.nil?
  raise "Missing the required parameter 'create_pattern_details' when calling create_pattern." if create_pattern_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/patterns'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_pattern_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_pattern') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Pattern'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_term(catalog_id, glossary_key, create_term_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_term API.

Create a new term within a glossary.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • create_term_details (OCI::DataCatalog::Models::CreateTermDetails) —

    The information used to create the term.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2122

def create_term(catalog_id, glossary_key, create_term_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_term.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_term." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling create_term." if glossary_key.nil?
  raise "Missing the required parameter 'create_term_details' when calling create_term." if create_term_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_term_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_term') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Term'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_term_relationship(catalog_id, glossary_key, term_key, create_term_relationship_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_term_relationship API.

Creates a new term relationship for this term within a glossary.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • create_term_relationship_details (OCI::DataCatalog::Models::CreateTermRelationshipDetails) —

    The information used to create the term relationship.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2190

def create_term_relationship(catalog_id, glossary_key, term_key, create_term_relationship_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#create_term_relationship.' if logger

  raise "Missing the required parameter 'catalog_id' when calling create_term_relationship." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling create_term_relationship." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling create_term_relationship." if term_key.nil?
  raise "Missing the required parameter 'create_term_relationship_details' when calling create_term_relationship." if create_term_relationship_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_term_relationship_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#create_term_relationship') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_attribute API.

Deletes a specific entity attribute.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2260

def delete_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_attribute.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_attribute." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_attribute." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling delete_attribute." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling delete_attribute." if attribute_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_attribute') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_attribute_tag API.

Deletes a specific entity attribute tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2330

def delete_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_attribute_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_attribute_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_attribute_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling delete_attribute_tag." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling delete_attribute_tag." if attribute_key.nil?
  raise "Missing the required parameter 'tag_key' when calling delete_attribute_tag." if tag_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_attribute_tag') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_catalog(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_catalog API.

Deletes a data catalog resource by identifier.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2399

def delete_catalog(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_catalog.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_catalog." if catalog_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_catalog') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_catalog_private_endpoint(catalog_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_catalog_private_endpoint API.

Deletes a private reverse connection endpoint by identifier.

Parameters:

  • catalog_private_endpoint_id (String) —

    Unique private reverse connection identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2461

def delete_catalog_private_endpoint(catalog_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling delete_catalog_private_endpoint." if catalog_private_endpoint_id.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_catalog_private_endpoint') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_connection(catalog_id, data_asset_key, connection_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_connection API.

Deletes a specific connection of a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • connection_key (String) —

    Unique connection key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2524

def delete_connection(catalog_id, data_asset_key, connection_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'connection_key' when calling delete_connection." if connection_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{connectionKey}', connection_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_connection') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_custom_property(catalog_id, namespace_id, custom_property_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_custom_property API.

Deletes a specific custom property identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • custom_property_key (String) —

    Unique Custom Property key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2590

def delete_custom_property(catalog_id, namespace_id, custom_property_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling delete_custom_property." if namespace_id.nil?
  raise "Missing the required parameter 'custom_property_key' when calling delete_custom_property." if custom_property_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)
  raise "Parameter value for 'custom_property_key' must not be blank" if OCI::Internal::Util.blank_string?(custom_property_key)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s).sub('{customPropertyKey}', custom_property_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_custom_property') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_data_asset(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_data_asset API.

Deletes a specific data asset identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2655

def delete_data_asset(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_data_asset." if data_asset_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_data_asset') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_data_asset_tag API.

Deletes a specific data asset tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2719

def delete_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_data_asset_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_data_asset_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_data_asset_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'tag_key' when calling delete_data_asset_tag." if tag_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_data_asset_tag') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_entity(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_entity API.

Deletes a specific data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2785

def delete_entity(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_entity.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_entity." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_entity." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling delete_entity." if entity_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_entity') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_entity_tag API.

Deletes a specific entity tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2852

def delete_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_entity_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_entity_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_entity_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling delete_entity_tag." if entity_key.nil?
  raise "Missing the required parameter 'tag_key' when calling delete_entity_tag." if tag_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_entity_tag') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_folder(catalog_id, data_asset_key, folder_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_folder API.

Deletes a specific folder of a data asset identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2920

def delete_folder(catalog_id, data_asset_key, folder_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_folder.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_folder." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_folder." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling delete_folder." if folder_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_folder') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_folder_tag API.

Deletes a specific folder tag.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 2987

def delete_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_folder_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_folder_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling delete_folder_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling delete_folder_tag." if folder_key.nil?
  raise "Missing the required parameter 'tag_key' when calling delete_folder_tag." if tag_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_folder_tag') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_glossary(catalog_id, glossary_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_glossary API.

Deletes a specific glossary identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3054

def delete_glossary(catalog_id, glossary_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling delete_glossary." if glossary_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_glossary') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_job(catalog_id, job_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_job API.

Deletes a specific job identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3117

def delete_job(catalog_id, job_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_job.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_job." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling delete_job." if job_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_job') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_job_definition(catalog_id, job_definition_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_job_definition API.

Deletes a specific job definition identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_definition_key (String) —

    Unique job definition key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3180

def delete_job_definition(catalog_id, job_definition_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_job_definition.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_job_definition." if catalog_id.nil?
  raise "Missing the required parameter 'job_definition_key' when calling delete_job_definition." if job_definition_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_definition_key' must not be blank" if OCI::Internal::Util.blank_string?(job_definition_key)

  path = '/catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobDefinitionKey}', job_definition_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_job_definition') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_metastore(metastore_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_metastore API.

Deletes a metastore resource by identifier.

Parameters:

  • metastore_id (String) —

    The metastore's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3243

def delete_metastore(metastore_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_metastore.' if logger

  raise "Missing the required parameter 'metastore_id' when calling delete_metastore." if metastore_id.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_metastore') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_namespace(catalog_id, namespace_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_namespace API.

Deletes a specific Namespace identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3305

def delete_namespace(catalog_id, namespace_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_namespace.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_namespace." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling delete_namespace." if namespace_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_namespace') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_pattern(catalog_id, pattern_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_pattern API.

Deletes a specific pattern identified by it's key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • pattern_key (String) —

    Unique pattern key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3368

def delete_pattern(catalog_id, pattern_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_pattern.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_pattern." if catalog_id.nil?
  raise "Missing the required parameter 'pattern_key' when calling delete_pattern." if pattern_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)

  path = '/catalogs/{catalogId}/patterns/{patternKey}'.sub('{catalogId}', catalog_id.to_s).sub('{patternKey}', pattern_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_pattern') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_term(catalog_id, glossary_key, term_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_term API.

Deletes a specific glossary term.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3432

def delete_term(catalog_id, glossary_key, term_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_term.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_term." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling delete_term." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling delete_term." if term_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_term') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_term_relationship API.

Deletes a specific glossary term relationship.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • term_relationship_key (String) —

    Unique glossary term relationship key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3499

def delete_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#delete_term_relationship.' if logger

  raise "Missing the required parameter 'catalog_id' when calling delete_term_relationship." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling delete_term_relationship." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling delete_term_relationship." if term_key.nil?
  raise "Missing the required parameter 'term_relationship_key' when calling delete_term_relationship." if term_relationship_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)
  raise "Parameter value for 'term_relationship_key' must not be blank" if OCI::Internal::Util.blank_string?(term_relationship_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s).sub('{termRelationshipKey}', term_relationship_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#delete_term_relationship') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#detach_catalog_private_endpoint(detach_catalog_private_endpoint_details, catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use detach_catalog_private_endpoint API.

Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3567

def detach_catalog_private_endpoint(detach_catalog_private_endpoint_details, catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#detach_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'detach_catalog_private_endpoint_details' when calling detach_catalog_private_endpoint." if detach_catalog_private_endpoint_details.nil?
  raise "Missing the required parameter 'catalog_id' when calling detach_catalog_private_endpoint." if catalog_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/detachCatalogPrivateEndpoint'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(detach_catalog_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#detach_catalog_private_endpoint') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#disassociate_custom_property(catalog_id, type_key, disassociate_custom_property_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disassociate_custom_property API.

Remove the custom property for the given type

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • type_key (String) —

    Unique type key.

  • disassociate_custom_property_details (OCI::DataCatalog::Models::TypeCustomPropertyDetails) —

    The information used to remove the custom properties.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3638

def disassociate_custom_property(catalog_id, type_key, disassociate_custom_property_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#disassociate_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling disassociate_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'type_key' when calling disassociate_custom_property." if type_key.nil?
  raise "Missing the required parameter 'disassociate_custom_property_details' when calling disassociate_custom_property." if disassociate_custom_property_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'type_key' must not be blank" if OCI::Internal::Util.blank_string?(type_key)

  path = '/catalogs/{catalogId}/types/{typeKey}/actions/disassociateCustomProperties'.sub('{catalogId}', catalog_id.to_s).sub('{typeKey}', type_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(disassociate_custom_property_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#disassociate_custom_property') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Type'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#expand_tree_for_glossary(catalog_id, glossary_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use expand_tree_for_glossary API.

Returns the fully expanded tree hierarchy of parent and child terms in this glossary.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3705

def expand_tree_for_glossary(catalog_id, glossary_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#expand_tree_for_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling expand_tree_for_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling expand_tree_for_glossary." if glossary_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/actions/expandTree'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#expand_tree_for_glossary') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::GlossaryTreeElement>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#export_glossary(catalog_id, glossary_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use export_glossary API.

Export the glossary and the terms and return the exported glossary as csv or json.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_relationship_exported (BOOLEAN) —

    Specify if the relationship metadata is exported for the glossary. (default to false)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type String



3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3771

def export_glossary(catalog_id, glossary_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#export_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling export_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling export_glossary." if glossary_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/actions/export'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isRelationshipExported] = opts[:is_relationship_exported] if !opts[:is_relationship_exported].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#export_glossary') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'String'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#fetch_entity_lineage(catalog_id, data_asset_key, entity_key, fetch_entity_lineage_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use fetch_entity_lineage API.

Returns lineage for a given entity object.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • fetch_entity_lineage_details (OCI::DataCatalog::Models::FetchEntityLineageDetails) —

    The information needed to obtain desired lineage.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3841

def fetch_entity_lineage(catalog_id, data_asset_key, entity_key, fetch_entity_lineage_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#fetch_entity_lineage.' if logger

  raise "Missing the required parameter 'catalog_id' when calling fetch_entity_lineage." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling fetch_entity_lineage." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling fetch_entity_lineage." if entity_key.nil?
  raise "Missing the required parameter 'fetch_entity_lineage_details' when calling fetch_entity_lineage." if fetch_entity_lineage_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/fetchLineage'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(fetch_entity_lineage_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#fetch_entity_lineage') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityLineage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_attribute API.

Gets a specific entity attribute by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_include_object_relationships (BOOLEAN) —

    Indicates whether the list of objects and their relationships to this object will be provided in the response. (default to false)

  • :fields (Array<String>) —

    Specifies the fields to return in an entity attribute response.

    Allowed values are: key, displayName, description, entityKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, externalDataType, externalKey, isIncrementalData, isNullable, length, position, precision, scale, timeExternal, uri, properties, path, minCollectionCount, maxCollectionCount, datatypeEntityKey, externalDatatypeEntityKey, parentAttributeKey, externalParentAttributeKey, typeKey

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3910

def get_attribute(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_attribute.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_attribute." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_attribute." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling get_attribute." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling get_attribute." if attribute_key.nil?


  fields_allowable_values = %w[key displayName description entityKey lifecycleState timeCreated timeUpdated createdById updatedById externalDataType externalKey isIncrementalData isNullable length position precision scale timeExternal uri properties path minCollectionCount maxCollectionCount datatypeEntityKey externalDatatypeEntityKey parentAttributeKey externalParentAttributeKey typeKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, entityKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, externalDataType, externalKey, isIncrementalData, isNullable, length, position, precision, scale, timeExternal, uri, properties, path, minCollectionCount, maxCollectionCount, datatypeEntityKey, externalDatatypeEntityKey, parentAttributeKey, externalParentAttributeKey, typeKey.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isIncludeObjectRelationships] = opts[:is_include_object_relationships] if !opts[:is_include_object_relationships].nil?
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_attribute') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Attribute'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_attribute_tag API.

Gets a specific entity attribute tag by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in an entity attribute tag response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, attributeKey

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 3989

def get_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_attribute_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_attribute_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_attribute_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling get_attribute_tag." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling get_attribute_tag." if attribute_key.nil?
  raise "Missing the required parameter 'tag_key' when calling get_attribute_tag." if tag_key.nil?


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated createdById uri attributeKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, attributeKey.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_attribute_tag') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AttributeTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_catalog(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_catalog API.

Gets a data catalog by identifier.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4062

def get_catalog(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_catalog.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_catalog." if catalog_id.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_catalog') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Catalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_catalog_private_endpoint(catalog_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_catalog_private_endpoint API.

Gets a specific private reverse connection by identifier.

Parameters:

  • catalog_private_endpoint_id (String) —

    Unique private reverse connection identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4116

def get_catalog_private_endpoint(catalog_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling get_catalog_private_endpoint." if catalog_private_endpoint_id.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_catalog_private_endpoint') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CatalogPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_connection(catalog_id, data_asset_key, connection_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_connection API.

Gets a specific data asset connection by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • connection_key (String) —

    Unique connection key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a connection response.

    Allowed values are: key, displayName, description, dataAssetKey, typeKey, timeCreated, timeUpdated, createdById, updatedById, properties, externalKey, timeStatusUpdated, lifecycleState, isDefault, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4175

def get_connection(catalog_id, data_asset_key, connection_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'connection_key' when calling get_connection." if connection_key.nil?


  fields_allowable_values = %w[key displayName description dataAssetKey typeKey timeCreated timeUpdated createdById updatedById properties externalKey timeStatusUpdated lifecycleState isDefault uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataAssetKey, typeKey, timeCreated, timeUpdated, createdById, updatedById, properties, externalKey, timeStatusUpdated, lifecycleState, isDefault, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{connectionKey}', connection_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_connection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_custom_property(catalog_id, namespace_id, custom_property_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_custom_property API.

Gets a specific custom property for the given key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • custom_property_key (String) —

    Unique Custom Property key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a custom property response.

    Allowed values are: key, displayName, description, dataType, namespaceName, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4249

def get_custom_property(catalog_id, namespace_id, custom_property_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling get_custom_property." if namespace_id.nil?
  raise "Missing the required parameter 'custom_property_key' when calling get_custom_property." if custom_property_key.nil?


  fields_allowable_values = %w[key displayName description dataType namespaceName lifecycleState timeCreated timeUpdated createdById updatedById properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataType, namespaceName, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)
  raise "Parameter value for 'custom_property_key' must not be blank" if OCI::Internal::Util.blank_string?(custom_property_key)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s).sub('{customPropertyKey}', custom_property_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_custom_property') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CustomProperty'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_asset(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_asset API.

Gets a specific data asset for the given key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a data asset response.

    Allowed values are: key, displayName, description, catalogId, externalKey, typeKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4322

def get_data_asset(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_data_asset." if data_asset_key.nil?


  fields_allowable_values = %w[key displayName description catalogId externalKey typeKey lifecycleState timeCreated timeUpdated createdById updatedById uri properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, externalKey, typeKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_data_asset') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_asset_tag API.

Gets a specific data asset tag by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a data asset tag response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, dataAssetKey

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4394

def get_data_asset_tag(catalog_id, data_asset_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_data_asset_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_data_asset_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_data_asset_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'tag_key' when calling get_data_asset_tag." if tag_key.nil?


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated createdById uri dataAssetKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, dataAssetKey.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_data_asset_tag') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAssetTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_entity(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_entity API.

Gets a specific data entity by key for a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_include_object_relationships (BOOLEAN) —

    Indicates whether the list of objects and their relationships to this object will be provided in the response. (default to false)

  • :fields (Array<String>) —

    Specifies the fields to return in an entity response.

    Allowed values are: key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4469

def get_entity(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_entity.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_entity." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_entity." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling get_entity." if entity_key.nil?


  fields_allowable_values = %w[key displayName description dataAssetKey timeCreated timeUpdated createdById updatedById lifecycleState externalKey timeExternal timeStatusUpdated isLogical isPartition folderKey folderName typeKey path harvestStatus lastJobKey uri properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isIncludeObjectRelationships] = opts[:is_include_object_relationships] if !opts[:is_include_object_relationships].nil?
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_entity') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Entity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_entity_tag API.

Gets a specific entity tag by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in an entity tag response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, entityKey

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4545

def get_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_entity_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_entity_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_entity_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling get_entity_tag." if entity_key.nil?
  raise "Missing the required parameter 'tag_key' when calling get_entity_tag." if tag_key.nil?


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated createdById uri entityKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, entityKey.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_entity_tag') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_folder(catalog_id, data_asset_key, folder_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_folder API.

Gets a specific data asset folder by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_include_object_relationships (BOOLEAN) —

    Indicates whether the list of objects and their relationships to this object will be provided in the response. (default to false)

  • :fields (Array<String>) —

    Specifies the fields to return in a folder response.

    Allowed values are: key, displayName, description, parentFolderKey, path, dataAssetKey, properties, externalKey, timeCreated, timeUpdated, createdById, updatedById, timeExternal, lifecycleState, harvestStatus, lastJobKey, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4622

def get_folder(catalog_id, data_asset_key, folder_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_folder.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_folder." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_folder." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling get_folder." if folder_key.nil?


  fields_allowable_values = %w[key displayName description parentFolderKey path dataAssetKey properties externalKey timeCreated timeUpdated createdById updatedById timeExternal lifecycleState harvestStatus lastJobKey uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, parentFolderKey, path, dataAssetKey, properties, externalKey, timeCreated, timeUpdated, createdById, updatedById, timeExternal, lifecycleState, harvestStatus, lastJobKey, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isIncludeObjectRelationships] = opts[:is_include_object_relationships] if !opts[:is_include_object_relationships].nil?
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_folder') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Folder'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_folder_tag API.

Gets a specific folder tag by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • tag_key (String) —

    Unique tag key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a folder tag response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, folderKey

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4698

def get_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_folder_tag.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_folder_tag." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling get_folder_tag." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling get_folder_tag." if folder_key.nil?
  raise "Missing the required parameter 'tag_key' when calling get_folder_tag." if tag_key.nil?


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated createdById uri folderKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, createdById, uri, folderKey.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)
  raise "Parameter value for 'tag_key' must not be blank" if OCI::Internal::Util.blank_string?(tag_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags/{tagKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s).sub('{tagKey}', tag_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_folder_tag') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::FolderTag'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_glossary(catalog_id, glossary_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_glossary API.

Gets a specific glossary by key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a glossary response.

    Allowed values are: key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4773

def get_glossary(catalog_id, glossary_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling get_glossary." if glossary_key.nil?


  fields_allowable_values = %w[key displayName description catalogId lifecycleState timeCreated timeUpdated createdById updatedById owner workflowStatus uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_glossary') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Glossary'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job(catalog_id, job_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job API.

Gets a specific job by key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a job response.

    Allowed values are: key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, jobType, scheduleCronExpression, timeScheduleBegin, timeScheduleEnd, scheduleType, connectionKey, jobDefinitionKey, internalVersion, executionCount, timeOfLatestExecution, executions, createdById, updatedById, uri, jobDefinitionName, errorCode, errorMessage

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Job



4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4844

def get_job(catalog_id, job_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_job.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_job." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling get_job." if job_key.nil?


  fields_allowable_values = %w[key displayName description catalogId lifecycleState timeCreated timeUpdated jobType scheduleCronExpression timeScheduleBegin timeScheduleEnd scheduleType connectionKey jobDefinitionKey internalVersion executionCount timeOfLatestExecution executions createdById updatedById uri jobDefinitionName errorCode errorMessage]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, lifecycleState, timeCreated, timeUpdated, jobType, scheduleCronExpression, timeScheduleBegin, timeScheduleEnd, scheduleType, connectionKey, jobDefinitionKey, internalVersion, executionCount, timeOfLatestExecution, executions, createdById, updatedById, uri, jobDefinitionName, errorCode, errorMessage.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_job') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_definition(catalog_id, job_definition_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_definition API.

Gets a specific job definition by key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_definition_key (String) —

    Unique job definition key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a job definition response.

    Allowed values are: key, displayName, description, catalogId, jobType, isIncremental, dataAssetKey, connectionKey, internalVersion, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, isSampleDataExtracted, sampleDataSizeInMBs, timeLatestExecutionStarted, timeLatestExecutionEnded, jobExecutionState, scheduleType, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4915

def get_job_definition(catalog_id, job_definition_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_job_definition.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_job_definition." if catalog_id.nil?
  raise "Missing the required parameter 'job_definition_key' when calling get_job_definition." if job_definition_key.nil?


  fields_allowable_values = %w[key displayName description catalogId jobType isIncremental dataAssetKey connectionKey internalVersion lifecycleState timeCreated timeUpdated createdById updatedById uri isSampleDataExtracted sampleDataSizeInMBs timeLatestExecutionStarted timeLatestExecutionEnded jobExecutionState scheduleType properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, jobType, isIncremental, dataAssetKey, connectionKey, internalVersion, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, uri, isSampleDataExtracted, sampleDataSizeInMBs, timeLatestExecutionStarted, timeLatestExecutionEnded, jobExecutionState, scheduleType, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_definition_key' must not be blank" if OCI::Internal::Util.blank_string?(job_definition_key)

  path = '/catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobDefinitionKey}', job_definition_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_job_definition') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_execution(catalog_id, job_key, job_execution_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_execution API.

Gets a specific job execution by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • job_execution_key (String) —

    The key of the job execution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a job execution response.

    Allowed values are: key, jobKey, jobType, subType, parentKey, scheduleInstanceKey, lifecycleState, timeCreated, timeStarted, timeEnded, errorCode, errorMessage, processKey, externalUrl, eventKey, dataEntityKey, createdById, updatedById, properties, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 4987

def get_job_execution(catalog_id, job_key, job_execution_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_job_execution.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_job_execution." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling get_job_execution." if job_key.nil?
  raise "Missing the required parameter 'job_execution_key' when calling get_job_execution." if job_execution_key.nil?


  fields_allowable_values = %w[key jobKey jobType subType parentKey scheduleInstanceKey lifecycleState timeCreated timeStarted timeEnded errorCode errorMessage processKey externalUrl eventKey dataEntityKey createdById updatedById properties uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, jobKey, jobType, subType, parentKey, scheduleInstanceKey, lifecycleState, timeCreated, timeStarted, timeEnded, errorCode, errorMessage, processKey, externalUrl, eventKey, dataEntityKey, createdById, updatedById, properties, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)
  raise "Parameter value for 'job_execution_key' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s).sub('{jobExecutionKey}', job_execution_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_job_execution') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobExecution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_log(catalog_id, job_key, job_execution_key, job_log_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_log API.

Gets a specific job log by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • job_execution_key (String) —

    The key of the job execution.

  • job_log_key (String) —

    Unique job log key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a job log response.

    Allowed values are: key, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, severity, logMessage, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5062

def get_job_log(catalog_id, job_key, job_execution_key, job_log_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_job_log.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_job_log." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling get_job_log." if job_key.nil?
  raise "Missing the required parameter 'job_execution_key' when calling get_job_log." if job_execution_key.nil?
  raise "Missing the required parameter 'job_log_key' when calling get_job_log." if job_log_key.nil?


  fields_allowable_values = %w[key jobExecutionKey createdById updatedById timeUpdated timeCreated severity logMessage uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, severity, logMessage, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)
  raise "Parameter value for 'job_execution_key' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_key)
  raise "Parameter value for 'job_log_key' must not be blank" if OCI::Internal::Util.blank_string?(job_log_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs/{jobLogKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s).sub('{jobExecutionKey}', job_execution_key.to_s).sub('{jobLogKey}', job_log_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_job_log') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobLog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_metrics(catalog_id, job_key, job_execution_key, job_metrics_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_job_metrics API.

Gets a specific job metric by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • job_execution_key (String) —

    The key of the job execution.

  • job_metrics_key (String) —

    Unique job metrics key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a job metric response.

    Allowed values are: key, description, displayName, timeInserted, category, subCategory, unit, value, batchKey, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5139

def get_job_metrics(catalog_id, job_key, job_execution_key, job_metrics_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_job_metrics.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_job_metrics." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling get_job_metrics." if job_key.nil?
  raise "Missing the required parameter 'job_execution_key' when calling get_job_metrics." if job_execution_key.nil?
  raise "Missing the required parameter 'job_metrics_key' when calling get_job_metrics." if job_metrics_key.nil?


  fields_allowable_values = %w[key description displayName timeInserted category subCategory unit value batchKey jobExecutionKey createdById updatedById timeUpdated timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, description, displayName, timeInserted, category, subCategory, unit, value, batchKey, jobExecutionKey, createdById, updatedById, timeUpdated, timeCreated, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)
  raise "Parameter value for 'job_execution_key' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_key)
  raise "Parameter value for 'job_metrics_key' must not be blank" if OCI::Internal::Util.blank_string?(job_metrics_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics/{jobMetricsKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s).sub('{jobExecutionKey}', job_execution_key.to_s).sub('{jobMetricsKey}', job_metrics_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_job_metrics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobMetric'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_metastore(metastore_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_metastore API.

Gets a metastore by identifier.

Parameters:

  • metastore_id (String) —

    The metastore's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5210

def get_metastore(metastore_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_metastore.' if logger

  raise "Missing the required parameter 'metastore_id' when calling get_metastore." if metastore_id.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_metastore') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Metastore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_namespace(catalog_id, namespace_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_namespace API.

Gets a specific namespace for the given key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a namespace response.

    Allowed values are: key, displayName, description, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5268

def get_namespace(catalog_id, namespace_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_namespace.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_namespace." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling get_namespace." if namespace_id.nil?


  fields_allowable_values = %w[key displayName description lifecycleState timeCreated timeUpdated createdById updatedById properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_namespace') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Namespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pattern(catalog_id, pattern_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_pattern API.

Gets a specific pattern for the given key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • pattern_key (String) —

    Unique pattern key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a pattern response.

    Allowed values are: key, displayName, description, catalogId, expression, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5339

def get_pattern(catalog_id, pattern_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_pattern.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_pattern." if catalog_id.nil?
  raise "Missing the required parameter 'pattern_key' when calling get_pattern." if pattern_key.nil?


  fields_allowable_values = %w[key displayName description catalogId expression lifecycleState timeCreated timeUpdated createdById updatedById properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, expression, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, properties.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)

  path = '/catalogs/{catalogId}/patterns/{patternKey}'.sub('{catalogId}', catalog_id.to_s).sub('{patternKey}', pattern_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_pattern') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Pattern'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_term(catalog_id, glossary_key, term_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_term API.

Gets a specific glossary term by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a term response.

    Allowed values are: key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri, relatedTerms, associatedObjectCount, associatedObjects

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5411

def get_term(catalog_id, glossary_key, term_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_term.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_term." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling get_term." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling get_term." if term_key.nil?


  fields_allowable_values = %w[key displayName description glossaryKey parentTermKey isAllowedToHaveChildTerms path lifecycleState timeCreated timeUpdated createdById updatedById owner workflowStatus uri relatedTerms associatedObjectCount associatedObjects]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, owner, workflowStatus, uri, relatedTerms, associatedObjectCount, associatedObjects.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_term') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Term'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_term_relationship API.

Gets a specific glossary term relationship by key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • term_relationship_key (String) —

    Unique glossary term relationship key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a term relationship response.

    Allowed values are: key, displayName, description, relatedTermKey, relatedTermDisplayName, parentTermKey, parentTermDisplayName, lifecycleState, timeCreated, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5486

def get_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_term_relationship.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_term_relationship." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling get_term_relationship." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling get_term_relationship." if term_key.nil?
  raise "Missing the required parameter 'term_relationship_key' when calling get_term_relationship." if term_relationship_key.nil?


  fields_allowable_values = %w[key displayName description relatedTermKey relatedTermDisplayName parentTermKey parentTermDisplayName lifecycleState timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, relatedTermKey, relatedTermDisplayName, parentTermKey, parentTermDisplayName, lifecycleState, timeCreated, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)
  raise "Parameter value for 'term_relationship_key' must not be blank" if OCI::Internal::Util.blank_string?(term_relationship_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s).sub('{termRelationshipKey}', term_relationship_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_term_relationship') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_type(catalog_id, type_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_type API.

Gets a specific type by key within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • type_key (String) —

    Unique type key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in a type response.

    Allowed values are: key, description, name, catalogId, properties, isInternal, isTag, isApproved, typeCategory, externalTypeName, lifecycleState, uri

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5561

def get_type(catalog_id, type_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_type.' if logger

  raise "Missing the required parameter 'catalog_id' when calling get_type." if catalog_id.nil?
  raise "Missing the required parameter 'type_key' when calling get_type." if type_key.nil?


  fields_allowable_values = %w[key description name catalogId properties isInternal isTag isApproved typeCategory externalTypeName lifecycleState uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, description, name, catalogId, properties, isInternal, isTag, isApproved, typeCategory, externalTypeName, lifecycleState, uri.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'type_key' must not be blank" if OCI::Internal::Util.blank_string?(type_key)

  path = '/catalogs/{catalogId}/types/{typeKey}'.sub('{catalogId}', catalog_id.to_s).sub('{typeKey}', type_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_type') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Type'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Gets the status of the work request with the given OCID.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5628

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#get_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_connection(catalog_id, data_asset_key, import_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use import_connection API.

Import new connection for this data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • import_connection_details (OCI::DataCatalog::Models::ImportConnectionDetails) —

    The information used to create the connections through import.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5696

def import_connection(catalog_id, data_asset_key, import_connection_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#import_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling import_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling import_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'import_connection_details' when calling import_connection." if import_connection_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importConnection'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#import_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_data_asset(catalog_id, data_asset_key, import_data_asset_details, import_type, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use import_data_asset API.

Import technical objects to a Data Asset

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • import_data_asset_details (OCI::DataCatalog::Models::ImportDataAssetDetails) —

    The file contents to be imported.

  • import_type (Array<String>) —

    Type of import. Allowed values are: CUSTOM_PROPERTY_VALUES, ALL

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_missing_value_ignored (BOOLEAN) —

    Specify whether to ignore the missing values in the import file. (default to true)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5767

def import_data_asset(catalog_id, data_asset_key, import_data_asset_details, import_type, opts = {})
  logger.debug 'Calling operation DataCatalogClient#import_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling import_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling import_data_asset." if data_asset_key.nil?
  raise "Missing the required parameter 'import_data_asset_details' when calling import_data_asset." if import_data_asset_details.nil?
  raise "Missing the required parameter 'import_type' when calling import_data_asset." if import_type.nil?

  import_type_allowable_values = %w[CUSTOM_PROPERTY_VALUES ALL]
  import_type.each do |val_to_check|
    unless import_type_allowable_values.include?(val_to_check)
      raise "Invalid value for 'import_type', must be one of CUSTOM_PROPERTY_VALUES, ALL."
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/import'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:importType] = OCI::ApiClient.build_collection_params(import_type, :multi)
  query_params[:isMissingValueIgnored] = opts[:is_missing_value_ignored] if !opts[:is_missing_value_ignored].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_data_asset_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#import_data_asset') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ImportDataAssetJobResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_glossary(catalog_id, glossary_key, import_glossary_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use import_glossary API.

Import the glossary and the terms from csv or json files and return the imported glossary resource.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • import_glossary_details (OCI::DataCatalog::Models::ImportGlossaryDetails) —

    The file contents to import the glossary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :is_relationship_imported (BOOLEAN) —

    Specify if the relationship metadata is imported for the glossary. (default to false)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5845

def import_glossary(catalog_id, glossary_key, import_glossary_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#import_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling import_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling import_glossary." if glossary_key.nil?
  raise "Missing the required parameter 'import_glossary_details' when calling import_glossary." if import_glossary_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/actions/import'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isRelationshipImported] = opts[:is_relationship_imported] if !opts[:is_relationship_imported].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_glossary_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#import_glossary') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_lineage(catalog_id, data_asset_key, import_lineage_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use import_lineage API.

Imports lineage metadata. Returns details about the job that performs the import.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • import_lineage_details (OCI::DataCatalog::Models::ImportLineageDetails) —

    Details needed by the lineage import request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5912

def import_lineage(catalog_id, data_asset_key, import_lineage_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#import_lineage.' if logger

  raise "Missing the required parameter 'catalog_id' when calling import_lineage." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling import_lineage." if data_asset_key.nil?
  raise "Missing the required parameter 'import_lineage_details' when calling import_lineage." if import_lineage_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importLineage'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_lineage_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#import_lineage') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ImportLineageJobResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_aggregated_physical_entities(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_aggregated_physical_entities API.

List the physical entities aggregated by this logical entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    Specifies the fields to return in an entity response.

    Allowed values are: key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :is_include_properties (BOOLEAN) —

    Indicates whether the properties map will be provided in the response. (default to false)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 5988

def list_aggregated_physical_entities(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_aggregated_physical_entities.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_aggregated_physical_entities." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_aggregated_physical_entities." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling list_aggregated_physical_entities." if entity_key.nil?


  fields_allowable_values = %w[key displayName description dataAssetKey timeCreated timeUpdated createdById updatedById lifecycleState externalKey timeExternal timeStatusUpdated isLogical isPartition folderKey folderName typeKey path harvestStatus lastJobKey uri properties]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataAssetKey, timeCreated, timeUpdated, createdById, updatedById, lifecycleState, externalKey, timeExternal, timeStatusUpdated, isLogical, isPartition, folderKey, folderName, typeKey, path, harvestStatus, lastJobKey, uri, properties.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/listAggregatedPhysicalEntities'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:isIncludeProperties] = opts[:is_include_properties] if !opts[:is_include_properties].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_aggregated_physical_entities') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_attribute_tags(catalog_id, data_asset_key, entity_key, attribute_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_attribute_tags API.

Returns a list of all tags for an entity attribute.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :term_key (String) —

    Unique key of the related term.

  • :term_path (String) —

    Path of the related term.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in an entity attribute tag summary response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, attributeKey

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6090

def list_attribute_tags(catalog_id, data_asset_key, entity_key, attribute_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_attribute_tags.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_attribute_tags." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_attribute_tags." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling list_attribute_tags." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling list_attribute_tags." if attribute_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated uri glossaryKey attributeKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, attributeKey.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:termKey] = opts[:term_key] if opts[:term_key]
  query_params[:termPath] = opts[:term_path] if opts[:term_path]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_attribute_tags') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AttributeTagCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_attributes(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_attributes API.

Returns a list of all attributes of an data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :business_name (String) —

    A filter to return only resources that match the entire business name given. The match is not case sensitive.

  • :display_or_business_name_contains (String) —

    A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :time_external (DateTime) —

    Last modified timestamp of this object in the external system.

  • :external_type_name (String) —

    Data type as defined in an external system.

  • :is_incremental_data (BOOLEAN) —

    Identifies whether this attribute can be used as a watermark to extract incremental data.

  • :is_nullable (BOOLEAN) —

    Identifies whether this attribute can be assigned null value.

  • :length (Integer) —

    Max allowed length of the attribute value.

  • :position (Integer) —

    Position of the attribute in the record definition.

  • :precision (Integer) —

    Precision of the attribute value usually applies to float data type.

  • :scale (Integer) —

    Scale of the attribute value usually applies to float data type.

  • :fields (Array<String>) —

    Specifies the fields to return in an entity attribute summary response.

    Allowed values are: key, displayName, description, entityKey, lifecycleState, timeCreated, externalDataType, externalKey, length, precision, scale, isNullable, uri, path, minCollectionCount, maxCollectionCount, datatypeEntityKey, externalDatatypeEntityKey, parentAttributeKey, externalParentAttributeKey, position, typeKey

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default.

    Allowed values are: TIMECREATED, DISPLAYNAME, POSITION, DISPLAYORBUSINESSNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6220

def list_attributes(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_attributes.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_attributes." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_attributes." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling list_attributes." if entity_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description entityKey lifecycleState timeCreated externalDataType externalKey length precision scale isNullable uri path minCollectionCount maxCollectionCount datatypeEntityKey externalDatatypeEntityKey parentAttributeKey externalParentAttributeKey position typeKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, entityKey, lifecycleState, timeCreated, externalDataType, externalKey, length, precision, scale, isNullable, uri, path, minCollectionCount, maxCollectionCount, datatypeEntityKey, externalDatatypeEntityKey, parentAttributeKey, externalParentAttributeKey, position, typeKey.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME POSITION DISPLAYORBUSINESSNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, POSITION, DISPLAYORBUSINESSNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:businessName] = opts[:business_name] if opts[:business_name]
  query_params[:displayOrBusinessNameContains] = opts[:display_or_business_name_contains] if opts[:display_or_business_name_contains]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:timeExternal] = opts[:time_external] if opts[:time_external]
  query_params[:externalTypeName] = opts[:external_type_name] if opts[:external_type_name]
  query_params[:isIncrementalData] = opts[:is_incremental_data] if !opts[:is_incremental_data].nil?
  query_params[:isNullable] = opts[:is_nullable] if !opts[:is_nullable].nil?
  query_params[:length] = opts[:length] if opts[:length]
  query_params[:position] = opts[:position] if opts[:position]
  query_params[:precision] = opts[:precision] if opts[:precision]
  query_params[:scale] = opts[:scale] if opts[:scale]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_attributes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::AttributeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_catalog_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_catalog_private_endpoints API.

Returns a list of all the catalog private endpoints in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment where you want to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6333

def list_catalog_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_catalog_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_catalog_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/catalogPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_catalog_private_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::CatalogPrivateEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_catalogs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_catalogs API.

Returns a list of all the data catalogs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment where you want to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6415

def list_catalogs(compartment_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_catalogs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_catalogs." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/catalogs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_catalogs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::CatalogSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_connections(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_connections API.

Returns a list of all Connections for a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :time_status_updated (DateTime) —

    Time that the resource's status was last updated. An RFC3339 formatted datetime string.

  • :is_default (BOOLEAN) —

    Indicates whether this connection is the default connection.

  • :fields (Array<String>) —

    Specifies the fields to return in a connection summary response.

    Allowed values are: key, displayName, description, dataAssetKey, typeKey, timeCreated, externalKey, lifecycleState, isDefault, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6511

def list_connections(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_connections.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_connections." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_connections." if data_asset_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description dataAssetKey typeKey timeCreated externalKey lifecycleState isDefault uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataAssetKey, typeKey, timeCreated, externalKey, lifecycleState, isDefault, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:timeStatusUpdated] = opts[:time_status_updated] if opts[:time_status_updated]
  query_params[:isDefault] = opts[:is_default] if !opts[:is_default].nil?
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_connections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ConnectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_custom_properties(catalog_id, namespace_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_custom_properties API.

Returns a list of custom properties within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :data_types (Array<String>) —

    Return the custom properties which has specified data types

    Allowed values are: TEXT, RICH_TEXT, BOOLEAN, NUMBER, DATE

  • :type_name (Array<String>) —

    A filter to return only resources that match the entire type name given. The match is not case sensitive Allowed values are: DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN, ORACLE_ANALYTICS_LOGICAL_COLUMN, ORACLE_ANALYTICS_PHYSICAL_COLUMN, ORACLE_ANALYTICS_ANALYSIS_COLUMN, ORACLE_ANALYTICS_SERVER, ORACLE_ANALYTICS_CLOUD, ORACLE_ANALYTICS_SUBJECT_AREA, ORACLE_ANALYTICS_DASHBOARD, ORACLE_ANALYTICS_BUSINESS_MODEL, ORACLE_ANALYTICS_PHYSICAL_DATABASE, ORACLE_ANALYTICS_PHYSICAL_SCHEMA, ORACLE_ANALYTICS_PRESENTATION_TABLE, ORACLE_ANALYTICS_LOGICAL_TABLE, ORACLE_ANALYTICS_PHYSICAL_TABLE, ORACLE_ANALYTICS_ANALYSIS, DATABASE_SCHEMA, TOPIC, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET, MESSAGE, UNRECOGNIZED_FILE

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a custom property summary response.

    Allowed values are: key, displayName, description, dataType, namespaceName, lifecycleState, timeCreated

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending

    Allowed values are: DISPLAYNAME, USAGECOUNT

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6630

def list_custom_properties(catalog_id, namespace_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_custom_properties.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_custom_properties." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling list_custom_properties." if namespace_id.nil?


  data_types_allowable_values = %w[TEXT RICH_TEXT BOOLEAN NUMBER DATE]
  if opts[:data_types] && !opts[:data_types].empty?
    opts[:data_types].each do |val_to_check|
      unless data_types_allowable_values.include?(val_to_check)
        raise 'Invalid value for "data_types", must be one of TEXT, RICH_TEXT, BOOLEAN, NUMBER, DATE.'
      end
    end
  end


  type_name_allowable_values = %w[DATA_ASSET AUTONOMOUS_DATA_WAREHOUSE HIVE KAFKA MYSQL ORACLE_OBJECT_STORAGE AUTONOMOUS_TRANSACTION_PROCESSING ORACLE POSTGRESQL MICROSOFT_AZURE_SQL_DATABASE MICROSOFT_SQL_SERVER IBM_DB2 DATA_ENTITY LOGICAL_ENTITY TABLE VIEW ATTRIBUTE FOLDER ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN ORACLE_ANALYTICS_LOGICAL_COLUMN ORACLE_ANALYTICS_PHYSICAL_COLUMN ORACLE_ANALYTICS_ANALYSIS_COLUMN ORACLE_ANALYTICS_SERVER ORACLE_ANALYTICS_CLOUD ORACLE_ANALYTICS_SUBJECT_AREA ORACLE_ANALYTICS_DASHBOARD ORACLE_ANALYTICS_BUSINESS_MODEL ORACLE_ANALYTICS_PHYSICAL_DATABASE ORACLE_ANALYTICS_PHYSICAL_SCHEMA ORACLE_ANALYTICS_PRESENTATION_TABLE ORACLE_ANALYTICS_LOGICAL_TABLE ORACLE_ANALYTICS_PHYSICAL_TABLE ORACLE_ANALYTICS_ANALYSIS DATABASE_SCHEMA TOPIC CONNECTION GLOSSARY TERM CATEGORY FILE BUCKET MESSAGE UNRECOGNIZED_FILE]
  if opts[:type_name] && !opts[:type_name].empty?
    opts[:type_name].each do |val_to_check|
      unless type_name_allowable_values.include?(val_to_check)
        raise 'Invalid value for "type_name", must be one of DATA_ASSET, AUTONOMOUS_DATA_WAREHOUSE, HIVE, KAFKA, MYSQL, ORACLE_OBJECT_STORAGE, AUTONOMOUS_TRANSACTION_PROCESSING, ORACLE, POSTGRESQL, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, IBM_DB2, DATA_ENTITY, LOGICAL_ENTITY, TABLE, VIEW, ATTRIBUTE, FOLDER, ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN, ORACLE_ANALYTICS_LOGICAL_COLUMN, ORACLE_ANALYTICS_PHYSICAL_COLUMN, ORACLE_ANALYTICS_ANALYSIS_COLUMN, ORACLE_ANALYTICS_SERVER, ORACLE_ANALYTICS_CLOUD, ORACLE_ANALYTICS_SUBJECT_AREA, ORACLE_ANALYTICS_DASHBOARD, ORACLE_ANALYTICS_BUSINESS_MODEL, ORACLE_ANALYTICS_PHYSICAL_DATABASE, ORACLE_ANALYTICS_PHYSICAL_SCHEMA, ORACLE_ANALYTICS_PRESENTATION_TABLE, ORACLE_ANALYTICS_LOGICAL_TABLE, ORACLE_ANALYTICS_PHYSICAL_TABLE, ORACLE_ANALYTICS_ANALYSIS, DATABASE_SCHEMA, TOPIC, CONNECTION, GLOSSARY, TERM, CATEGORY, FILE, BUCKET, MESSAGE, UNRECOGNIZED_FILE.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description dataType namespaceName lifecycleState timeCreated]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataType, namespaceName, lifecycleState, timeCreated.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[DISPLAYNAME USAGECOUNT].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, USAGECOUNT.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}/customProperties'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:dataTypes] = OCI::ApiClient.build_collection_params(opts[:data_types], :multi) if opts[:data_types] && !opts[:data_types].empty?
  query_params[:typeName] = OCI::ApiClient.build_collection_params(opts[:type_name], :multi) if opts[:type_name] && !opts[:type_name].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_custom_properties') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CustomPropertyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_asset_tags(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_asset_tags API.

Returns a list of all tags for a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :term_key (String) —

    Unique key of the related term.

  • :term_path (String) —

    Path of the related term.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a data asset tag summary response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, dataAssetKey

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6759

def list_data_asset_tags(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_data_asset_tags.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_data_asset_tags." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_data_asset_tags." if data_asset_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated uri glossaryKey dataAssetKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, dataAssetKey.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:termKey] = opts[:term_key] if opts[:term_key]
  query_params[:termPath] = opts[:term_path] if opts[:term_path]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_data_asset_tags') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAssetTagCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_assets(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_assets API.

Returns a list of data assets within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :type_key (String) —

    The key of the object type.

  • :fields (Array<String>) —

    Specifies the fields to return in a data asset summary response.

    Allowed values are: key, displayName, description, catalogId, externalKey, typeKey, lifecycleState, timeCreated, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6870

def list_data_assets(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_data_assets.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_data_assets." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description catalogId externalKey typeKey lifecycleState timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, externalKey, typeKey, lifecycleState, timeCreated, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/dataAssets'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:typeKey] = opts[:type_key] if opts[:type_key]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_data_assets') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAssetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_derived_logical_entities(catalog_id, pattern_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_derived_logical_entities API.

List logical entities derived from this pattern.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • pattern_key (String) —

    Unique pattern key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 6984

def list_derived_logical_entities(catalog_id, pattern_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_derived_logical_entities.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_derived_logical_entities." if catalog_id.nil?
  raise "Missing the required parameter 'pattern_key' when calling list_derived_logical_entities." if pattern_key.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)

  path = '/catalogs/{catalogId}/patterns/{patternKey}/actions/listDerivedLogicalEntities'.sub('{catalogId}', catalog_id.to_s).sub('{patternKey}', pattern_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_derived_logical_entities') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_entities(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_entities API.

Returns a list of all entities of a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :business_name (String) —

    A filter to return only resources that match the entire business name given. The match is not case sensitive.

  • :display_or_business_name_contains (String) —

    A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :type_key (String) —

    The key of the object type.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :pattern_key (String) —

    Unique pattern key.

  • :time_external (DateTime) —

    Last modified timestamp of this object in the external system.

  • :time_status_updated (DateTime) —

    Time that the resource's status was last updated. An RFC3339 formatted datetime string.

  • :is_logical (BOOLEAN) —

    Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

  • :is_partition (BOOLEAN) —

    Identifies if an object is a sub object (partition) of a physical or materialized parent object.

  • :folder_key (String) —

    Key of the associated folder.

  • :path (String) —

    Full path of the resource for resources that support paths.

  • :harvest_status (String) —

    Harvest status of the harvestable resource as updated by the harvest process.

  • :last_job_key (String) —

    Key of the last harvest process to update this resource.

  • :fields (Array<String>) —

    Specifies the fields to return in an entity summary response.

    Allowed values are: key, displayName, description, dataAssetKey, timeCreated, timeUpdated, updatedById, lifecycleState, folderKey, folderName, externalKey, path, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.

    Allowed values are: TIMECREATED, DISPLAYNAME, DISPLAYORBUSINESSNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_process (BOOLEAN) —

    A filter to return only process entities.

Returns:



7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7096

def list_entities(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_entities.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_entities." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_entities." if data_asset_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:harvest_status] && !OCI::DataCatalog::Models::HARVEST_STATUS_ENUM.include?(opts[:harvest_status])
    raise 'Invalid value for "harvest_status", must be one of the values in OCI::DataCatalog::Models::HARVEST_STATUS_ENUM.'
  end


  fields_allowable_values = %w[key displayName description dataAssetKey timeCreated timeUpdated updatedById lifecycleState folderKey folderName externalKey path uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, dataAssetKey, timeCreated, timeUpdated, updatedById, lifecycleState, folderKey, folderName, externalKey, path, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME DISPLAYORBUSINESSNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, DISPLAYORBUSINESSNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:businessName] = opts[:business_name] if opts[:business_name]
  query_params[:displayOrBusinessNameContains] = opts[:display_or_business_name_contains] if opts[:display_or_business_name_contains]
  query_params[:typeKey] = opts[:type_key] if opts[:type_key]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:patternKey] = opts[:pattern_key] if opts[:pattern_key]
  query_params[:timeExternal] = opts[:time_external] if opts[:time_external]
  query_params[:timeStatusUpdated] = opts[:time_status_updated] if opts[:time_status_updated]
  query_params[:isLogical] = opts[:is_logical] if !opts[:is_logical].nil?
  query_params[:isPartition] = opts[:is_partition] if !opts[:is_partition].nil?
  query_params[:folderKey] = opts[:folder_key] if opts[:folder_key]
  query_params[:path] = opts[:path] if opts[:path]
  query_params[:harvestStatus] = opts[:harvest_status] if opts[:harvest_status]
  query_params[:lastJobKey] = opts[:last_job_key] if opts[:last_job_key]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:isProcess] = opts[:is_process] if !opts[:is_process].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_entities') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_entity_tags(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_entity_tags API.

Returns a list of all tags for a data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :term_key (String) —

    Unique key of the related term.

  • :term_path (String) —

    Path of the related term.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in an entity tag summary response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, entityKey

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7222

def list_entity_tags(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_entity_tags.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_entity_tags." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_entity_tags." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling list_entity_tags." if entity_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated uri glossaryKey entityKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, entityKey.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:termKey] = opts[:term_key] if opts[:term_key]
  query_params[:termPath] = opts[:term_path] if opts[:term_path]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_entity_tags') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::EntityTagCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_folder_tags(catalog_id, data_asset_key, folder_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_folder_tags API.

Returns a list of all tags for a folder.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :term_key (String) —

    Unique key of the related term.

  • :term_path (String) —

    Path of the related term.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a folder tag summary response.

    Allowed values are: key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, folderKey

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7331

def list_folder_tags(catalog_id, data_asset_key, folder_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_folder_tags.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_folder_tags." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_folder_tags." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling list_folder_tags." if folder_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key name termKey termPath termDescription lifecycleState timeCreated uri glossaryKey folderKey]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, name, termKey, termPath, termDescription, lifecycleState, timeCreated, uri, glossaryKey, folderKey.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:termKey] = opts[:term_key] if opts[:term_key]
  query_params[:termPath] = opts[:term_path] if opts[:term_path]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_folder_tags') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::FolderTagCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_folders(catalog_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_folders API.

Returns a list of all folders.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :business_name (String) —

    A filter to return only resources that match the entire business name given. The match is not case sensitive.

  • :display_or_business_name_contains (String) —

    A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :parent_folder_key (String) —

    Unique folder key.

  • :path (String) —

    Full path of the resource for resources that support paths.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :harvest_status (String) —

    Harvest status of the harvestable resource as updated by the harvest process.

  • :last_job_key (String) —

    Key of the last harvest process to update this resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a folder summary response.

    Allowed values are: key, displayName, description, parentFolderKey, path, dataAssetKey, externalKey, timeExternal, timeCreated, lifecycleState, uri

  • :type_key (String) —

    The key of the object type.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.

    Allowed values are: TIMECREATED, DISPLAYNAME, DISPLAYORBUSINESSNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7455

def list_folders(catalog_id, data_asset_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_folders.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_folders." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_folders." if data_asset_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:harvest_status] && !OCI::DataCatalog::Models::HARVEST_STATUS_ENUM.include?(opts[:harvest_status])
    raise 'Invalid value for "harvest_status", must be one of the values in OCI::DataCatalog::Models::HARVEST_STATUS_ENUM.'
  end


  fields_allowable_values = %w[key displayName description parentFolderKey path dataAssetKey externalKey timeExternal timeCreated lifecycleState uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, parentFolderKey, path, dataAssetKey, externalKey, timeExternal, timeCreated, lifecycleState, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME DISPLAYORBUSINESSNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, DISPLAYORBUSINESSNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:businessName] = opts[:business_name] if opts[:business_name]
  query_params[:displayOrBusinessNameContains] = opts[:display_or_business_name_contains] if opts[:display_or_business_name_contains]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:parentFolderKey] = opts[:parent_folder_key] if opts[:parent_folder_key]
  query_params[:path] = opts[:path] if opts[:path]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:harvestStatus] = opts[:harvest_status] if opts[:harvest_status]
  query_params[:lastJobKey] = opts[:last_job_key] if opts[:last_job_key]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:typeKey] = opts[:type_key] if opts[:type_key]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_folders') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::FolderCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_glossaries(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_glossaries API.

Returns a list of all glossaries within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a glossary summary response.

    Allowed values are: key, displayName, description, catalogId, lifecycleState, timeCreated, uri, workflowStatus

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7577

def list_glossaries(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_glossaries.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_glossaries." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description catalogId lifecycleState timeCreated uri workflowStatus]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, lifecycleState, timeCreated, uri, workflowStatus.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/glossaries'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_glossaries') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::GlossaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_definitions(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_definitions API.

Returns a list of job definitions within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :job_execution_state (String) —

    Job execution state.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :job_type (String) —

    Job type.

  • :is_incremental (BOOLEAN) —

    Whether job definition is an incremental harvest (true) or a full harvest (false).

  • :data_asset_key (String) —

    Unique data asset key.

  • :glossary_key (String) —

    Unique glossary key.

  • :connection_key (String) —

    Unique connection key.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :sample_data_size_in_mbs (String) —

    The sample data size in MB, specified as number of rows, for a metadata harvest.

  • :fields (Array<String>) —

    Specifies the fields to return in a job definition summary response.

    Allowed values are: key, displayName, description, catalogId, jobType, connectionKey, lifecycleState, timeCreated, isSampleDataExtracted, uri, timeLatestExecutionStarted, timeLatestExecutionEnded, jobExecutionState, scheduleType

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME, TIMELATESTEXECUTIONSTARTED

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7692

def list_job_definitions(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_job_definitions.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_job_definitions." if catalog_id.nil?

  if opts[:job_execution_state] && !OCI::DataCatalog::Models::JOB_EXECUTION_STATE_ENUM.include?(opts[:job_execution_state])
    raise 'Invalid value for "job_execution_state", must be one of the values in OCI::DataCatalog::Models::JOB_EXECUTION_STATE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:job_type] && !OCI::DataCatalog::Models::JOB_TYPE_ENUM.include?(opts[:job_type])
    raise 'Invalid value for "job_type", must be one of the values in OCI::DataCatalog::Models::JOB_TYPE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description catalogId jobType connectionKey lifecycleState timeCreated isSampleDataExtracted uri timeLatestExecutionStarted timeLatestExecutionEnded jobExecutionState scheduleType]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, jobType, connectionKey, lifecycleState, timeCreated, isSampleDataExtracted, uri, timeLatestExecutionStarted, timeLatestExecutionEnded, jobExecutionState, scheduleType.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME TIMELATESTEXECUTIONSTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, TIMELATESTEXECUTIONSTARTED.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/jobDefinitions'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:jobExecutionState] = opts[:job_execution_state] if opts[:job_execution_state]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:jobType] = opts[:job_type] if opts[:job_type]
  query_params[:isIncremental] = opts[:is_incremental] if !opts[:is_incremental].nil?
  query_params[:dataAssetKey] = opts[:data_asset_key] if opts[:data_asset_key]
  query_params[:glossaryKey] = opts[:glossary_key] if opts[:glossary_key]
  query_params[:connectionKey] = opts[:connection_key] if opts[:connection_key]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:sampleDataSizeInMBs] = opts[:sample_data_size_in_mbs] if opts[:sample_data_size_in_mbs]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_job_definitions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobDefinitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_executions(catalog_id, job_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_executions API.

Returns a list of job executions for a job.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (String) —

    Job execution lifecycle state.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :job_type (String) —

    Job type.

  • :sub_type (String) —

    Sub-type of this job execution.

  • :parent_key (String) —

    The unique key of the parent execution or null if this job execution has no parent.

  • :time_start (DateTime) —

    Time that the job execution was started or in the case of a future time, the time when the job will start. An RFC3339 formatted datetime string.

  • :time_end (DateTime) —

    Time that the job execution ended or null if the job is still running or hasn't run yet. An RFC3339 formatted datetime string.

  • :error_code (String) —

    Error code returned from the job execution or null if job is still running or didn't return an error.

  • :error_message (String) —

    Error message returned from the job execution or null if job is still running or didn't return an error.

  • :process_key (String) —

    Process identifier related to the job execution.

  • :external_url (String) —

    The a URL of the job for accessing this resource and its status.

  • :event_key (String) —

    Event that triggered the execution of this job or null.

  • :data_entity_key (String) —

    Unique entity key.

  • :fields (Array<String>) —

    Specifies the fields to return in a job execution summary response.

    Allowed values are: key, jobKey, jobType, parentKey, scheduleInstanceKey, lifecycleState, timeCreated, timeStarted, timeEnded, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.

    Allowed values are: TIMECREATED

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7828

def list_job_executions(catalog_id, job_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_job_executions.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_job_executions." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling list_job_executions." if job_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::JOB_EXECUTION_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::JOB_EXECUTION_STATE_ENUM.'
  end

  if opts[:job_type] && !OCI::DataCatalog::Models::JOB_TYPE_ENUM.include?(opts[:job_type])
    raise 'Invalid value for "job_type", must be one of the values in OCI::DataCatalog::Models::JOB_TYPE_ENUM.'
  end


  fields_allowable_values = %w[key jobKey jobType parentKey scheduleInstanceKey lifecycleState timeCreated timeStarted timeEnded uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, jobKey, jobType, parentKey, scheduleInstanceKey, lifecycleState, timeCreated, timeStarted, timeEnded, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:jobType] = opts[:job_type] if opts[:job_type]
  query_params[:subType] = opts[:sub_type] if opts[:sub_type]
  query_params[:parentKey] = opts[:parent_key] if opts[:parent_key]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  query_params[:errorCode] = opts[:error_code] if opts[:error_code]
  query_params[:errorMessage] = opts[:error_message] if opts[:error_message]
  query_params[:processKey] = opts[:process_key] if opts[:process_key]
  query_params[:externalUrl] = opts[:external_url] if opts[:external_url]
  query_params[:eventKey] = opts[:event_key] if opts[:event_key]
  query_params[:dataEntityKey] = opts[:data_entity_key] if opts[:data_entity_key]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_job_executions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobExecutionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_logs(catalog_id, job_key, job_execution_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_logs API.

Returns a list of job logs.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • job_execution_key (String) —

    The key of the job execution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :severity (String) —

    Severity level for this Log.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a job log summary response.

    Allowed values are: key, jobExecutionKey, severity, timeCreated, logMessage, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 7949

def list_job_logs(catalog_id, job_key, job_execution_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_job_logs.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_job_logs." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling list_job_logs." if job_key.nil?
  raise "Missing the required parameter 'job_execution_key' when calling list_job_logs." if job_execution_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key jobExecutionKey severity timeCreated logMessage uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, jobExecutionKey, severity, timeCreated, logMessage, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)
  raise "Parameter value for 'job_execution_key' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s).sub('{jobExecutionKey}', job_execution_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_job_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobLogCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_job_metrics(catalog_id, job_key, job_execution_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_job_metrics API.

Returns a list of job metrics.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • job_execution_key (String) —

    The key of the job execution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :category (String) —

    Category of this metric.

  • :sub_category (String) —

    Sub category of this metric under the category. Used for aggregating values. May be null.

  • :unit (String) —

    Unit of this metric.

  • :value (String) —

    Value of this metric.

  • :batch_key (String) —

    Batch key for grouping, may be null.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :time_inserted (DateTime) —

    The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a job metric summary response.

    Allowed values are: key, description, displayName, timeInserted, category, subCategory, unit, value, batchKey, jobExecutionKey, timeCreated, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8069

def list_job_metrics(catalog_id, job_key, job_execution_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_job_metrics.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_job_metrics." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling list_job_metrics." if job_key.nil?
  raise "Missing the required parameter 'job_execution_key' when calling list_job_metrics." if job_execution_key.nil?


  fields_allowable_values = %w[key description displayName timeInserted category subCategory unit value batchKey jobExecutionKey timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, description, displayName, timeInserted, category, subCategory, unit, value, batchKey, jobExecutionKey, timeCreated, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)
  raise "Parameter value for 'job_execution_key' must not be blank" if OCI::Internal::Util.blank_string?(job_execution_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s).sub('{jobExecutionKey}', job_execution_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:subCategory] = opts[:sub_category] if opts[:sub_category]
  query_params[:unit] = opts[:unit] if opts[:unit]
  query_params[:value] = opts[:value] if opts[:value]
  query_params[:batchKey] = opts[:batch_key] if opts[:batch_key]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:timeInserted] = opts[:time_inserted] if opts[:time_inserted]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_job_metrics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobMetricCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_jobs(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_jobs API.

Returns a list of jobs within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    Job lifecycle state.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :job_type (String) —

    Job type.

  • :job_definition_key (String) —

    Unique job definition key.

  • :data_asset_key (String) —

    Unique data asset key.

  • :glossary_key (String) —

    Unique glossary key.

  • :schedule_cron_expression (String) —

    Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

  • :time_schedule_begin (DateTime) —

    Date that the schedule should be operational. An RFC3339 formatted datetime string.

  • :time_schedule_end (DateTime) —

    Date that the schedule should end from being operational. An RFC3339 formatted datetime string.

  • :schedule_type (String) —

    Type of the job schedule.

  • :connection_key (String) —

    Unique connection key.

  • :fields (Array<String>) —

    Specifies the fields to return in a job summary response.

    Allowed values are: key, displayName, description, catalogId, jobDefinitionKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, jobType, scheduleCronExpression, timeScheduleBegin, scheduleType, executionCount, timeOfLatestExecution, executions, uri, jobDefinitionName, errorCode, errorMessage

  • :execution_count (Integer) —

    The total number of executions for this job schedule.

  • :time_of_latest_execution (DateTime) —

    The date and time the most recent execution for this job ,in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8199

def list_jobs(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_jobs.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_jobs." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::JOB_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::JOB_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:job_type] && !OCI::DataCatalog::Models::JOB_TYPE_ENUM.include?(opts[:job_type])
    raise 'Invalid value for "job_type", must be one of the values in OCI::DataCatalog::Models::JOB_TYPE_ENUM.'
  end

  if opts[:schedule_type] && !OCI::DataCatalog::Models::JOB_SCHEDULE_TYPE_ENUM.include?(opts[:schedule_type])
    raise 'Invalid value for "schedule_type", must be one of the values in OCI::DataCatalog::Models::JOB_SCHEDULE_TYPE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description catalogId jobDefinitionKey lifecycleState timeCreated timeUpdated createdById updatedById jobType scheduleCronExpression timeScheduleBegin scheduleType executionCount timeOfLatestExecution executions uri jobDefinitionName errorCode errorMessage]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, jobDefinitionKey, lifecycleState, timeCreated, timeUpdated, createdById, updatedById, jobType, scheduleCronExpression, timeScheduleBegin, scheduleType, executionCount, timeOfLatestExecution, executions, uri, jobDefinitionName, errorCode, errorMessage.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/jobs'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:jobType] = opts[:job_type] if opts[:job_type]
  query_params[:jobDefinitionKey] = opts[:job_definition_key] if opts[:job_definition_key]
  query_params[:dataAssetKey] = opts[:data_asset_key] if opts[:data_asset_key]
  query_params[:glossaryKey] = opts[:glossary_key] if opts[:glossary_key]
  query_params[:scheduleCronExpression] = opts[:schedule_cron_expression] if opts[:schedule_cron_expression]
  query_params[:timeScheduleBegin] = opts[:time_schedule_begin] if opts[:time_schedule_begin]
  query_params[:timeScheduleEnd] = opts[:time_schedule_end] if opts[:time_schedule_end]
  query_params[:scheduleType] = opts[:schedule_type] if opts[:schedule_type]
  query_params[:connectionKey] = opts[:connection_key] if opts[:connection_key]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:executionCount] = opts[:execution_count] if opts[:execution_count]
  query_params[:timeOfLatestExecution] = opts[:time_of_latest_execution] if opts[:time_of_latest_execution]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_jobs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_metastores(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_metastores API.

Returns a list of all metastores in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment where you want to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8316

def list_metastores(compartment_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_metastores.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_metastores." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/metastores'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_metastores') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::MetastoreSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_namespaces(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_namespaces API.

Returns a list of namespaces within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :fields (Array<String>) —

    Specifies the fields to return in a namespace summary response.

    Allowed values are: key, displayName, description, lifecycleState, timeCreated

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8408

def list_namespaces(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_namespaces.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_namespaces." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end


  fields_allowable_values = %w[key displayName description lifecycleState timeCreated]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, lifecycleState, timeCreated.'
      end
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/namespaces'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_namespaces') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::NamespaceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_patterns(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_patterns API.

Returns a list of patterns within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a pattern summary response.

    Allowed values are: key, displayName, description, catalogId, expression, lifecycleState, timeCreated

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8516

def list_patterns(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_patterns.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_patterns." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description catalogId expression lifecycleState timeCreated]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, catalogId, expression, lifecycleState, timeCreated.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/patterns'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_patterns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::PatternCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_rules(catalog_id, data_asset_key, entity_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_rules API.

Returns a list of all rules of a data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :rule_type (String) —

    Rule type used to filter the response to a list rules call.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :origin_type (String) —

    Rule origin type used to filter the response to a list rules call.

  • :external_key (String) —

    Unique external identifier of this resource in the external source system.

  • :time_created (DateTime) —

    Time that the resource was created. An RFC3339 formatted datetime string.

  • :time_updated (DateTime) —

    Time that the resource was updated. An RFC3339 formatted datetime string.

  • :created_by_id (String) —

    OCID of the user who created the resource.

  • :updated_by_id (String) —

    OCID of the user who updated the resource.

  • :fields (Array<String>) —

    Specifies the fields to return in a rule summary response.

    Allowed values are: key, displayName, ruleType, externalKey, referencedFolderKey, referencedFolderName, referencedEntityKey, referencedEntityName, referencedRuleKey, referencedRuleName, originType, lifecycleState, timeCreated, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8629

def list_rules(catalog_id, data_asset_key, entity_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_rules.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_rules." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling list_rules." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling list_rules." if entity_key.nil?

  if opts[:rule_type] && !OCI::DataCatalog::Models::RULE_TYPE_ENUM.include?(opts[:rule_type])
    raise 'Invalid value for "rule_type", must be one of the values in OCI::DataCatalog::Models::RULE_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:origin_type] && !OCI::DataCatalog::Models::RULE_ORIGIN_TYPE_ENUM.include?(opts[:origin_type])
    raise 'Invalid value for "origin_type", must be one of the values in OCI::DataCatalog::Models::RULE_ORIGIN_TYPE_ENUM.'
  end


  fields_allowable_values = %w[key displayName ruleType externalKey referencedFolderKey referencedFolderName referencedEntityKey referencedEntityName referencedRuleKey referencedRuleName originType lifecycleState timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, ruleType, externalKey, referencedFolderKey, referencedFolderName, referencedEntityKey, referencedEntityName, referencedRuleKey, referencedRuleName, originType, lifecycleState, timeCreated, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/rules'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:ruleType] = opts[:rule_type] if opts[:rule_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:originType] = opts[:origin_type] if opts[:origin_type]
  query_params[:externalKey] = opts[:external_key] if opts[:external_key]
  query_params[:timeCreated] = opts[:time_created] if opts[:time_created]
  query_params[:timeUpdated] = opts[:time_updated] if opts[:time_updated]
  query_params[:createdById] = opts[:created_by_id] if opts[:created_by_id]
  query_params[:updatedById] = opts[:updated_by_id] if opts[:updated_by_id]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::RuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tags(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_tags API.

Returns a list of all user created tags in the system.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :fields (Array<String>) —

    Specifies the fields to return in a term summary response.

    Allowed values are: key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, workflowStatus, associatedObjectCount, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8748

def list_tags(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_tags.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_tags." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description glossaryKey parentTermKey isAllowedToHaveChildTerms path lifecycleState timeCreated workflowStatus associatedObjectCount uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, workflowStatus, associatedObjectCount, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/tags'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_tags') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_term_relationships(catalog_id, glossary_key, term_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_term_relationships API.

Returns a list of all term relationships within a glossary.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :fields (Array<String>) —

    Specifies the fields to return in a term relationship summary response.

    Allowed values are: key, displayName, description, relatedTermKey, relatedTermDisplayName, parentTermKey, parentTermDisplayName, lifecycleState, timeCreated, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8850

def list_term_relationships(catalog_id, glossary_key, term_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_term_relationships.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_term_relationships." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling list_term_relationships." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling list_term_relationships." if term_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key displayName description relatedTermKey relatedTermDisplayName parentTermKey parentTermDisplayName lifecycleState timeCreated uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, relatedTermKey, relatedTermDisplayName, parentTermKey, parentTermDisplayName, lifecycleState, timeCreated, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_term_relationships') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermRelationshipCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_terms(catalog_id, glossary_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_terms API.

Returns a list of all terms within a glossary.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :display_name_contains (String) —

    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :parent_term_key (String) —

    Unique key of the parent term.

  • :is_allowed_to_have_child_terms (BOOLEAN) —

    Indicates whether a term may contain child terms.

  • :workflow_status (String) —

    Status of the approval workflow for this business term in the glossary.

  • :path (String) —

    Full path of the resource for resources that support paths.

  • :fields (Array<String>) —

    Specifies the fields to return in a term summary response.

    Allowed values are: key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, workflowStatus, associatedObjectCount, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 8959

def list_terms(catalog_id, glossary_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_terms.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_terms." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling list_terms." if glossary_key.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:workflow_status] && !OCI::DataCatalog::Models::TERM_WORKFLOW_STATUS_ENUM.include?(opts[:workflow_status])
    raise 'Invalid value for "workflow_status", must be one of the values in OCI::DataCatalog::Models::TERM_WORKFLOW_STATUS_ENUM.'
  end


  fields_allowable_values = %w[key displayName description glossaryKey parentTermKey isAllowedToHaveChildTerms path lifecycleState timeCreated workflowStatus associatedObjectCount uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, displayName, description, glossaryKey, parentTermKey, isAllowedToHaveChildTerms, path, lifecycleState, timeCreated, workflowStatus, associatedObjectCount, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:parentTermKey] = opts[:parent_term_key] if opts[:parent_term_key]
  query_params[:isAllowedToHaveChildTerms] = opts[:is_allowed_to_have_child_terms] if !opts[:is_allowed_to_have_child_terms].nil?
  query_params[:workflowStatus] = opts[:workflow_status] if opts[:workflow_status]
  query_params[:path] = opts[:path] if opts[:path]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_terms') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_types(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_types API.

Returns a list of all types within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :is_internal (String) —

    Indicates whether the type is internal, making it unavailable for use by metadata elements.

  • :is_tag (String) —

    Indicates whether the type can be used for tagging metadata elements.

  • :is_approved (String) —

    Indicates whether the type is approved for use as a classifying object.

  • :external_type_name (String) —

    Data type as defined in an external system.

  • :type_category (String) —

    Indicates the category of this type . For example, data assets or connections.

  • :fields (Array<String>) —

    Specifies the fields to return in a type summary response.

    Allowed values are: key, description, name, catalogId, lifecycleState, typeCategory, uri

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9070

def list_types(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_types.' if logger

  raise "Missing the required parameter 'catalog_id' when calling list_types." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end


  fields_allowable_values = %w[key description name catalogId lifecycleState typeCategory uri]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of key, description, name, catalogId, lifecycleState, typeCategory, uri.'
      end
    end
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/types'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:isInternal] = opts[:is_internal] if opts[:is_internal]
  query_params[:isTag] = opts[:is_tag] if opts[:is_tag]
  query_params[:isApproved] = opts[:is_approved] if opts[:is_approved]
  query_params[:externalTypeName] = opts[:external_type_name] if opts[:external_type_name]
  query_params[:typeCategory] = opts[:type_category] if opts[:type_category]
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Returns a (paginated) list of errors for a given work request.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default.

    Allowed values are: CODE, TIMESTAMP

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

Returns:



9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9166

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_by] && !%w[CODE TIMESTAMP].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of CODE, TIMESTAMP.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Returns a (paginated) list of logs for a given work request.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default.

    Allowed values are: MESSAGE, TIMESTAMP

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

Returns:



9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9240

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_by] && !%w[MESSAGE TIMESTAMP].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of MESSAGE, TIMESTAMP.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::WorkRequestLog>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

Lists the work requests in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment where you want to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

    The maximum number of items to return.

Returns:



9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9309

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::WorkRequest>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 95

def logger
  @api_client.config.logger
end

#object_stats(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use object_stats API.

Returns stats on objects by type in the repository.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type String



9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9372

def object_stats(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#object_stats.' if logger

  raise "Missing the required parameter 'catalog_id' when calling object_stats." if catalog_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/objectStats'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#object_stats') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'String'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#parse_connection(catalog_id, data_asset_key, parse_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use parse_connection API.

Parse data asset references through connections from this data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • parse_connection_details (OCI::DataCatalog::Models::ParseConnectionDetails) —

    The information used to parse the connections from payload or connection detail.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :connection_key (String) —

    Unique connection key.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9447

def parse_connection(catalog_id, data_asset_key, parse_connection_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#parse_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling parse_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling parse_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'parse_connection_details' when calling parse_connection." if parse_connection_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/parseConnection'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:connectionKey] = opts[:connection_key] if opts[:connection_key]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(parse_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#parse_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataCatalog::Models::ConnectionAliasSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#process_recommendation(catalog_id, process_recommendation_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use process_recommendation API.

Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9516

def process_recommendation(catalog_id, process_recommendation_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#process_recommendation.' if logger

  raise "Missing the required parameter 'catalog_id' when calling process_recommendation." if catalog_id.nil?
  raise "Missing the required parameter 'process_recommendation_details' when calling process_recommendation." if process_recommendation_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/processRecommendation'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(process_recommendation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#process_recommendation') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ProcessRecommendationDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#recommendations(catalog_id, recommendation_type, source_object_key, source_object_type, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use recommendations API.

Returns a list of recommendations for the given object and recommendation type. By default, it will return inferred recommendations for review. The optional query param 'RecommendationStatus' can be set, to return only recommendations having that status.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • recommendation_type (Array<String>) —

    A filter used to return only recommendations of the specified type. Allowed values are: LINK_GLOSSARY_TERM

  • source_object_key (String) —

    A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review.

  • source_object_type (String) —

    A filter used to provide the type of the source object, for which a list of recommendations will be returned for review.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :recommendation_status (String) —

    A filter used to return only recommendations having the requested status.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9580

def recommendations(catalog_id, recommendation_type, source_object_key, source_object_type, opts = {})
  logger.debug 'Calling operation DataCatalogClient#recommendations.' if logger

  raise "Missing the required parameter 'catalog_id' when calling recommendations." if catalog_id.nil?
  raise "Missing the required parameter 'recommendation_type' when calling recommendations." if recommendation_type.nil?

  recommendation_type_allowable_values = %w[LINK_GLOSSARY_TERM]
  recommendation_type.each do |val_to_check|
    unless recommendation_type_allowable_values.include?(val_to_check)
      raise "Invalid value for 'recommendation_type', must be one of LINK_GLOSSARY_TERM."
    end
  end
  raise "Missing the required parameter 'source_object_key' when calling recommendations." if source_object_key.nil?
  raise "Missing the required parameter 'source_object_type' when calling recommendations." if source_object_type.nil?
  unless OCI::DataCatalog::Models::RECOMMENDATION_RESOURCE_TYPE_ENUM.include?(source_object_type)
    raise 'Invalid value for "source_object_type", must be one of the values in OCI::DataCatalog::Models::RECOMMENDATION_RESOURCE_TYPE_ENUM.'
  end


  if opts[:recommendation_status] && !OCI::DataCatalog::Models::RECOMMENDATION_STATUS_ENUM.include?(opts[:recommendation_status])
    raise 'Invalid value for "recommendation_status", must be one of the values in OCI::DataCatalog::Models::RECOMMENDATION_STATUS_ENUM.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/getRecommendations'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:recommendationType] = OCI::ApiClient.build_collection_params(recommendation_type, :multi)
  query_params[:sourceObjectKey] = source_object_key
  query_params[:sourceObjectType] = source_object_type
  query_params[:recommendationStatus] = opts[:recommendation_status] if opts[:recommendation_status]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#recommendations') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::RecommendationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_catalog_lock(catalog_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_catalog_lock API.

Removes a lock from a Catalog resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9663

def remove_catalog_lock(catalog_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#remove_catalog_lock.' if logger

  raise "Missing the required parameter 'catalog_id' when calling remove_catalog_lock." if catalog_id.nil?
  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_catalog_lock." if remove_resource_lock_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/removeLock'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#remove_catalog_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Catalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_catalog_private_endpoint_lock(catalog_private_endpoint_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_catalog_private_endpoint_lock API.

Removes a lock from a CatalogPrivateEndpoint resource.

Parameters:

  • catalog_private_endpoint_id (String) —

    Unique private reverse connection identifier.

  • remove_resource_lock_details (OCI::DataCatalog::Models::RemoveResourceLockDetails) —

    RemoveResourceLockDetails body parameter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9726

def remove_catalog_private_endpoint_lock(catalog_private_endpoint_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#remove_catalog_private_endpoint_lock.' if logger

  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling remove_catalog_private_endpoint_lock." if catalog_private_endpoint_id.nil?
  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_catalog_private_endpoint_lock." if remove_resource_lock_details.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/removeLock'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#remove_catalog_private_endpoint_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CatalogPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_data_selector_patterns API.

Remove data selector pattern from the data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • data_selector_pattern_details (OCI::DataCatalog::Models::DataSelectorPatternDetails) —

    The information used to remove the data selector patterns.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9796

def remove_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#remove_data_selector_patterns.' if logger

  raise "Missing the required parameter 'catalog_id' when calling remove_data_selector_patterns." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling remove_data_selector_patterns." if data_asset_key.nil?
  raise "Missing the required parameter 'data_selector_pattern_details' when calling remove_data_selector_patterns." if data_selector_pattern_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/removeDataSelectorPatterns'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(data_selector_pattern_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#remove_data_selector_patterns') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_metastore_lock(metastore_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_metastore_lock API.

Removes a lock from a Metastore resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9863

def remove_metastore_lock(metastore_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#remove_metastore_lock.' if logger

  raise "Missing the required parameter 'metastore_id' when calling remove_metastore_lock." if metastore_id.nil?
  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_metastore_lock." if remove_resource_lock_details.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}/actions/removeLock'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#remove_metastore_lock') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Metastore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_criteria(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_criteria API.

Returns a list of search results within a data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :search_criteria_details (OCI::DataCatalog::Models::SearchCriteria) —

    The information used to create an extended search results.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :name (String) —

    Immutable resource name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

  • :timeout (String) —

    A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 9934

def search_criteria(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#search_criteria.' if logger

  raise "Missing the required parameter 'catalog_id' when calling search_criteria." if catalog_id.nil?

  if opts[:lifecycle_state] && !OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataCatalog::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/search'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeout] = opts[:timeout] if opts[:timeout]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(opts[:search_criteria_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#search_criteria') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::SearchResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#suggest_matches(catalog_id, input_text, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use suggest_matches API.

Returns a list of potential string matches for a given input string.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • input_text (String) —

    Text input string used for computing potential matching suggestions.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :timeout (String) —

    A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.

  • :limit (Integer) —

    Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10. (default to 10)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10016

def suggest_matches(catalog_id, input_text, opts = {})
  logger.debug 'Calling operation DataCatalogClient#suggest_matches.' if logger

  raise "Missing the required parameter 'catalog_id' when calling suggest_matches." if catalog_id.nil?
  raise "Missing the required parameter 'input_text' when calling suggest_matches." if input_text.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/suggest'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:inputText] = input_text
  query_params[:timeout] = opts[:timeout] if opts[:timeout]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#suggest_matches') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::SuggestResults'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#synchronous_export_data_asset(catalog_id, data_asset_key, synchronous_export_data_asset_details, export_type, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use synchronous_export_data_asset API.

Export technical objects from a Data Asset

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • synchronous_export_data_asset_details (OCI::DataCatalog::Models::ExportDataAssetDetails) —

    The details of what needs to be exported.

  • export_type (Array<String>) —

    Type of export. Allowed values are: CUSTOM_PROPERTY_VALUES, ALL

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10086

def synchronous_export_data_asset(catalog_id, data_asset_key, synchronous_export_data_asset_details, export_type, opts = {}, &block)
  logger.debug 'Calling operation DataCatalogClient#synchronous_export_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling synchronous_export_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling synchronous_export_data_asset." if data_asset_key.nil?
  raise "Missing the required parameter 'synchronous_export_data_asset_details' when calling synchronous_export_data_asset." if synchronous_export_data_asset_details.nil?
  raise "Missing the required parameter 'export_type' when calling synchronous_export_data_asset." if export_type.nil?

  export_type_allowable_values = %w[CUSTOM_PROPERTY_VALUES ALL]
  export_type.each do |val_to_check|
    unless export_type_allowable_values.include?(val_to_check)
      raise "Invalid value for 'export_type', must be one of CUSTOM_PROPERTY_VALUES, ALL."
    end
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/synchronousExport'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:exportType] = OCI::ApiClient.build_collection_params(export_type, :multi)

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(synchronous_export_data_asset_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#synchronous_export_data_asset') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#test_connection(catalog_id, data_asset_key, connection_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use test_connection API.

Test the connection by connecting to the data asset using credentials in the metadata.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • connection_key (String) —

    Unique connection key.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10206

def test_connection(catalog_id, data_asset_key, connection_key, opts = {})
  logger.debug 'Calling operation DataCatalogClient#test_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling test_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling test_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'connection_key' when calling test_connection." if connection_key.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/test'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{connectionKey}', connection_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#test_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ValidateConnectionResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_attribute(catalog_id, data_asset_key, entity_key, attribute_key, update_attribute_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_attribute API.

Updates a specific data asset attribute.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • attribute_key (String) —

    Unique attribute key.

  • update_attribute_details (OCI::DataCatalog::Models::UpdateAttributeDetails) —

    The information to be updated in the attribute.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10276

def update_attribute(catalog_id, data_asset_key, entity_key, attribute_key, update_attribute_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_attribute.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_attribute." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling update_attribute." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling update_attribute." if entity_key.nil?
  raise "Missing the required parameter 'attribute_key' when calling update_attribute." if attribute_key.nil?
  raise "Missing the required parameter 'update_attribute_details' when calling update_attribute." if update_attribute_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)
  raise "Parameter value for 'attribute_key' must not be blank" if OCI::Internal::Util.blank_string?(attribute_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s).sub('{attributeKey}', attribute_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_attribute_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_attribute') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Attribute'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_catalog(catalog_id, update_catalog_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_catalog API.

Updates the data catalog.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • update_catalog_details (OCI::DataCatalog::Models::UpdateCatalogDetails) —

    The data catalog information to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:



10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10346

def update_catalog(catalog_id, update_catalog_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_catalog.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_catalog." if catalog_id.nil?
  raise "Missing the required parameter 'update_catalog_details' when calling update_catalog." if update_catalog_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_catalog_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_catalog') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Catalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_catalog_private_endpoint(catalog_private_endpoint_id, update_catalog_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_catalog_private_endpoint API.

Updates the private reverse connection endpoint.

Parameters:

  • catalog_private_endpoint_id (String) —

    Unique private reverse connection identifier.

  • update_catalog_private_endpoint_details (OCI::DataCatalog::Models::UpdateCatalogPrivateEndpointDetails) —

    The information to be updated in private reverse connection

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10411

def update_catalog_private_endpoint(catalog_private_endpoint_id, update_catalog_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_catalog_private_endpoint.' if logger

  raise "Missing the required parameter 'catalog_private_endpoint_id' when calling update_catalog_private_endpoint." if catalog_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_catalog_private_endpoint_details' when calling update_catalog_private_endpoint." if update_catalog_private_endpoint_details.nil?
  raise "Parameter value for 'catalog_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_private_endpoint_id)

  path = '/catalogPrivateEndpoints/{catalogPrivateEndpointId}'.sub('{catalogPrivateEndpointId}', catalog_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_catalog_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_catalog_private_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_connection(catalog_id, data_asset_key, connection_key, update_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_connection API.

Updates a specific connection of a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • connection_key (String) —

    Unique connection key.

  • update_connection_details (OCI::DataCatalog::Models::UpdateConnectionDetails) —

    The information to be updated in the connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10476

def update_connection(catalog_id, data_asset_key, connection_key, update_connection_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling update_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'connection_key' when calling update_connection." if connection_key.nil?
  raise "Missing the required parameter 'update_connection_details' when calling update_connection." if update_connection_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{connectionKey}', connection_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_connection') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_custom_property(catalog_id, namespace_id, custom_property_key, update_custom_property_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_custom_property API.

Updates a specific custom property identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • custom_property_key (String) —

    Unique Custom Property key

  • update_custom_property_details (OCI::DataCatalog::Models::UpdateCustomPropertyDetails) —

    The information to be updated in the custom property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10545

def update_custom_property(catalog_id, namespace_id, custom_property_key, update_custom_property_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_custom_property.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_custom_property." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling update_custom_property." if namespace_id.nil?
  raise "Missing the required parameter 'custom_property_key' when calling update_custom_property." if custom_property_key.nil?
  raise "Missing the required parameter 'update_custom_property_details' when calling update_custom_property." if update_custom_property_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)
  raise "Parameter value for 'custom_property_key' must not be blank" if OCI::Internal::Util.blank_string?(custom_property_key)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s).sub('{customPropertyKey}', custom_property_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_custom_property_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_custom_property') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::CustomProperty'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_asset(catalog_id, data_asset_key, update_data_asset_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_data_asset API.

Updates a specific data asset identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • update_data_asset_details (OCI::DataCatalog::Models::UpdateDataAssetDetails) —

    The information to be updated in the data asset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10613

def update_data_asset(catalog_id, data_asset_key, update_data_asset_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_data_asset.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_data_asset." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling update_data_asset." if data_asset_key.nil?
  raise "Missing the required parameter 'update_data_asset_details' when calling update_data_asset." if update_data_asset_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_data_asset_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_data_asset') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::DataAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_entity(catalog_id, data_asset_key, entity_key, update_entity_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_entity API.

Updates a specific data entity.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • entity_key (String) —

    Unique entity key.

  • update_entity_details (OCI::DataCatalog::Models::UpdateEntityDetails) —

    The information to be updated in the data entity.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10680

def update_entity(catalog_id, data_asset_key, entity_key, update_entity_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_entity.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_entity." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling update_entity." if data_asset_key.nil?
  raise "Missing the required parameter 'entity_key' when calling update_entity." if entity_key.nil?
  raise "Missing the required parameter 'update_entity_details' when calling update_entity." if update_entity_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'entity_key' must not be blank" if OCI::Internal::Util.blank_string?(entity_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{entityKey}', entity_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_entity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_entity') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Entity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_folder(catalog_id, data_asset_key, folder_key, update_folder_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_folder API.

Updates a specific folder of a data asset.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • folder_key (String) —

    Unique folder key.

  • update_folder_details (OCI::DataCatalog::Models::UpdateFolderDetails) —

    The information to be updated in the folder.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10749

def update_folder(catalog_id, data_asset_key, folder_key, update_folder_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_folder.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_folder." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling update_folder." if data_asset_key.nil?
  raise "Missing the required parameter 'folder_key' when calling update_folder." if folder_key.nil?
  raise "Missing the required parameter 'update_folder_details' when calling update_folder." if update_folder_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{folderKey}', folder_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_folder_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_folder') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Folder'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_glossary(catalog_id, glossary_key, update_glossary_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_glossary API.

Updates a specific glossary identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • update_glossary_details (OCI::DataCatalog::Models::UpdateGlossaryDetails) —

    The information to be updated in the glossary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10817

def update_glossary(catalog_id, glossary_key, update_glossary_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_glossary.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_glossary." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling update_glossary." if glossary_key.nil?
  raise "Missing the required parameter 'update_glossary_details' when calling update_glossary." if update_glossary_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_glossary_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_glossary') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Glossary'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_job(catalog_id, job_key, update_job_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_job API.

Updates a specific job identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_key (String) —

    Unique job key.

  • update_job_details (OCI::DataCatalog::Models::UpdateJobDetails) —

    The information to be updated in the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Job



10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10883

def update_job(catalog_id, job_key, update_job_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_job.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_job." if catalog_id.nil?
  raise "Missing the required parameter 'job_key' when calling update_job." if job_key.nil?
  raise "Missing the required parameter 'update_job_details' when calling update_job." if update_job_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_key' must not be blank" if OCI::Internal::Util.blank_string?(job_key)

  path = '/catalogs/{catalogId}/jobs/{jobKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobKey}', job_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_job') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_job_definition(catalog_id, job_definition_key, update_job_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_job_definition API.

Update a specific job definition identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • job_definition_key (String) —

    Unique job definition key.

  • update_job_definition_details (OCI::DataCatalog::Models::UpdateJobDefinitionDetails) —

    The information to be updated in the job definition.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 10949

def update_job_definition(catalog_id, job_definition_key, update_job_definition_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_job_definition.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_job_definition." if catalog_id.nil?
  raise "Missing the required parameter 'job_definition_key' when calling update_job_definition." if job_definition_key.nil?
  raise "Missing the required parameter 'update_job_definition_details' when calling update_job_definition." if update_job_definition_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'job_definition_key' must not be blank" if OCI::Internal::Util.blank_string?(job_definition_key)

  path = '/catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey}'.sub('{catalogId}', catalog_id.to_s).sub('{jobDefinitionKey}', job_definition_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_job_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_job_definition') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::JobDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_metastore(metastore_id, update_metastore_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_metastore API.

Updates a metastore resource by identifier.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

Returns:



11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11015

def update_metastore(metastore_id, update_metastore_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_metastore.' if logger

  raise "Missing the required parameter 'metastore_id' when calling update_metastore." if metastore_id.nil?
  raise "Missing the required parameter 'update_metastore_details' when calling update_metastore." if update_metastore_details.nil?
  raise "Parameter value for 'metastore_id' must not be blank" if OCI::Internal::Util.blank_string?(metastore_id)

  path = '/metastores/{metastoreId}'.sub('{metastoreId}', metastore_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_metastore_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_metastore') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Metastore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_namespace(catalog_id, namespace_id, update_namespace_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_namespace API.

Updates a specific namespace identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • namespace_id (String) —

    Unique namespace identifier.

  • update_namespace_details (OCI::DataCatalog::Models::UpdateNamespaceDetails) —

    The information to be updated in the namespace.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11080

def update_namespace(catalog_id, namespace_id, update_namespace_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_namespace.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_namespace." if catalog_id.nil?
  raise "Missing the required parameter 'namespace_id' when calling update_namespace." if namespace_id.nil?
  raise "Missing the required parameter 'update_namespace_details' when calling update_namespace." if update_namespace_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(namespace_id)

  path = '/catalogs/{catalogId}/namespaces/{namespaceId}'.sub('{catalogId}', catalog_id.to_s).sub('{namespaceId}', namespace_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_namespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_namespace') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Namespace'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_pattern(catalog_id, pattern_key, update_pattern_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_pattern API.

Updates a specific pattern identified by the given key.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • pattern_key (String) —

    Unique pattern key.

  • update_pattern_details (OCI::DataCatalog::Models::UpdatePatternDetails) —

    The information to be updated in the pattern.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11146

def update_pattern(catalog_id, pattern_key, update_pattern_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_pattern.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_pattern." if catalog_id.nil?
  raise "Missing the required parameter 'pattern_key' when calling update_pattern." if pattern_key.nil?
  raise "Missing the required parameter 'update_pattern_details' when calling update_pattern." if update_pattern_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)

  path = '/catalogs/{catalogId}/patterns/{patternKey}'.sub('{catalogId}', catalog_id.to_s).sub('{patternKey}', pattern_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_pattern_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_pattern') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Pattern'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_term(catalog_id, glossary_key, term_key, update_term_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_term API.

Updates a specific glossary term.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • update_term_details (OCI::DataCatalog::Models::UpdateTermDetails) —

    The information to be updated in the term.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11213

def update_term(catalog_id, glossary_key, term_key, update_term_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_term.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_term." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling update_term." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling update_term." if term_key.nil?
  raise "Missing the required parameter 'update_term_details' when calling update_term." if update_term_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_term_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_term') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Term'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, update_term_relationship_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_term_relationship API.

Updates a specific glossary term relationship.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • glossary_key (String) —

    Unique glossary key.

  • term_key (String) —

    Unique glossary term key.

  • term_relationship_key (String) —

    Unique glossary term relationship key.

  • update_term_relationship_details (OCI::DataCatalog::Models::UpdateTermRelationshipDetails) —

    The information to be updated in the term relationship.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11283

def update_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, update_term_relationship_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#update_term_relationship.' if logger

  raise "Missing the required parameter 'catalog_id' when calling update_term_relationship." if catalog_id.nil?
  raise "Missing the required parameter 'glossary_key' when calling update_term_relationship." if glossary_key.nil?
  raise "Missing the required parameter 'term_key' when calling update_term_relationship." if term_key.nil?
  raise "Missing the required parameter 'term_relationship_key' when calling update_term_relationship." if term_relationship_key.nil?
  raise "Missing the required parameter 'update_term_relationship_details' when calling update_term_relationship." if update_term_relationship_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'glossary_key' must not be blank" if OCI::Internal::Util.blank_string?(glossary_key)
  raise "Parameter value for 'term_key' must not be blank" if OCI::Internal::Util.blank_string?(term_key)
  raise "Parameter value for 'term_relationship_key' must not be blank" if OCI::Internal::Util.blank_string?(term_relationship_key)

  path = '/catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey}'.sub('{catalogId}', catalog_id.to_s).sub('{glossaryKey}', glossary_key.to_s).sub('{termKey}', term_key.to_s).sub('{termRelationshipKey}', term_relationship_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_term_relationship_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#update_term_relationship') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::TermRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_credentials(catalog_id, data_asset_key, connection_key, upload_credentials_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_credentials API.

Upload connection credentails and metadata for this connection.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • connection_key (String) —

    Unique connection key.

  • upload_credentials_details (OCI::DataCatalog::Models::UploadCredentialsDetails) —

    The information used to upload the credentials file and metadata for updating this connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11360

def upload_credentials(catalog_id, data_asset_key, connection_key, upload_credentials_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#upload_credentials.' if logger

  raise "Missing the required parameter 'catalog_id' when calling upload_credentials." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling upload_credentials." if data_asset_key.nil?
  raise "Missing the required parameter 'connection_key' when calling upload_credentials." if connection_key.nil?
  raise "Missing the required parameter 'upload_credentials_details' when calling upload_credentials." if upload_credentials_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)
  raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/uploadCredentials'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s).sub('{connectionKey}', connection_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(upload_credentials_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#upload_credentials') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#users(catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use users API.

Returns active users in the system.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type String



11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11429

def users(catalog_id, opts = {})
  logger.debug 'Calling operation DataCatalogClient#users.' if logger

  raise "Missing the required parameter 'catalog_id' when calling users." if catalog_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)

  path = '/catalogs/{catalogId}/actions/users'.sub('{catalogId}', catalog_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#users') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'String'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_connection(catalog_id, data_asset_key, validate_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_connection API.

Validate connection by connecting to the data asset using credentials in metadata.

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • data_asset_key (String) —

    Unique data asset key.

  • validate_connection_details (OCI::DataCatalog::Models::ValidateConnectionDetails) —

    The information used to validate the connections.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11503

def validate_connection(catalog_id, data_asset_key, validate_connection_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#validate_connection.' if logger

  raise "Missing the required parameter 'catalog_id' when calling validate_connection." if catalog_id.nil?
  raise "Missing the required parameter 'data_asset_key' when calling validate_connection." if data_asset_key.nil?
  raise "Missing the required parameter 'validate_connection_details' when calling validate_connection." if validate_connection_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key)

  path = '/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/validateConnection'.sub('{catalogId}', catalog_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(validate_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#validate_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ValidateConnectionResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_pattern(catalog_id, pattern_key, validate_pattern_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_pattern API.

Validate pattern by deriving file groups representing logical entities using the expression

Parameters:

  • catalog_id (String) —

    Unique catalog identifier.

  • pattern_key (String) —

    Unique pattern key.

  • validate_pattern_details (OCI::DataCatalog::Models::ValidatePatternDetails) —

    The information used to validate the pattern.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
 
# File 'lib/oci/data_catalog/data_catalog_client.rb', line 11570

def validate_pattern(catalog_id, pattern_key, validate_pattern_details, opts = {})
  logger.debug 'Calling operation DataCatalogClient#validate_pattern.' if logger

  raise "Missing the required parameter 'catalog_id' when calling validate_pattern." if catalog_id.nil?
  raise "Missing the required parameter 'pattern_key' when calling validate_pattern." if pattern_key.nil?
  raise "Missing the required parameter 'validate_pattern_details' when calling validate_pattern." if validate_pattern_details.nil?
  raise "Parameter value for 'catalog_id' must not be blank" if OCI::Internal::Util.blank_string?(catalog_id)
  raise "Parameter value for 'pattern_key' must not be blank" if OCI::Internal::Util.blank_string?(pattern_key)

  path = '/catalogs/{catalogId}/patterns/{patternKey}/actions/validate'.sub('{catalogId}', catalog_id.to_s).sub('{patternKey}', pattern_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(validate_pattern_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataCatalogClient#validate_pattern') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataCatalog::Models::ValidatePatternResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end