Class: OCI::Database::DatabaseClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/database_client.rb

Overview

The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see Overview of the Database Service.

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) ⇒ DatabaseClient

Creates a new DatabaseClient. 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



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

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 + '/20160918'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DatabaseClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/database/database_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/database/database_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database/database_client.rb', line 29

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:



25
26
27
 
# File 'lib/oci/database/database_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#activate_exadata_infrastructure(exadata_infrastructure_id, activate_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • activate_exadata_infrastructure_details (OCI::Database::Models::ActivateExadataInfrastructureDetails) —

    The activation details for the Exadata infrastructure and the additional storage servers requested.

  • 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.

  • :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 may be rejected).

Returns:



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
158
159
 
# File 'lib/oci/database/database_client.rb', line 120

def activate_exadata_infrastructure(exadata_infrastructure_id, activate_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#activate_exadata_infrastructure.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/actions/activate'.sub('{exadataInfrastructureId}', exadata_infrastructure_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(activate_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#activate_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_dbnode_snapshots_for_exadb_vm_cluster(add_dbnode_snapshots_for_exadb_vm_cluster_details, exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Add a database node snapshots to the Exadb VM cluster..

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



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
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/database/database_client.rb', line 191

def add_dbnode_snapshots_for_exadb_vm_cluster(add_dbnode_snapshots_for_exadb_vm_cluster_details, exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_dbnode_snapshots_for_exadb_vm_cluster.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/addDbNodeSnapshots'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_dbnode_snapshots_for_exadb_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#add_dbnode_snapshots_for_exadb_vm_cluster') 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::Database::Models::DbnodeSnapshots'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_standby_autonomous_container_database(add_standby_autonomous_container_database_details, autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard.

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.

  • :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 may be rejected).

  • :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:



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
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/database/database_client.rb', line 263

def add_standby_autonomous_container_database(add_standby_autonomous_container_database_details, autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_standby_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/addStandby'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_standby_autonomous_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#add_standby_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_storage_capacity_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_exadata_infrastructure_id (String) —

    The cloud Exadata infrastructure 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/database/database_client.rb', line 333

def add_storage_capacity_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_storage_capacity_cloud_exadata_infrastructure.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/addStorageCapacity'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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]
  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: 'DatabaseClient#add_storage_capacity_cloud_exadata_infrastructure') 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::Database::Models::CloudExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_storage_capacity_exadata_infrastructure(exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



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
433
434
435
436
437
438
439
440
441
 
# File 'lib/oci/database/database_client.rb', line 402

def add_storage_capacity_exadata_infrastructure(exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_storage_capacity_exadata_infrastructure.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/actions/addStorageCapacity'.sub('{exadataInfrastructureId}', exadata_infrastructure_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]
  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: 'DatabaseClient#add_storage_capacity_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_virtual_machine_to_cloud_vm_cluster(add_virtual_machine_to_cloud_vm_cluster_details, cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



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
511
512
 
# File 'lib/oci/database/database_client.rb', line 472

def add_virtual_machine_to_cloud_vm_cluster(add_virtual_machine_to_cloud_vm_cluster_details, cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_virtual_machine_to_cloud_vm_cluster.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/addVirtualMachine'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_virtual_machine_to_cloud_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#add_virtual_machine_to_cloud_vm_cluster') 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::Database::Models::CloudVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_virtual_machine_to_vm_cluster(add_virtual_machine_to_vm_cluster_details, vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



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
579
580
581
582
583
 
# File 'lib/oci/database/database_client.rb', line 543

def add_virtual_machine_to_vm_cluster(add_virtual_machine_to_vm_cluster_details, vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#add_virtual_machine_to_vm_cluster.' if logger

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

  path = '/vmClusters/{vmClusterId}/actions/addVirtualMachine'.sub('{vmClusterId}', vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_virtual_machine_to_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#add_virtual_machine_to_vm_cluster') 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::Database::Models::VmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#autonomous_database_manual_refresh(autonomous_database_id, autonomous_database_manual_refresh_details, opts = {}) ⇒ Response

Note:

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

Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
651
652
653
654
655
656
657
658
 
# File 'lib/oci/database/database_client.rb', line 617

def autonomous_database_manual_refresh(autonomous_database_id, autonomous_database_manual_refresh_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#autonomous_database_manual_refresh.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/refresh'.sub('{autonomousDatabaseId}', autonomous_database_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-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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(autonomous_database_manual_refresh_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#autonomous_database_manual_refresh') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cancel_backup(backup_id, opts = {}) ⇒ Response

Note:

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

Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id.

Parameters:

  • backup_id (String) —

    The backup 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



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
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/oci/database/database_client.rb', line 687

def cancel_backup(backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#cancel_backup.' if logger

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

  path = '/backups/{backupId}/actions/cancel'.sub('{backupId}', backup_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]
  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: 'DatabaseClient#cancel_backup') 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

#cancel_execution_window(execution_window_id, cancel_execution_window_details, opts = {}) ⇒ Response

Note:

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

Cancels the in progress maintenance activity under this execution window.

Parameters:

  • execution_window_id (String) —

    The execution window OCID.

  • cancel_execution_window_details (OCI::Database::Models::CancelExecutionWindowDetails) —

    Request to cancel the in progress maintenance activity under this execution window.

  • 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/oci/database/database_client.rb', line 756

def cancel_execution_window(execution_window_id, cancel_execution_window_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#cancel_execution_window.' if logger

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

  path = '/executionWindows/{executionWindowId}/actions/cancel'.sub('{executionWindowId}', execution_window_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]
  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(cancel_execution_window_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#cancel_execution_window') 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::Database::Models::ExecutionWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cascading_delete_scheduling_plan(scheduling_plan_id, opts = {}) ⇒ Response

Note:

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

Delete the scheduling plan resource along with all the scheduled actions associated with this resource.

Parameters:

  • scheduling_plan_id (String) —

    The Schedule Plan 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_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 may be rejected).

  • :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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/oci/database/database_client.rb', line 826

def cascading_delete_scheduling_plan(scheduling_plan_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#cascading_delete_scheduling_plan.' if logger

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

  path = '/schedulingPlans/{schedulingPlanId}/actions/cascadingDeleteSchedulingPlan'.sub('{schedulingPlanId}', scheduling_plan_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  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: 'DatabaseClient#cascading_delete_scheduling_plan') 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_autonomous_container_database_compartment(change_compartment_details, autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move Autonomous Container Database to a different compartment

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/oci/database/database_client.rb', line 897

def change_autonomous_container_database_compartment(change_compartment_details, autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_container_database_compartment.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeCompartment'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_container_database_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_autonomous_database_compartment(change_compartment_details, autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Move the Autonomous AI Database and its dependent resources to the specified compartment. For more information about moving Autonomous AI Databases, see Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move Autonomous AI Database to a different compartment

  • autonomous_database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/oci/database/database_client.rb', line 972

def change_autonomous_database_compartment(change_compartment_details, autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_database_compartment.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/changeCompartment'.sub('{autonomousDatabaseId}', autonomous_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_database_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_autonomous_database_software_image_compartment(change_autonomous_database_software_image_compartment_details, autonomous_database_software_image_id, opts = {}) ⇒ Response

Note:

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

Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/oci/database/database_client.rb', line 1043

def change_autonomous_database_software_image_compartment(change_autonomous_database_software_image_compartment_details, autonomous_database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_database_software_image_compartment.' if logger

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

  path = '/autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}/actions/changeCompartment'.sub('{autonomousDatabaseSoftwareImageId}', autonomous_database_software_image_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_autonomous_database_software_image_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_database_software_image_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_autonomous_database_subscription(change_autonomous_database_subscription_details, autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Associate an Autonomous AI Database with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/oci/database/database_client.rb', line 1116

def change_autonomous_database_subscription(change_autonomous_database_subscription_details, autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_database_subscription.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/changeSubscription'.sub('{autonomousDatabaseId}', autonomous_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_autonomous_database_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_database_subscription') 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_autonomous_exadata_infrastructure_compartment(change_compartment_details, autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the #change_cloud_exadata_infrastructure_compartment change_cloud_exadata_infrastructure_compartment} operation to move an Exadata infrastructure resource to a different compartment and change_cloud_autonomous_vm_cluster_compartment operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see {Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move an Autonomous Exadata Infrastructure resource to a different compartment.

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
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
 
# File 'lib/oci/database/database_client.rb', line 1189

def change_autonomous_exadata_infrastructure_compartment(change_compartment_details, autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_exadata_infrastructure_compartment.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/changeCompartment'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_exadata_infrastructure_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_autonomous_vm_cluster_compartment(change_autonomous_vm_cluster_compartment_details, autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see change_autonomous_vm_cluster_compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1259
1260
1261
1262
1263
1264
1265
1266
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
 
# File 'lib/oci/database/database_client.rb', line 1259

def change_autonomous_vm_cluster_compartment(change_autonomous_vm_cluster_compartment_details, autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_autonomous_vm_cluster_compartment.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/actions/changeCompartment'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_autonomous_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_autonomous_vm_cluster_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_backup_destination_compartment(change_compartment_details, backup_destination_id, opts = {}) ⇒ Response

Note:

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

Move the backup destination and its dependent resources to the specified compartment. For more information, see Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move backup destination to a different compartment.

  • backup_destination_id (String) —

    The OCID of the backup destination.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 1332

def change_backup_destination_compartment(change_compartment_details, backup_destination_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_backup_destination_compartment.' if logger

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

  path = '/backupDestinations/{backupDestinationId}/actions/changeCompartment'.sub('{backupDestinationId}', backup_destination_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_backup_destination_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_basecc_vm_cluster_compartment(change_basecc_vm_cluster_compartment_details, basecc_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves a BaseDB-C@C VM cluster and its dependent resources to another compartment. Applies to Base Database Service on Cloud@Customer instances only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
1441
 
# File 'lib/oci/database/database_client.rb', line 1402

def change_basecc_vm_cluster_compartment(change_basecc_vm_cluster_compartment_details, basecc_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_basecc_vm_cluster_compartment.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}/actions/changeCompartment'.sub('{baseccVmClusterId}', basecc_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_basecc_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_basecc_vm_cluster_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_cloud_autonomous_vm_cluster_compartment(change_cloud_autonomous_vm_cluster_compartment_details, cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see change_autonomous_vm_cluster_compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
1511
 
# File 'lib/oci/database/database_client.rb', line 1472

def change_cloud_autonomous_vm_cluster_compartment(change_cloud_autonomous_vm_cluster_compartment_details, cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_autonomous_vm_cluster_compartment.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/changeCompartment'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_autonomous_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_autonomous_vm_cluster_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_cloud_autonomous_vm_cluster_subscription(change_cloud_autonomous_vm_cluster_subscription_details, cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Associate a Cloud Autonomous VM cluster with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
1578
1579
1580
1581
 
# File 'lib/oci/database/database_client.rb', line 1542

def change_cloud_autonomous_vm_cluster_subscription(change_cloud_autonomous_vm_cluster_subscription_details, cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_autonomous_vm_cluster_subscription.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/changeSubscription'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_autonomous_vm_cluster_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_autonomous_vm_cluster_subscription') 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_cloud_db_system_subscription(change_cloud_db_system_subscription_details, db_system_id, opts = {}) ⇒ Response

Note:

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

Associate a cloud DB system with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
1648
1649
1650
1651
 
# File 'lib/oci/database/database_client.rb', line 1612

def change_cloud_db_system_subscription(change_cloud_db_system_subscription_details, db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_db_system_subscription.' if logger

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

  path = '/dbSystems/{dbSystemId}/actions/changeSubscription'.sub('{dbSystemId}', db_system_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_db_system_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_db_system_subscription') 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_cloud_exadata_infrastructure_compartment(change_cloud_exadata_infrastructure_compartment_details, cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see Moving Database Resources to a Different Compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/oci/database/database_client.rb', line 1682

def change_cloud_exadata_infrastructure_compartment(change_cloud_exadata_infrastructure_compartment_details, cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_exadata_infrastructure_compartment.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeCompartment'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_exadata_infrastructure_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_exadata_infrastructure_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_cloud_exadata_infrastructure_subscription(change_cloud_exadata_infrastructure_subscription_details, cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Associate a cloud Exadata infrastructure with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'lib/oci/database/database_client.rb', line 1752

def change_cloud_exadata_infrastructure_subscription(change_cloud_exadata_infrastructure_subscription_details, cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_exadata_infrastructure_subscription.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeSubscription'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_exadata_infrastructure_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_exadata_infrastructure_subscription') 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_cloud_vm_cluster_compartment(change_cloud_vm_cluster_compartment_details, cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'lib/oci/database/database_client.rb', line 1822

def change_cloud_vm_cluster_compartment(change_cloud_vm_cluster_compartment_details, cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_vm_cluster_compartment.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/changeCompartment'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_vm_cluster_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_cloud_vm_cluster_subscription(change_cloud_vm_cluster_subscription_details, cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Associate a cloud VM cluster with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/oci/database/database_client.rb', line 1892

def change_cloud_vm_cluster_subscription(change_cloud_vm_cluster_subscription_details, cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_cloud_vm_cluster_subscription.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/changeSubscription'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cloud_vm_cluster_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_cloud_vm_cluster_subscription') 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_database_software_image_compartment(change_compartment_details, database_software_image_id, opts = {}) ⇒ Response

Note:

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

Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move Database Software Image to a different compartment

  • database_software_image_id (String) —

    The DB system 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/oci/database/database_client.rb', line 1964

def change_database_software_image_compartment(change_compartment_details, database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_database_software_image_compartment.' if logger

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

  path = '/databaseSoftwareImages/{databaseSoftwareImageId}/actions/changeCompartment'.sub('{databaseSoftwareImageId}', database_software_image_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_database_software_image_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_dataguard_role(change_dataguard_role_details, autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the #convert_standby_autonomous_container_database convert_standby_autonomous_container_database} operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby. For more information about changing ACD Role, see {Convert Physical Standby to Snapshot Standby and Convert Snapshot Standby to Physical Standby.

Parameters:

  • change_dataguard_role_details (OCI::Database::Models::ChangeDataguardRoleDetails) —

    Request to Change the Autonomous Container Database Dataguard role.

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :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:



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/oci/database/database_client.rb', line 2036

def change_dataguard_role(change_dataguard_role_details, autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_dataguard_role.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeDataguardRole'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_dataguard_role_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_dataguard_role') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_db_system_compartment(change_compartment_details, db_system_id, opts = {}) ⇒ Response

Note:

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

Moves the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see Moving Database Resources to a Different Compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2114
2115
2116
2117
2118
2119
2120
2121
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
 
# File 'lib/oci/database/database_client.rb', line 2114

def change_db_system_compartment(change_compartment_details, db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_db_system_compartment.' if logger

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

  path = '/dbSystems/{dbSystemId}/actions/changeCompartment'.sub('{dbSystemId}', db_system_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_db_system_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_disaster_recovery_configuration(autonomous_database_id, change_disaster_recovery_configuration_details, opts = {}) ⇒ Response

Note:

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

This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side.

Parameters:

  • autonomous_database_id (String) —

    The database OCID.

  • change_disaster_recovery_configuration_details (OCI::Database::Models::ChangeDisasterRecoveryConfigurationDetails) —

    Request to update the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database.

  • 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
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
 
# File 'lib/oci/database/database_client.rb', line 2180

def change_disaster_recovery_configuration(autonomous_database_id, change_disaster_recovery_configuration_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_disaster_recovery_configuration.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/changeDisasterRecoveryConfiguration'.sub('{autonomousDatabaseId}', autonomous_database_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_disaster_recovery_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_disaster_recovery_configuration') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_encryption_key_location(database_id, encryption_key_location_details, opts = {}) ⇒ Response

Note:

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

Update the encryption key management location for the database

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
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
 
# File 'lib/oci/database/database_client.rb', line 2249

def change_encryption_key_location(database_id, encryption_key_location_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_encryption_key_location.' if logger

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

  path = '/databases/{databaseId}/actions/changeEncryptionKeyLocation'.sub('{databaseId}', database_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-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(encryption_key_location_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_encryption_key_location') 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_exadata_infrastructure_compartment(change_exadata_infrastructure_compartment_details, exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service infrastructure resource to another compartment, use the change_cloud_exadata_infrastructure_compartment operation.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
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
 
# File 'lib/oci/database/database_client.rb', line 2320

def change_exadata_infrastructure_compartment(change_exadata_infrastructure_compartment_details, exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_exadata_infrastructure_compartment.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/actions/changeCompartment'.sub('{exadataInfrastructureId}', exadata_infrastructure_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_exadata_infrastructure_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_exadata_infrastructure_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_exadb_vm_cluster_compartment(change_exadb_vm_cluster_compartment_details, exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.

Parameters:

  • change_exadb_vm_cluster_compartment_details (OCI::Database::Models::ChangeExadbVmClusterCompartmentDetails) —

    Request to move Exadata VM cluster on Exascale Infrastructure to a different compartment

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2390
2391
2392
2393
2394
2395
2396
2397
2398
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
 
# File 'lib/oci/database/database_client.rb', line 2390

def change_exadb_vm_cluster_compartment(change_exadb_vm_cluster_compartment_details, exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_exadb_vm_cluster_compartment.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/changeCompartment'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_exadb_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_exadb_vm_cluster_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_exadb_vm_cluster_subscription(change_exadb_vm_cluster_subscription_details, exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription.

Parameters:

  • change_exadb_vm_cluster_subscription_details (OCI::Database::Models::ChangeExadbVmClusterSubscriptionDetails) —

    Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription.

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2460
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
2499
 
# File 'lib/oci/database/database_client.rb', line 2460

def change_exadb_vm_cluster_subscription(change_exadb_vm_cluster_subscription_details, exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_exadb_vm_cluster_subscription.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/changeSubscription'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_exadb_vm_cluster_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_exadb_vm_cluster_subscription') 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_exascale_db_storage_vault_compartment(change_exascale_db_storage_vault_compartment_details, exascale_db_storage_vault_id, opts = {}) ⇒ Response

Note:

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

Moves a Exadata Database Storage Vault to another compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
2565
2566
2567
2568
2569
 
# File 'lib/oci/database/database_client.rb', line 2530

def change_exascale_db_storage_vault_compartment(change_exascale_db_storage_vault_compartment_details, exascale_db_storage_vault_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_exascale_db_storage_vault_compartment.' if logger

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

  path = '/exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeCompartment'.sub('{exascaleDbStorageVaultId}', exascale_db_storage_vault_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_exascale_db_storage_vault_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_exascale_db_storage_vault_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_exascale_db_storage_vault_subscription(change_exascale_db_storage_vault_subscription_details, exascale_db_storage_vault_id, opts = {}) ⇒ Response

Note:

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

Associate a Exadata Database Storage Vault with a different subscription.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
2631
2632
2633
2634
2635
2636
2637
2638
2639
 
# File 'lib/oci/database/database_client.rb', line 2600

def change_exascale_db_storage_vault_subscription(change_exascale_db_storage_vault_subscription_details, exascale_db_storage_vault_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_exascale_db_storage_vault_subscription.' if logger

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

  path = '/exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeSubscription'.sub('{exascaleDbStorageVaultId}', exascale_db_storage_vault_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_exascale_db_storage_vault_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_exascale_db_storage_vault_subscription') 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_external_container_database_compartment(change_compartment_details, external_container_database_id, opts = {}) ⇒ Response

Note:

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

Move the #create_external_container_database_details create_external_container_database_details} and its dependent resources to the specified compartment. For more information about moving external container databases, see {Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move the external container database to a different compartment.

  • external_container_database_id (String) —

    The ExternalContainerDatabase 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
 
# File 'lib/oci/database/database_client.rb', line 2673

def change_external_container_database_compartment(change_compartment_details, external_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_external_container_database_compartment.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/changeCompartment'.sub('{externalContainerDatabaseId}', external_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_external_container_database_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_external_non_container_database_compartment(change_compartment_details, external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Move the external non-container database and its dependent resources to the specified compartment. For more information about moving external non-container databases, see Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move the external non-container database to a different compartment.

  • external_non_container_database_id (String) —

    The external non-container database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
 
# File 'lib/oci/database/database_client.rb', line 2745

def change_external_non_container_database_compartment(change_compartment_details, external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_external_non_container_database_compartment.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/changeCompartment'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_external_non_container_database_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_external_pluggable_database_compartment(change_compartment_details, external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Move the #create_external_pluggable_database_details create_external_pluggable_database_details} and its dependent resources to the specified compartment. For more information about moving external pluggable databases, see {Moving Database Resources to a Different Compartment.

Parameters:

  • change_compartment_details (OCI::Database::Models::ChangeCompartmentDetails) —

    Request to move the create_external_pluggable_database_details resource to a different compartment.

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
 
# File 'lib/oci/database/database_client.rb', line 2821

def change_external_pluggable_database_compartment(change_compartment_details, external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_external_pluggable_database_compartment.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/changeCompartment'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_external_pluggable_database_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_key_store_compartment(change_key_store_compartment_details, key_store_id, opts = {}) ⇒ Response

Note:

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

Move the key store resource to the specified compartment. For more information about moving key stores, see Moving Database Resources to a Different Compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/oci/database/database_client.rb', line 2894

def change_key_store_compartment(change_key_store_compartment_details, key_store_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_key_store_compartment.' if logger

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

  path = '/keyStores/{keyStoreId}/actions/changeCompartment'.sub('{keyStoreId}', key_store_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_key_store_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_key_store_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_key_store_type(database_id, change_key_store_type_details, opts = {}) ⇒ Response

Note:

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

Changes encryption key management type

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/oci/database/database_client.rb', line 2963

def change_key_store_type(database_id, change_key_store_type_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_key_store_type.' if logger

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

  path = '/databases/{databaseId}/actions/changeKeyStoreType'.sub('{databaseId}', database_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-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(change_key_store_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_key_store_type') 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_oneoff_patch_compartment(change_compartment_details, oneoff_patch_id, opts = {}) ⇒ Response

Note:

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

Move the one-off patch to the specified compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
 
# File 'lib/oci/database/database_client.rb', line 3033

def change_oneoff_patch_compartment(change_compartment_details, oneoff_patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_oneoff_patch_compartment.' if logger

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

  path = '/oneoffPatches/{oneoffPatchId}/actions/changeCompartment'.sub('{oneoffPatchId}', oneoff_patch_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_oneoff_patch_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_scheduling_plan_compartment(change_scheduling_plan_compartment_details, scheduling_plan_id, opts = {}) ⇒ Response

Note:

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

Moves an scheduling plan resource to another compartment.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
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
 
# File 'lib/oci/database/database_client.rb', line 3103

def change_scheduling_plan_compartment(change_scheduling_plan_compartment_details, scheduling_plan_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_scheduling_plan_compartment.' if logger

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

  path = '/schedulingPlans/{schedulingPlanId}/actions/changeCompartment'.sub('{schedulingPlanId}', scheduling_plan_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]
  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(change_scheduling_plan_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_scheduling_plan_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_scheduling_policy_compartment(change_scheduling_policy_compartment_details, scheduling_policy_id, opts = {}) ⇒ Response

Note:

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

Moves an scheduling policy resource to another compartment.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



3173
3174
3175
3176
3177
3178
3179
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
 
# File 'lib/oci/database/database_client.rb', line 3173

def change_scheduling_policy_compartment(change_scheduling_policy_compartment_details, scheduling_policy_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_scheduling_policy_compartment.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}/actions/changeCompartment'.sub('{schedulingPolicyId}', scheduling_policy_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]
  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(change_scheduling_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_scheduling_policy_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_vm_cluster_compartment(change_vm_cluster_compartment_details, vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the change_cloud_vm_cluster_compartment operation.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
3281
3282
3283
 
# File 'lib/oci/database/database_client.rb', line 3244

def change_vm_cluster_compartment(change_vm_cluster_compartment_details, vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#change_vm_cluster_compartment.' if logger

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

  path = '/vmClusters/{vmClusterId}/actions/changeCompartment'.sub('{vmClusterId}', vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_vm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#change_vm_cluster_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

#check_external_database_connector_connection_status(external_database_connector_id, opts = {}) ⇒ Response

Note:

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

Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.

Parameters:

  • external_database_connector_id (String) —

    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'lib/oci/database/database_client.rb', line 3316

def check_external_database_connector_connection_status(external_database_connector_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#check_external_database_connector_connection_status.' if logger

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

  path = '/externaldatabaseconnectors/{externalDatabaseConnectorId}/actions/checkConnectionStatus'.sub('{externalDatabaseConnectorId}', external_database_connector_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#check_external_database_connector_connection_status') 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

#complete_external_backup_job(backup_id, complete_external_backup_job_details, opts = {}) ⇒ Response

Note:

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

Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

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_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 may be rejected).

Returns:



3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
 
# File 'lib/oci/database/database_client.rb', line 3385

def complete_external_backup_job(backup_id, complete_external_backup_job_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#complete_external_backup_job.' if logger

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

  path = '/externalBackupJobs/{backupId}/actions/complete'.sub('{backupId}', backup_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-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(complete_external_backup_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#complete_external_backup_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::Database::Models::ExternalBackupJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#configure_autonomous_database_vault_key(autonomous_database_id, configure_autonomous_database_vault_key_details, opts = {}) ⇒ Response

Note:

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

Configures the Autonomous AI Database Vault service key.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
 
# File 'lib/oci/database/database_client.rb', line 3458

def configure_autonomous_database_vault_key(autonomous_database_id, configure_autonomous_database_vault_key_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#configure_autonomous_database_vault_key.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/configureAutonomousDatabaseVaultKey'.sub('{autonomousDatabaseId}', autonomous_database_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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(configure_autonomous_database_vault_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#configure_autonomous_database_vault_key') 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

#configure_exascale_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, configure_exascale_cloud_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Configures Exascale on Cloud exadata infrastructure resource. Applies to Exadata Cloud Service instances only.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
 
# File 'lib/oci/database/database_client.rb', line 3529

def configure_exascale_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, configure_exascale_cloud_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#configure_exascale_cloud_exadata_infrastructure.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/configureExascale'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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]
  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(configure_exascale_cloud_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#configure_exascale_cloud_exadata_infrastructure') 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::Database::Models::CloudExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#configure_exascale_exadata_infrastructure(exadata_infrastructure_id, configure_exascale_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Configures Exascale on Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
 
# File 'lib/oci/database/database_client.rb', line 3600

def configure_exascale_exadata_infrastructure(exadata_infrastructure_id, configure_exascale_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#configure_exascale_exadata_infrastructure.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/actions/configureExascale'.sub('{exadataInfrastructureId}', exadata_infrastructure_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]
  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(configure_exascale_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#configure_exascale_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#configure_saas_admin_user(autonomous_database_id, configure_saas_admin_user_details, opts = {}) ⇒ Response

Note:

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

This operation updates SaaS administrative user configuration of the Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database OCID.

  • configure_saas_admin_user_details (OCI::Database::Models::ConfigureSaasAdminUserDetails) —

    Request to update SaaS administrative user configuration of the Autonomous AI Database.

  • 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
 
# File 'lib/oci/database/database_client.rb', line 3667

def configure_saas_admin_user(autonomous_database_id, configure_saas_admin_user_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#configure_saas_admin_user.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/configureSaasAdminUser'.sub('{autonomousDatabaseId}', autonomous_database_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(configure_saas_admin_user_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#configure_saas_admin_user') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#confirm_key_store_details_are_correct(key_store_id, opts = {}) ⇒ Response

Note:

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

This is for user to confirm to DBaaS that the Oracle Key Valut (OKV) connection IPs, username and password are all correct. This operation will put the Key Store back into Active state. If details are incorrect, your OKV account may get locked after some unsuccessful attempts to connect.

Parameters:

  • key_store_id (String) —

    The OCID of the key store.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
 
# File 'lib/oci/database/database_client.rb', line 3737

def confirm_key_store_details_are_correct(key_store_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#confirm_key_store_details_are_correct.' if logger

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

  path = '/keyStores/{keyStoreId}/actions/confirmDetailsAreCorrect'.sub('{keyStoreId}', key_store_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#confirm_key_store_details_are_correct') 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

#convert_standby_autonomous_container_database(convert_standby_autonomous_container_database_details, autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see Convert Physical Standby to Snapshot Standby and Convert Snapshot Standby to Physical Standby.

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.

  • :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 may be rejected).

  • :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:



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'lib/oci/database/database_client.rb', line 3807

def convert_standby_autonomous_container_database(convert_standby_autonomous_container_database_details, autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#convert_standby_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/snapshotStandby'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(convert_standby_autonomous_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#convert_standby_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#convert_standby_database_type(database_id, convert_standby_database_type_details, opts = {}) ⇒ Response

Note:

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

Performs transition from standby database into a snapshot standby and vice versa. The transition performed based on the current role of the database, if the current role is standby then this operation will convert it to snapshot standby and if the current role is snapshot standby then this operation will convert it to standby.

This operation should be performed on respective standby/snapshot standby database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
 
# File 'lib/oci/database/database_client.rb', line 3881

def convert_standby_database_type(database_id, convert_standby_database_type_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#convert_standby_database_type.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/convertStandbyDatabaseType'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(convert_standby_database_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#convert_standby_database_type') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#convert_to_pdb(database_id, convert_to_pdb_details, opts = {}) ⇒ Response

Note:

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

Converts a non-container database to a pluggable database.

Parameters:

  • database_id (String) —

    The database OCID.

  • convert_to_pdb_details (OCI::Database::Models::ConvertToPdbDetails) —

    Request to convert a non-container database to a pluggable database.

  • 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) —

    Unique identifier for the request.

Returns:



3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
 
# File 'lib/oci/database/database_client.rb', line 3947

def convert_to_pdb(database_id, convert_to_pdb_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#convert_to_pdb.' if logger

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

  path = '/databases/{databaseId}/actions/convertToPdb'.sub('{databaseId}', database_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(convert_to_pdb_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#convert_to_pdb') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#convert_to_regular_pluggable_database(convert_to_regular_pluggable_database_details, pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Converts a Refreshable clone to Regular pluggable database (PDB). Pluggable Database will be in READ_WRITE openmode after conversion.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



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
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
 
# File 'lib/oci/database/database_client.rb', line 4017

def convert_to_regular_pluggable_database(convert_to_regular_pluggable_database_details, pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#convert_to_regular_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/convertToRegular'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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(convert_to_regular_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#convert_to_regular_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#convert_to_standalone(database_id, convert_to_standalone_details, opts = {}) ⇒ Response

Note:

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

Disassociate the standby database identified by the databaseId parameter from existing Data Guard group.

Convert the standby to a standalone database.

This operation should be performed on respective standby database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
 
# File 'lib/oci/database/database_client.rb', line 4092

def convert_to_standalone(database_id, convert_to_standalone_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#convert_to_standalone.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/convertToStandalone'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(convert_to_standalone_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#convert_to_standalone') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_advanced_cluster_file_system(create_advanced_cluster_file_system_details, opts = {}) ⇒ Response

Note:

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

Creates an advanced cluster file system 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
 
# File 'lib/oci/database/database_client.rb', line 4158

def create_advanced_cluster_file_system(create_advanced_cluster_file_system_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_advanced_cluster_file_system.' if logger

  raise "Missing the required parameter 'create_advanced_cluster_file_system_details' when calling create_advanced_cluster_file_system." if create_advanced_cluster_file_system_details.nil?

  path = '/advancedClusterFileSystems'
  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_advanced_cluster_file_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_advanced_cluster_file_system') 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::Database::Models::AdvancedClusterFileSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_application_vip(create_application_vip_details, opts = {}) ⇒ Response

Note:

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

Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
 
# File 'lib/oci/database/database_client.rb', line 4221

def create_application_vip(create_application_vip_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_application_vip.' if logger

  raise "Missing the required parameter 'create_application_vip_details' when calling create_application_vip." if create_application_vip_details.nil?

  path = '/applicationVip'
  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_application_vip_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_application_vip') 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::Database::Models::ApplicationVip'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_container_database(create_autonomous_container_database_details, opts = {}) ⇒ Response

Note:

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

Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.

Parameters:

  • create_autonomous_container_database_details (OCI::Database::Models::CreateAutonomousContainerDatabaseBase) —

    Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure or in Autonomous VM Cluster.

  • 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 may be rejected).

Returns:



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
 
# File 'lib/oci/database/database_client.rb', line 4282

def create_autonomous_container_database(create_autonomous_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_container_database.' if logger

  raise "Missing the required parameter 'create_autonomous_container_database_details' when calling create_autonomous_container_database." if create_autonomous_container_database_details.nil?

  path = '/autonomousContainerDatabases'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_autonomous_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_container_database_dataguard_association(autonomous_container_database_id, create_autonomous_container_database_dataguard_association_details, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the #add_standby_autonomous_container_database add_standby_autonomous_container_database} operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the specified Autonomous Container database and a peer Autonomous Container database. For more information, see {Using Oracle Data Guard.

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 may be rejected).

Returns:



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
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
 
# File 'lib/oci/database/database_client.rb', line 4344

def create_autonomous_container_database_dataguard_association(autonomous_container_database_id, create_autonomous_container_database_dataguard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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-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_autonomous_container_database_dataguard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_database(create_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Creates a new Autonomous AI Database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
4446
4447
4448
4449
 
# File 'lib/oci/database/database_client.rb', line 4411

def create_autonomous_database(create_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_database.' if logger

  raise "Missing the required parameter 'create_autonomous_database_details' when calling create_autonomous_database." if create_autonomous_database_details.nil?

  path = '/autonomousDatabases'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_autonomous_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_database_backup(create_autonomous_database_backup_details, opts = {}) ⇒ Response

Note:

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

Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
 
# File 'lib/oci/database/database_client.rb', line 4478

def create_autonomous_database_backup(create_autonomous_database_backup_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_database_backup.' if logger

  raise "Missing the required parameter 'create_autonomous_database_backup_details' when calling create_autonomous_database_backup." if create_autonomous_database_backup_details.nil?

  path = '/autonomousDatabaseBackups'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_autonomous_database_backup_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_database_backup') 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::Database::Models::AutonomousDatabaseBackup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_database_software_image(create_autonomous_database_software_image_details, opts = {}) ⇒ Response

Note:

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

create Autonomous AI Database Software Image in the specified compartment.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4542
4543
4544
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
 
# File 'lib/oci/database/database_client.rb', line 4542

def create_autonomous_database_software_image(create_autonomous_database_software_image_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_database_software_image.' if logger

  raise "Missing the required parameter 'create_autonomous_database_software_image_details' when calling create_autonomous_database_software_image." if create_autonomous_database_software_image_details.nil?

  path = '/autonomousDatabaseSoftwareImages'
  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_autonomous_database_software_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_database_software_image') 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::Database::Models::AutonomousDatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_autonomous_vm_cluster(create_autonomous_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see create_cloud_autonomous_vm_cluster.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
 
# File 'lib/oci/database/database_client.rb', line 4605

def create_autonomous_vm_cluster(create_autonomous_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_autonomous_vm_cluster.' if logger

  raise "Missing the required parameter 'create_autonomous_vm_cluster_details' when calling create_autonomous_vm_cluster." if create_autonomous_vm_cluster_details.nil?

  path = '/autonomousVmClusters'
  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_autonomous_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_autonomous_vm_cluster') 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::Database::Models::AutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_backup(create_backup_details, opts = {}) ⇒ Response

Note:

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

Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

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 may be rejected).

Returns:



4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
 
# File 'lib/oci/database/database_client.rb', line 4666

def create_backup(create_backup_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_backup.' if logger

  raise "Missing the required parameter 'create_backup_details' when calling create_backup." if create_backup_details.nil?

  path = '/backups'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_backup_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_backup') 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::Database::Models::Backup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_backup_destination(create_backup_destination_details, opts = {}) ⇒ Response

Note:

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

Creates a backup destination in an Exadata Cloud@Customer system.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
 
# File 'lib/oci/database/database_client.rb', line 4729

def create_backup_destination(create_backup_destination_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_backup_destination.' if logger

  raise "Missing the required parameter 'create_backup_destination_details' when calling create_backup_destination." if create_backup_destination_details.nil?

  path = '/backupDestinations'
  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_backup_destination_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_backup_destination') 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::Database::Models::BackupDestination'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_basecc_vm_cluster(create_basecc_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates a BaseDB-C@C VM cluster.

Parameters:

  • create_basecc_vm_cluster_details (OCI::Database::Models::CreateBaseccVmClusterDetails) —

    Request to create a BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4823
4824
4825
4826
4827
4828
4829
4830
 
# File 'lib/oci/database/database_client.rb', line 4793

def create_basecc_vm_cluster(create_basecc_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_basecc_vm_cluster.' if logger

  raise "Missing the required parameter 'create_basecc_vm_cluster_details' when calling create_basecc_vm_cluster." if create_basecc_vm_cluster_details.nil?

  path = '/baseccVmClusters'
  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_basecc_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_basecc_vm_cluster') 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::Database::Models::BaseccVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_autonomous_vm_cluster(create_cloud_autonomous_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see create_autonomous_vm_cluster.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
4894
4895
4896
4897
 
# File 'lib/oci/database/database_client.rb', line 4859

def create_cloud_autonomous_vm_cluster(create_cloud_autonomous_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_cloud_autonomous_vm_cluster.' if logger

  raise "Missing the required parameter 'create_cloud_autonomous_vm_cluster_details' when calling create_cloud_autonomous_vm_cluster." if create_cloud_autonomous_vm_cluster_details.nil?

  path = '/cloudAutonomousVmClusters'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cloud_autonomous_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_cloud_autonomous_vm_cluster') 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::Database::Models::CloudAutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_exadata_infrastructure(create_cloud_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Creates a cloud Exadata infrastructure resource. This resource is used to create either an Exadata Cloud Service instance or an Autonomous AI Database on dedicated Exadata infrastructure.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
4965
 
# File 'lib/oci/database/database_client.rb', line 4927

def create_cloud_exadata_infrastructure(create_cloud_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_cloud_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'create_cloud_exadata_infrastructure_details' when calling create_cloud_exadata_infrastructure." if create_cloud_exadata_infrastructure_details.nil?

  path = '/cloudExadataInfrastructures'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cloud_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_cloud_exadata_infrastructure') 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::Database::Models::CloudExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_vm_cluster(create_cloud_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates a cloud VM cluster.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



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
 
# File 'lib/oci/database/database_client.rb', line 4995

def create_cloud_vm_cluster(create_cloud_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_cloud_vm_cluster.' if logger

  raise "Missing the required parameter 'create_cloud_vm_cluster_details' when calling create_cloud_vm_cluster." if create_cloud_vm_cluster_details.nil?

  path = '/cloudVmClusters'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cloud_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_cloud_vm_cluster') 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::Database::Models::CloudVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_console_connection(create_console_connection_details, db_node_id, opts = {}) ⇒ Response

Note:

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

Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.

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 may be rejected).

Returns:



5060
5061
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
 
# File 'lib/oci/database/database_client.rb', line 5060

def create_console_connection(create_console_connection_details, db_node_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_console_connection.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleConnections'.sub('{dbNodeId}', db_node_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-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_console_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_console_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::Database::Models::ConsoleConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_console_history(create_console_history_details, db_node_id, opts = {}) ⇒ Response

Note:

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

Captures the most recent serial console data (up to a megabyte) for the specified database node.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
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
 
# File 'lib/oci/database/database_client.rb', line 5126

def create_console_history(create_console_history_details, db_node_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_console_history.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleHistories'.sub('{dbNodeId}', db_node_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-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_console_history_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_console_history') 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::Database::Models::ConsoleHistory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_data_guard_association(database_id, create_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard.

All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

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 may be rejected).

Returns:



5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
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
 
# File 'lib/oci/database/database_client.rb', line 5197

def create_data_guard_association(database_id, create_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations'.sub('{databaseId}', database_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-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_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database(create_new_database_details, opts = {}) ⇒ Response

Note:

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

Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



5264
5265
5266
5267
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
 
# File 'lib/oci/database/database_client.rb', line 5264

def create_database(create_new_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_database.' if logger

  raise "Missing the required parameter 'create_new_database_details' when calling create_database." if create_new_database_details.nil?

  path = '/databases'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_new_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_database') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_software_image(create_database_software_image_details, opts = {}) ⇒ Response

Note:

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

create database software image in the specified compartment.

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 may be rejected).

Returns:



5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
 
# File 'lib/oci/database/database_client.rb', line 5326

def create_database_software_image(create_database_software_image_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_database_software_image.' if logger

  raise "Missing the required parameter 'create_database_software_image_details' when calling create_database_software_image." if create_database_software_image_details.nil?

  path = '/databaseSoftwareImages'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_database_software_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_database_software_image') 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::Database::Models::DatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_db_home(create_db_home_with_db_system_id_details, opts = {}) ⇒ Response

Note:

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

Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.

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 may be rejected).

Returns:



5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
 
# File 'lib/oci/database/database_client.rb', line 5386

def create_db_home(create_db_home_with_db_system_id_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_db_home.' if logger

  raise "Missing the required parameter 'create_db_home_with_db_system_id_details' when calling create_db_home." if create_db_home_with_db_system_id_details.nil?

  path = '/dbHomes'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_db_home_with_db_system_id_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_db_home') 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::Database::Models::DbHome'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_exadata_infrastructure(create_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To create an Exadata Cloud Service infrastructure resource, use the create_cloud_exadata_infrastructure operation.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
 
# File 'lib/oci/database/database_client.rb', line 5449

def create_exadata_infrastructure(create_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'create_exadata_infrastructure_details' when calling create_exadata_infrastructure." if create_exadata_infrastructure_details.nil?

  path = '/exadataInfrastructures'
  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_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_exadb_vm_cluster(create_exadb_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates an Exadata VM cluster on Exascale Infrastructure

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
 
# File 'lib/oci/database/database_client.rb', line 5513

def create_exadb_vm_cluster(create_exadb_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_exadb_vm_cluster.' if logger

  raise "Missing the required parameter 'create_exadb_vm_cluster_details' when calling create_exadb_vm_cluster." if create_exadb_vm_cluster_details.nil?

  path = '/exadbVmClusters'
  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_exadb_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_exadb_vm_cluster') 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::Database::Models::ExadbVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_exascale_db_storage_vault(create_exascale_db_storage_vault_details, opts = {}) ⇒ Response

Note:

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

Creates an Exadata Database Storage Vault

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
5611
5612
5613
5614
 
# File 'lib/oci/database/database_client.rb', line 5577

def create_exascale_db_storage_vault(create_exascale_db_storage_vault_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_exascale_db_storage_vault.' if logger

  raise "Missing the required parameter 'create_exascale_db_storage_vault_details' when calling create_exascale_db_storage_vault." if create_exascale_db_storage_vault_details.nil?

  path = '/exascaleDbStorageVaults'
  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_exascale_db_storage_vault_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_exascale_db_storage_vault') 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::Database::Models::ExascaleDbStorageVault'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_execution_action(create_execution_action_details, opts = {}) ⇒ Response

Note:

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

Creates an execution action 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
 
# File 'lib/oci/database/database_client.rb', line 5640

def create_execution_action(create_execution_action_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_execution_action.' if logger

  raise "Missing the required parameter 'create_execution_action_details' when calling create_execution_action." if create_execution_action_details.nil?

  path = '/executionActions'
  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_execution_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_execution_action') 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::Database::Models::ExecutionAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_execution_window(create_execution_window_details, opts = {}) ⇒ Response

Note:

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

Creates an execution window 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
5739
5740
 
# File 'lib/oci/database/database_client.rb', line 5703

def create_execution_window(create_execution_window_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_execution_window.' if logger

  raise "Missing the required parameter 'create_execution_window_details' when calling create_execution_window." if create_execution_window_details.nil?

  path = '/executionWindows'
  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_execution_window_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_execution_window') 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::Database::Models::ExecutionWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_backup_job(create_external_backup_job_details, opts = {}) ⇒ Response

Note:

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

Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

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 may be rejected).

Returns:



5766
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
 
# File 'lib/oci/database/database_client.rb', line 5766

def create_external_backup_job(create_external_backup_job_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_external_backup_job.' if logger

  raise "Missing the required parameter 'create_external_backup_job_details' when calling create_external_backup_job." if create_external_backup_job_details.nil?

  path = '/externalBackupJobs'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_external_backup_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_external_backup_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::Database::Models::ExternalBackupJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_container_database(create_external_container_database_details, opts = {}) ⇒ Response

Note:

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

Creates a new external container database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
 
# File 'lib/oci/database/database_client.rb', line 5827

def create_external_container_database(create_external_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_external_container_database.' if logger

  raise "Missing the required parameter 'create_external_container_database_details' when calling create_external_container_database." if create_external_container_database_details.nil?

  path = '/externalcontainerdatabases'
  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_external_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_external_container_database') 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::Database::Models::ExternalContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_database_connector(create_external_database_connector_details, opts = {}) ⇒ Response

Note:

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

Creates a new external database connector.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
 
# File 'lib/oci/database/database_client.rb', line 5889

def create_external_database_connector(create_external_database_connector_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_external_database_connector.' if logger

  raise "Missing the required parameter 'create_external_database_connector_details' when calling create_external_database_connector." if create_external_database_connector_details.nil?

  path = '/externaldatabaseconnectors'
  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_external_database_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_external_database_connector') 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::Database::Models::ExternalDatabaseConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_non_container_database(create_external_non_container_database_details, opts = {}) ⇒ Response

Note:

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

Creates a new ExternalNonContainerDatabase 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
 
# File 'lib/oci/database/database_client.rb', line 5952

def create_external_non_container_database(create_external_non_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_external_non_container_database.' if logger

  raise "Missing the required parameter 'create_external_non_container_database_details' when calling create_external_non_container_database." if create_external_non_container_database_details.nil?

  path = '/externalnoncontainerdatabases'
  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_external_non_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_external_non_container_database') 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::Database::Models::ExternalNonContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_external_pluggable_database(create_external_pluggable_database_details, opts = {}) ⇒ Response

Note:

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

Registers a new create_external_pluggable_database_details 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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/database/database_client.rb', line 6016

def create_external_pluggable_database(create_external_pluggable_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_external_pluggable_database.' if logger

  raise "Missing the required parameter 'create_external_pluggable_database_details' when calling create_external_pluggable_database." if create_external_pluggable_database_details.nil?

  path = '/externalpluggabledatabases'
  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_external_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_external_pluggable_database') 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::Database::Models::ExternalPluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_key_store(create_key_store_details, opts = {}) ⇒ Response

Note:

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

Creates a Key Store.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
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
 
# File 'lib/oci/database/database_client.rb', line 6080

def create_key_store(create_key_store_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_key_store.' if logger

  raise "Missing the required parameter 'create_key_store_details' when calling create_key_store." if create_key_store_details.nil?

  path = '/keyStores'
  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_key_store_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_key_store') 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::Database::Models::KeyStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_maintenance_run(create_maintenance_run_details, opts = {}) ⇒ Response

Note:

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

Creates a maintenance run with one of the following: 1. The latest available release update patch (RUP) for the Autonomous Container Database. 2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database. 3. The DST TZ file updates for the Autonomous Container Database.

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.

  • :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 may be rejected).

Returns:



6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
 
# File 'lib/oci/database/database_client.rb', line 6146

def create_maintenance_run(create_maintenance_run_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_maintenance_run.' if logger

  raise "Missing the required parameter 'create_maintenance_run_details' when calling create_maintenance_run." if create_maintenance_run_details.nil?

  path = '/maintenanceRuns'
  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_maintenance_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_maintenance_run') 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::Database::Models::MaintenanceRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_oneoff_patch(create_oneoff_patch_details, opts = {}) ⇒ Response

Note:

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

Creates one-off patch for specified database version to download.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
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
 
# File 'lib/oci/database/database_client.rb', line 6210

def create_oneoff_patch(create_oneoff_patch_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_oneoff_patch.' if logger

  raise "Missing the required parameter 'create_oneoff_patch_details' when calling create_oneoff_patch." if create_oneoff_patch_details.nil?

  path = '/oneoffPatches'
  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_oneoff_patch_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_oneoff_patch') 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::Database::Models::OneoffPatch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_pluggable_database(create_pluggable_database_details, opts = {}) ⇒ Response

Note:

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

Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the start_pluggable_database and stop_pluggable_database APIs to start and stop the pluggable database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
6306
6307
6308
6309
6310
6311
6312
 
# File 'lib/oci/database/database_client.rb', line 6275

def create_pluggable_database(create_pluggable_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_pluggable_database.' if logger

  raise "Missing the required parameter 'create_pluggable_database_details' when calling create_pluggable_database." if create_pluggable_database_details.nil?

  path = '/pluggableDatabases'
  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_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_pluggable_database_snapshot(create_pluggable_database_snapshot_details, opts = {}) ⇒ Response

Note:

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

Creates a Pluggable Database Snapshot

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/database/database_client.rb', line 6339

def create_pluggable_database_snapshot(create_pluggable_database_snapshot_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_pluggable_database_snapshot.' if logger

  raise "Missing the required parameter 'create_pluggable_database_snapshot_details' when calling create_pluggable_database_snapshot." if create_pluggable_database_snapshot_details.nil?

  path = '/pluggableDatabaseSnapshots'
  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_pluggable_database_snapshot_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_pluggable_database_snapshot') 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::Database::Models::PluggableDatabaseSnapshot'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_scheduled_action(create_scheduled_action_details, opts = {}) ⇒ Response

Note:

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

Creates a Scheduled Action 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
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
 
# File 'lib/oci/database/database_client.rb', line 6402

def create_scheduled_action(create_scheduled_action_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_scheduled_action.' if logger

  raise "Missing the required parameter 'create_scheduled_action_details' when calling create_scheduled_action." if create_scheduled_action_details.nil?

  path = '/scheduledActions'
  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_scheduled_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_scheduled_action') 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::Database::Models::ScheduledAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_scheduling_plan(create_scheduling_plan_details, opts = {}) ⇒ Response

Note:

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

Creates a Scheduling Plan 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
 
# File 'lib/oci/database/database_client.rb', line 6465

def create_scheduling_plan(create_scheduling_plan_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_scheduling_plan.' if logger

  raise "Missing the required parameter 'create_scheduling_plan_details' when calling create_scheduling_plan." if create_scheduling_plan_details.nil?

  path = '/schedulingPlans'
  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_scheduling_plan_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_scheduling_plan') 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::Database::Models::SchedulingPlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_scheduling_policy(create_scheduling_policy_details, opts = {}) ⇒ Response

Note:

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

Creates a Scheduling Policy 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/database/database_client.rb', line 6528

def create_scheduling_policy(create_scheduling_policy_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_scheduling_policy.' if logger

  raise "Missing the required parameter 'create_scheduling_policy_details' when calling create_scheduling_policy." if create_scheduling_policy_details.nil?

  path = '/schedulingPolicies'
  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_scheduling_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_scheduling_policy') 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::Database::Models::SchedulingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_scheduling_window(scheduling_policy_id, create_scheduling_window_details, opts = {}) ⇒ Response

Note:

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

Creates a Scheduling Window 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
 
# File 'lib/oci/database/database_client.rb', line 6592

def create_scheduling_window(scheduling_policy_id, create_scheduling_window_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_scheduling_window.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}/schedulingWindows'.sub('{schedulingPolicyId}', scheduling_policy_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-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_scheduling_window_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_scheduling_window') 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::Database::Models::SchedulingWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vm_cluster(create_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates an Exadata Cloud@Customer VM cluster.

Parameters:

  • create_vm_cluster_details (OCI::Database::Models::CreateVmClusterDetails) —

    Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only. See create_cloud_vm_cluster_details for details on creating a cloud VM cluster in an Exadata Cloud Service instance.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/database/database_client.rb', line 6659

def create_vm_cluster(create_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_vm_cluster.' if logger

  raise "Missing the required parameter 'create_vm_cluster_details' when calling create_vm_cluster." if create_vm_cluster_details.nil?

  path = '/vmClusters'
  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_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_vm_cluster') 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::Database::Models::VmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_details, opts = {}) ⇒ Response

Note:

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

Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the create_cloud_vm_cluster operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_details (OCI::Database::Models::VmClusterNetworkDetails) —

    Request to create the Cloud@Customer VM cluster network.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
 
# File 'lib/oci/database/database_client.rb', line 6724

def create_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#create_vm_cluster_network.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks'.sub('{exadataInfrastructureId}', exadata_infrastructure_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-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(vm_cluster_network_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#create_vm_cluster_network') 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::Database::Models::VmClusterNetwork'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#db_node_action(db_node_id, action, opts = {}) ⇒ Response

Note:

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

Performs one of the following power actions on the specified DB node: - start - power on - stop - power off gracefully - forcestop - power off forcefully - forcereset - ACPI shutdown and power on forcefully - softreset - ACPI shutdown and power on - reset - power off and power on

Note: Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata systems - The stop state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system (terminate_db_system) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • action (String) —

    The action to perform on the DB Node. Allowed values are: STOP, FORCESTOP, FORCERESET, START, SOFTRESET, RESET

  • 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 may be rejected).

  • :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:



6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
 
# File 'lib/oci/database/database_client.rb', line 6807

def db_node_action(db_node_id, action, opts = {})
  logger.debug 'Calling operation DatabaseClient#db_node_action.' if logger

  raise "Missing the required parameter 'db_node_id' when calling db_node_action." if db_node_id.nil?
  raise "Missing the required parameter 'action' when calling db_node_action." if action.nil?
  unless %w[STOP FORCESTOP FORCERESET START SOFTRESET RESET].include?(action)
    raise "Invalid value for 'action', must be one of STOP, FORCESTOP, FORCERESET, START, SOFTRESET, RESET."
  end
  raise "Parameter value for 'db_node_id' must not be blank" if OCI::Internal::Util.blank_string?(db_node_id)

  path = '/dbNodes/{dbNodeId}'.sub('{dbNodeId}', db_node_id.to_s)
  operation_signing_strategy = :standard

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

  # 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#db_node_action') 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::Database::Models::DbNode'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {}) ⇒ Response

Note:

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

Deletes the advanced cluster file system.

Parameters:

  • advanced_cluster_file_system_id (String) —

    The advanced cluster file system Id 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 6874

def delete_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_advanced_cluster_file_system.' if logger

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

  path = '/advancedClusterFileSystems/{advancedClusterFileSystemId}'.sub('{advancedClusterFileSystemId}', advanced_cluster_file_system_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: 'DatabaseClient#delete_advanced_cluster_file_system') 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_application_vip(application_vip_id, opts = {}) ⇒ Response

Note:

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

Deletes and deregisters the specified application virtual IP (VIP) address.

Parameters:

  • application_vip_id (String) —

    The OCID of the application virtual IP (VIP) address.

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
 
# File 'lib/oci/database/database_client.rb', line 6934

def delete_application_vip(application_vip_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_application_vip.' if logger

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

  path = '/applicationVip/{applicationVipId}'.sub('{applicationVipId}', application_vip_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: 'DatabaseClient#delete_application_vip') 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_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :must_delete_associated_long_term_backups (BOOLEAN) —

    If set to true, terminating the Autonomous AI Database also deletes its associated long-term backups if the retention lock is not enabled. (default to false)

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 6998

def delete_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:mustDeleteAssociatedLongTermBackups] = opts[:must_delete_associated_long_term_backups] if !opts[:must_delete_associated_long_term_backups].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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_autonomous_database') 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_autonomous_database_backup(autonomous_database_backup_id, opts = {}) ⇒ Response

Note:

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

Deletes a long-term backup. You cannot delete other backups using this API.

Parameters:

  • autonomous_database_backup_id (String) —

    The OCID of the Autonomous AI Database backup.

  • 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
 
# File 'lib/oci/database/database_client.rb', line 7062

def delete_autonomous_database_backup(autonomous_database_backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_autonomous_database_backup.' if logger

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

  path = '/autonomousDatabaseBackups/{autonomousDatabaseBackupId}'.sub('{autonomousDatabaseBackupId}', autonomous_database_backup_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_autonomous_database_backup') 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_autonomous_database_software_image(autonomous_database_software_image_id, opts = {}) ⇒ Response

Note:

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

Delete an Autonomous AI Database Software Image

Parameters:

  • autonomous_database_software_image_id (String) —

    The Autonomous AI Database Software Image 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7122

def delete_autonomous_database_software_image(autonomous_database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_autonomous_database_software_image.' if logger

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

  path = '/autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}'.sub('{autonomousDatabaseSoftwareImageId}', autonomous_database_software_image_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: 'DatabaseClient#delete_autonomous_database_software_image') 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_autonomous_vm_cluster(autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see delete_cloud_autonomous_vm_cluster.

Parameters:

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
 
# File 'lib/oci/database/database_client.rb', line 7182

def delete_autonomous_vm_cluster(autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_autonomous_vm_cluster.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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: 'DatabaseClient#delete_autonomous_vm_cluster') 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_backup(backup_id, opts = {}) ⇒ Response

Note:

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

Deletes a full backup. You cannot delete automatic backups using this API.

Parameters:

  • backup_id (String) —

    The backup 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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7239

def delete_backup(backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_backup.' if logger

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

  path = '/backups/{backupId}'.sub('{backupId}', backup_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_backup') 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_backup_destination(backup_destination_id, opts = {}) ⇒ Response

Note:

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

Deletes a backup destination in an Exadata Cloud@Customer system.

Parameters:

  • backup_destination_id (String) —

    The OCID of the backup destination.

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
 
# File 'lib/oci/database/database_client.rb', line 7298

def delete_backup_destination(backup_destination_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_backup_destination.' if logger

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

  path = '/backupDestinations/{backupDestinationId}'.sub('{backupDestinationId}', backup_destination_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: 'DatabaseClient#delete_backup_destination') 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_basecc_vm_cluster(basecc_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7358

def delete_basecc_vm_cluster(basecc_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_basecc_vm_cluster.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}'.sub('{baseccVmClusterId}', basecc_vm_cluster_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: 'DatabaseClient#delete_basecc_vm_cluster') 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_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see delete_autonomous_vm_cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
 
# File 'lib/oci/database/database_client.rb', line 7418

def delete_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_cloud_autonomous_vm_cluster.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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: 'DatabaseClient#delete_cloud_autonomous_vm_cluster') 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_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_exadata_infrastructure_id (String) —

    The cloud Exadata infrastructure 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.

  • :is_delete_vm_clusters (BOOLEAN) —

    If true, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If false, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is false. (default to false)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7480

def delete_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_cloud_exadata_infrastructure.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isDeleteVmClusters] = opts[:is_delete_vm_clusters] if !opts[:is_delete_vm_clusters].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: 'DatabaseClient#delete_cloud_exadata_infrastructure') 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_cloud_vm_cluster(cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
 
# File 'lib/oci/database/database_client.rb', line 7541

def delete_cloud_vm_cluster(cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_cloud_vm_cluster.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}'.sub('{cloudVmClusterId}', cloud_vm_cluster_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: 'DatabaseClient#delete_cloud_vm_cluster') 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_console_connection(db_node_id, console_connection_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified database node console connection.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_connection_id (String) —

    The OCID of the console 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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7599

def delete_console_connection(db_node_id, console_connection_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_console_connection.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleConnectionId}', console_connection_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_console_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_console_history(db_node_id, console_history_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified database node console history.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_history_id (String) —

    The OCID of the console history.

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
 
# File 'lib/oci/database/database_client.rb', line 7661

def delete_console_history(db_node_id, console_history_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_console_history.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleHistoryId}', console_history_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: 'DatabaseClient#delete_console_history') 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_database(database_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified database. Applies only to Exadata systems.

The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the performFinalBackup parameter to have the Exadata system database backed up before it is deleted.

Parameters:

  • database_id (String) —

    The database 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.

  • :perform_final_backup (BOOLEAN) —

    Whether to perform a final backup of the database or not. Default is false.

    If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it. (default to false)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7731

def delete_database(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_database.' if logger

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

  path = '/databases/{databaseId}'.sub('{databaseId}', database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:performFinalBackup] = opts[:perform_final_backup] if !opts[:perform_final_backup].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: 'DatabaseClient#delete_database') 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_database_software_image(database_software_image_id, opts = {}) ⇒ Response

Note:

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

Delete a database software image

Parameters:

  • database_software_image_id (String) —

    The DB system 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.

Returns:

  • (Response) —

    A Response object with data of type nil



7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
 
# File 'lib/oci/database/database_client.rb', line 7789

def delete_database_software_image(database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_database_software_image.' if logger

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

  path = '/databaseSoftwareImages/{databaseSoftwareImageId}'.sub('{databaseSoftwareImageId}', database_software_image_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_database_software_image') 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_db_home(db_home_id, opts = {}) ⇒ Response

Note:

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

Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems.

Oracle recommends that you use the performFinalBackup parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the performFinalBackup parameter to back up data.

Parameters:

  • db_home_id (String) —

    The Database Home 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.

  • :perform_final_backup (BOOLEAN) —

    Whether to perform a final backup of the database or not. Default is false.

    If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7854

def delete_db_home(db_home_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_db_home.' if logger

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

  path = '/dbHomes/{dbHomeId}'.sub('{dbHomeId}', db_home_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:performFinalBackup] = opts[:perform_final_backup] if !opts[:perform_final_backup].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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_db_home') 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_dbnode_snapshot(dbnode_snapshot_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Exadata Database Node Snapshot.

Parameters:

  • dbnode_snapshot_id (String) —

    The Exadata Database Node Snapshot 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
 
# File 'lib/oci/database/database_client.rb', line 7914

def delete_dbnode_snapshot(dbnode_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_dbnode_snapshot.' if logger

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

  path = '/dbnodeSnapshots/{dbnodeSnapshotId}'.sub('{dbnodeSnapshotId}', dbnode_snapshot_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: 'DatabaseClient#delete_dbnode_snapshot') 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_exadata_infrastructure(exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deletes the Exadata Cloud@Customer infrastructure.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 7974

def delete_exadata_infrastructure(exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_exadata_infrastructure.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_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: 'DatabaseClient#delete_exadata_infrastructure') 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_exadb_vm_cluster(exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
 
# File 'lib/oci/database/database_client.rb', line 8034

def delete_exadb_vm_cluster(exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_exadb_vm_cluster.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}'.sub('{exadbVmClusterId}', exadb_vm_cluster_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: 'DatabaseClient#delete_exadb_vm_cluster') 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_exascale_db_storage_vault(exascale_db_storage_vault_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Exadata Database Storage Vault.

Parameters:

  • exascale_db_storage_vault_id (String) —

    The Exadata Database Storage Vault 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8094

def delete_exascale_db_storage_vault(exascale_db_storage_vault_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_exascale_db_storage_vault.' if logger

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

  path = '/exascaleDbStorageVaults/{exascaleDbStorageVaultId}'.sub('{exascaleDbStorageVaultId}', exascale_db_storage_vault_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: 'DatabaseClient#delete_exascale_db_storage_vault') 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_execution_action(execution_action_id, opts = {}) ⇒ Response

Note:

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

Deletes the execution action.

Parameters:

  • execution_action_id (String) —

    The execution action 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
 
# File 'lib/oci/database/database_client.rb', line 8154

def delete_execution_action(execution_action_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_execution_action.' if logger

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

  path = '/executionActions/{executionActionId}'.sub('{executionActionId}', execution_action_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: 'DatabaseClient#delete_execution_action') 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_execution_window(execution_window_id, opts = {}) ⇒ Response

Note:

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

Deletes the execution window.

Parameters:

  • execution_window_id (String) —

    The execution window 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8214

def delete_execution_window(execution_window_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_execution_window.' if logger

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

  path = '/executionWindows/{executionWindowId}'.sub('{executionWindowId}', execution_window_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: 'DatabaseClient#delete_execution_window') 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_external_container_database(external_container_database_id, opts = {}) ⇒ Response

Note:

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

Deletes the create_external_container_database_details resource. Any external pluggable databases registered under this container database must be deleted in your Oracle Cloud Infrastructure tenancy prior to this operation.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase 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) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
 
# File 'lib/oci/database/database_client.rb', line 8276

def delete_external_container_database(external_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_external_container_database.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}'.sub('{externalContainerDatabaseId}', external_container_database_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_external_container_database') 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_external_database_connector(external_database_connector_id, opts = {}) ⇒ Response

Note:

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

Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.

Parameters:

  • external_database_connector_id (String) —

    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
8371
8372
8373
8374
8375
8376
 
# File 'lib/oci/database/database_client.rb', line 8340

def delete_external_database_connector(external_database_connector_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_external_database_connector.' if logger

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

  path = '/externaldatabaseconnectors/{externalDatabaseConnectorId}'.sub('{externalDatabaseConnectorId}', external_database_connector_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: 'DatabaseClient#delete_external_database_connector') 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_external_non_container_database(external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.

Parameters:

  • external_non_container_database_id (String) —

    The external non-container database 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8400
8401
8402
8403
8404
8405
8406
8407
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
 
# File 'lib/oci/database/database_client.rb', line 8400

def delete_external_non_container_database(external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_external_non_container_database.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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: 'DatabaseClient#delete_external_non_container_database') 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_external_pluggable_database(external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Deletes the create_external_pluggable_database_details. resource.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
 
# File 'lib/oci/database/database_client.rb', line 8461

def delete_external_pluggable_database(external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_external_pluggable_database.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_external_pluggable_database') 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_key_store(key_store_id, opts = {}) ⇒ Response

Note:

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

Deletes a key store.

Parameters:

  • key_store_id (String) —

    The OCID of the key store.

  • 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8521

def delete_key_store(key_store_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_key_store.' if logger

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

  path = '/keyStores/{keyStoreId}'.sub('{keyStoreId}', key_store_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: 'DatabaseClient#delete_key_store') 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_oneoff_patch(oneoff_patch_id, opts = {}) ⇒ Response

Note:

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

Deletes a one-off patch.

Parameters:

  • oneoff_patch_id (String) —

    The one-off patch 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) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
 
# File 'lib/oci/database/database_client.rb', line 8581

def delete_oneoff_patch(oneoff_patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_oneoff_patch.' if logger

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

  path = '/oneoffPatches/{oneoffPatchId}'.sub('{oneoffPatchId}', oneoff_patch_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#delete_oneoff_patch') 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_pluggable_database(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified pluggable database.

Parameters:

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8640

def delete_pluggable_database(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}'.sub('{pluggableDatabaseId}', pluggable_database_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: 'DatabaseClient#delete_pluggable_database') 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_pluggable_database_snapshot(pluggable_database_snapshot_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Exadata Pluggable Database Snapshot.

Parameters:

  • pluggable_database_snapshot_id (String) —

    The Exadata Pluggable Database Snapshot 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
 
# File 'lib/oci/database/database_client.rb', line 8700

def delete_pluggable_database_snapshot(pluggable_database_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_pluggable_database_snapshot.' if logger

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

  path = '/pluggableDatabaseSnapshots/{pluggableDatabaseSnapshotId}'.sub('{pluggableDatabaseSnapshotId}', pluggable_database_snapshot_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: 'DatabaseClient#delete_pluggable_database_snapshot') 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_scheduled_action(scheduled_action_id, opts = {}) ⇒ Response

Note:

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

Deletes the scheduled action.

Parameters:

  • scheduled_action_id (String) —

    The Scheduled Action 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8760

def delete_scheduled_action(scheduled_action_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_scheduled_action.' if logger

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

  path = '/scheduledActions/{scheduledActionId}'.sub('{scheduledActionId}', scheduled_action_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: 'DatabaseClient#delete_scheduled_action') 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_scheduling_plan(scheduling_plan_id, opts = {}) ⇒ Response

Note:

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

Deletes the scheduling plan.

Parameters:

  • scheduling_plan_id (String) —

    The Schedule Plan 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
 
# File 'lib/oci/database/database_client.rb', line 8820

def delete_scheduling_plan(scheduling_plan_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_scheduling_plan.' if logger

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

  path = '/schedulingPlans/{schedulingPlanId}'.sub('{schedulingPlanId}', scheduling_plan_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: 'DatabaseClient#delete_scheduling_plan') 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_scheduling_policy(scheduling_policy_id, opts = {}) ⇒ Response

Note:

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

Deletes the scheduling policy.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 8880

def delete_scheduling_policy(scheduling_policy_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_scheduling_policy.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}'.sub('{schedulingPolicyId}', scheduling_policy_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: 'DatabaseClient#delete_scheduling_policy') 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_scheduling_window(scheduling_policy_id, scheduling_window_id, opts = {}) ⇒ Response

Note:

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

Deletes the scheduling window.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy OCID.

  • scheduling_window_id (String) —

    The Scheduling Window 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
 
# File 'lib/oci/database/database_client.rb', line 8941

def delete_scheduling_window(scheduling_policy_id, scheduling_window_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_scheduling_window.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}/schedulingWindows/{schedulingWindowId}'.sub('{schedulingPolicyId}', scheduling_policy_id.to_s).sub('{schedulingWindowId}', scheduling_window_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: 'DatabaseClient#delete_scheduling_window') 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_vm_cluster(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
9036
9037
9038
9039
 
# File 'lib/oci/database/database_client.rb', line 9003

def delete_vm_cluster(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_vm_cluster.' if logger

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

  path = '/vmClusters/{vmClusterId}'.sub('{vmClusterId}', vm_cluster_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: 'DatabaseClient#delete_vm_cluster') 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_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the delete_cloud_vm_cluster operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network 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) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



9065
9066
9067
9068
9069
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
 
# File 'lib/oci/database/database_client.rb', line 9065

def delete_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#delete_vm_cluster_network.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_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: 'DatabaseClient#delete_vm_cluster_network') 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

#deregister_autonomous_database_data_safe(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Asynchronously deregisters this Autonomous AI Database with Data Safe.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

  • :deregister_autonomous_database_data_safe_details (OCI::Database::Models::DeregisterAutonomousDatabaseDataSafeDetails) —

    Details for deregistering an Autonomous AI Database with Data Safe.

Returns:

  • (Response) —

    A Response object with data of type nil



9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
 
# File 'lib/oci/database/database_client.rb', line 9127

def deregister_autonomous_database_data_safe(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#deregister_autonomous_database_data_safe.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/deregisterDataSafe'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(opts[:deregister_autonomous_database_data_safe_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#deregister_autonomous_database_data_safe') 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

#disable_autonomous_database_management(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Disables Database Management for the Autonomous AI Database resource.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
9215
9216
9217
9218
9219
9220
9221
9222
 
# File 'lib/oci/database/database_client.rb', line 9186

def disable_autonomous_database_management(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_autonomous_database_management.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#disable_autonomous_database_management') 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

#disable_autonomous_database_operations_insights(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Disables Operations Insights for the Autonomous AI Database resource.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 9245

def disable_autonomous_database_operations_insights(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_autonomous_database_operations_insights.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/disableOperationsInsights'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#disable_autonomous_database_operations_insights') 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

#disable_database_management(database_id, opts = {}) ⇒ Response

Note:

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

Disables the Database Management service for the database.

Parameters:

  • database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



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
9348
9349
9350
 
# File 'lib/oci/database/database_client.rb', line 9311

def disable_database_management(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_database_management.' if logger

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

  path = '/databases/{databaseId}/actions/disableDatabaseManagement'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_database_management') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#disable_external_container_database_database_management(external_container_database_id, opts = {}) ⇒ Response

Note:

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

Disable Database Management service for the external container database.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 9380

def disable_external_container_database_database_management(external_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_container_database_database_management.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableDatabaseManagement'.sub('{externalContainerDatabaseId}', external_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_container_database_database_management') 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

#disable_external_container_database_stack_monitoring(external_container_database_id, opts = {}) ⇒ Response

Note:

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

Disable Stack Monitoring for the external container database.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 9448

def disable_external_container_database_stack_monitoring(external_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_container_database_stack_monitoring.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableStackMonitoring'.sub('{externalContainerDatabaseId}', external_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_container_database_stack_monitoring') 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

#disable_external_non_container_database_database_management(external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.

Parameters:

  • external_non_container_database_id (String) —

    The external non-container database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
9555
9556
 
# File 'lib/oci/database/database_client.rb', line 9518

def disable_external_non_container_database_database_management(external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_non_container_database_database_management.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableDatabaseManagement'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_non_container_database_database_management') 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

#disable_external_non_container_database_operations_insights(external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Disable Operations Insights for the external non-container database.

Parameters:

  • external_non_container_database_id (String) —

    The external non-container database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/database/database_client.rb', line 9586

def disable_external_non_container_database_operations_insights(external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_non_container_database_operations_insights.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableOperationsInsights'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_non_container_database_operations_insights') 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

#disable_external_non_container_database_stack_monitoring(external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Disable Stack Monitoring for the external non-container database.

Parameters:

  • external_non_container_database_id (String) —

    The external non-container database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



9654
9655
9656
9657
9658
9659
9660
9661
9662
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
 
# File 'lib/oci/database/database_client.rb', line 9654

def disable_external_non_container_database_stack_monitoring(external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_non_container_database_stack_monitoring.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableStackMonitoring'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_non_container_database_stack_monitoring') 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

#disable_external_pluggable_database_database_management(external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



9724
9725
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
 
# File 'lib/oci/database/database_client.rb', line 9724

def disable_external_pluggable_database_database_management(external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_pluggable_database_database_management.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableDatabaseManagement'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_pluggable_database_database_management') 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

#disable_external_pluggable_database_operations_insights(external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Disable Operations Insights for the external pluggable database.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



9792
9793
9794
9795
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
 
# File 'lib/oci/database/database_client.rb', line 9792

def disable_external_pluggable_database_operations_insights(external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_pluggable_database_operations_insights.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableOperationsInsights'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_pluggable_database_operations_insights') 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

#disable_external_pluggable_database_stack_monitoring(external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Disable Stack Monitoring for the external pluggable database.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



9860
9861
9862
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
 
# File 'lib/oci/database/database_client.rb', line 9860

def disable_external_pluggable_database_stack_monitoring(external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_external_pluggable_database_stack_monitoring.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableStackMonitoring'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_external_pluggable_database_stack_monitoring') 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

#disable_pluggable_database_management(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Disables the Database Management service for the pluggable database.

Parameters:

  • pluggable_database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



9928
9929
9930
9931
9932
9933
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
 
# File 'lib/oci/database/database_client.rb', line 9928

def disable_pluggable_database_management(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#disable_pluggable_database_management.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/disablePluggableDatabaseManagement'.sub('{pluggableDatabaseId}', pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#disable_pluggable_database_management') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#download_db_connection_bundle(db_connection_bundle_id, download_db_connection_bundle_details, opts = {}, &block) ⇒ Response

Note:

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

Downloads the specified database connection bundle content. The bundle is returned as a binary file containing the connection details.

Parameters:

  • db_connection_bundle_id (String) —

    The OCID of the database connection bundle.

  • download_db_connection_bundle_details (OCI::Database::Models::DownloadDbConnectionBundleDetails) —

    Request to download a database connection bundle.

  • 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) —

    Unique identifier for the request.

  • :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 may 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



10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
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
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
 
# File 'lib/oci/database/database_client.rb', line 10001

def download_db_connection_bundle(db_connection_bundle_id, download_db_connection_bundle_details, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#download_db_connection_bundle.' if logger

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

  path = '/dbConnectionBundles/{dbConnectionBundleId}/actions/download'.sub('{dbConnectionBundleId}', db_connection_bundle_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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[:'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(download_db_connection_bundle_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#download_db_connection_bundle') 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

#download_exadata_infrastructure_config_file(exadata_infrastructure_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • 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) —

    Unique identifier for the request.

  • :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 may 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



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
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
 
# File 'lib/oci/database/database_client.rb', line 10113

def download_exadata_infrastructure_config_file(exadata_infrastructure_id, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#download_exadata_infrastructure_config_file.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/actions/downloadConfigFile'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#download_exadata_infrastructure_config_file') 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

#download_oneoff_patch(oneoff_patch_id, opts = {}) ⇒ Response

Note:

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

Download one-off patch.

Parameters:

  • oneoff_patch_id (String) —

    The one-off patch 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
 
# File 'lib/oci/database/database_client.rb', line 10225

def download_oneoff_patch(oneoff_patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#download_oneoff_patch.' if logger

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

  path = '/oneoffPatches/{oneoffPatchId}/actions/downloadOneoffPatch'.sub('{oneoffPatchId}', oneoff_patch_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#download_oneoff_patch') 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::Database::Models::DownloadOneoffPatch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#download_validation_report(exadata_infrastructure_id, vm_cluster_network_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network OCID.

  • 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) —

    Unique identifier for the request.

  • :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 may 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



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
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
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
 
# File 'lib/oci/database/database_client.rb', line 10293

def download_validation_report(exadata_infrastructure_id, vm_cluster_network_id, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#download_validation_report.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/downloadValidationReport'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#download_validation_report') 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

#download_vm_cluster_network_config_file(exadata_infrastructure_id, vm_cluster_network_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network OCID.

  • 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) —

    Unique identifier for the request.

  • :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 may 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



10406
10407
10408
10409
10410
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
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
 
# File 'lib/oci/database/database_client.rb', line 10406

def download_vm_cluster_network_config_file(exadata_infrastructure_id, vm_cluster_network_id, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#download_vm_cluster_network_config_file.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/downloadConfigFile'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#download_vm_cluster_network_config_file') 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

#edit_autonomous_container_database_dataguard(edit_autonomous_container_database_dataguard_details, autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see Update Autonomous Container Database Dataguard.

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.

  • :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 may be rejected).

  • :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:



10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
 
# File 'lib/oci/database/database_client.rb', line 10522

def edit_autonomous_container_database_dataguard(edit_autonomous_container_database_dataguard_details, autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#edit_autonomous_container_database_dataguard.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/editDataguard'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(edit_autonomous_container_database_dataguard_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#edit_autonomous_container_database_dataguard') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_autonomous_database_management(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Enables Database Management for Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
 
# File 'lib/oci/database/database_client.rb', line 10585

def enable_autonomous_database_management(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_autonomous_database_management.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_autonomous_database_management') 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

#enable_autonomous_database_operations_insights(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Enables the specified Autonomous AI Database with Operations Insights.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
 
# File 'lib/oci/database/database_client.rb', line 10644

def enable_autonomous_database_operations_insights(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_autonomous_database_operations_insights.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/enableOperationsInsights'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_autonomous_database_operations_insights') 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

#enable_database_management(database_id, enable_database_management_details, opts = {}) ⇒ Response

Note:

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

Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level.

Parameters:

  • database_id (String) —

    The database OCID.

  • enable_database_management_details (OCI::Database::Models::EnableDatabaseManagementDetails) —

    Request to enable the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
 
# File 'lib/oci/database/database_client.rb', line 10710

def enable_database_management(database_id, enable_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_database_management.' if logger

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

  path = '/databases/{databaseId}/actions/enableDatabaseManagement'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_database_management') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_external_container_database_database_management(external_container_database_id, enable_external_container_database_database_management_details, opts = {}) ⇒ Response

Note:

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

Enables Database Management Service for the external container database. For more information about the Database Management Service, see Database Management Service.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
 
# File 'lib/oci/database/database_client.rb', line 10783

def enable_external_container_database_database_management(external_container_database_id, enable_external_container_database_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_container_database_database_management.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableDatabaseManagement'.sub('{externalContainerDatabaseId}', external_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_container_database_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_container_database_database_management') 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

#enable_external_container_database_stack_monitoring(external_container_database_id, enable_external_container_database_stack_monitoring_details, opts = {}) ⇒ Response

Note:

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

Enable Stack Monitoring for the external container database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
 
# File 'lib/oci/database/database_client.rb', line 10854

def enable_external_container_database_stack_monitoring(external_container_database_id, enable_external_container_database_stack_monitoring_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_container_database_stack_monitoring.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableStackMonitoring'.sub('{externalContainerDatabaseId}', external_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_container_database_stack_monitoring_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_container_database_stack_monitoring') 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

#enable_external_non_container_database_database_management(external_non_container_database_id, enable_external_non_container_database_database_management_details, opts = {}) ⇒ Response

Note:

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

Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
 
# File 'lib/oci/database/database_client.rb', line 10926

def enable_external_non_container_database_database_management(external_non_container_database_id, enable_external_non_container_database_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_non_container_database_database_management.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableDatabaseManagement'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_non_container_database_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_non_container_database_database_management') 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

#enable_external_non_container_database_operations_insights(external_non_container_database_id, enable_external_non_container_database_operations_insights_details, opts = {}) ⇒ Response

Note:

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

Enable Operations Insights for the external non-container database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
 
# File 'lib/oci/database/database_client.rb', line 10997

def enable_external_non_container_database_operations_insights(external_non_container_database_id, enable_external_non_container_database_operations_insights_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_non_container_database_operations_insights.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableOperationsInsights'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_non_container_database_operations_insights_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_non_container_database_operations_insights') 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

#enable_external_non_container_database_stack_monitoring(external_non_container_database_id, enable_external_non_container_database_stack_monitoring_details, opts = {}) ⇒ Response

Note:

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

Enable Stack Monitoring for the external non-container database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
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
 
# File 'lib/oci/database/database_client.rb', line 11068

def enable_external_non_container_database_stack_monitoring(external_non_container_database_id, enable_external_non_container_database_stack_monitoring_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_non_container_database_stack_monitoring.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableStackMonitoring'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_non_container_database_stack_monitoring_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_non_container_database_stack_monitoring') 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

#enable_external_pluggable_database_database_management(external_pluggable_database_id, enable_external_pluggable_database_database_management_details, opts = {}) ⇒ Response

Note:

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

Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



11140
11141
11142
11143
11144
11145
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
 
# File 'lib/oci/database/database_client.rb', line 11140

def enable_external_pluggable_database_database_management(external_pluggable_database_id, enable_external_pluggable_database_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_pluggable_database_database_management.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableDatabaseManagement'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_pluggable_database_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_pluggable_database_database_management') 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

#enable_external_pluggable_database_operations_insights(external_pluggable_database_id, enable_external_pluggable_database_operations_insights_details, opts = {}) ⇒ Response

Note:

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

Enable Operations Insights for the external pluggable database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



11211
11212
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
 
# File 'lib/oci/database/database_client.rb', line 11211

def enable_external_pluggable_database_operations_insights(external_pluggable_database_id, enable_external_pluggable_database_operations_insights_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_pluggable_database_operations_insights.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableOperationsInsights'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_pluggable_database_operations_insights_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_pluggable_database_operations_insights') 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

#enable_external_pluggable_database_stack_monitoring(external_pluggable_database_id, enable_external_pluggable_database_stack_monitoring_details, opts = {}) ⇒ Response

Note:

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

Enable Stack Monitoring for the external pluggable database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



11282
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
 
# File 'lib/oci/database/database_client.rb', line 11282

def enable_external_pluggable_database_stack_monitoring(external_pluggable_database_id, enable_external_pluggable_database_stack_monitoring_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_external_pluggable_database_stack_monitoring.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableStackMonitoring'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_external_pluggable_database_stack_monitoring_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_external_pluggable_database_stack_monitoring') 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

#enable_pluggable_database_management(pluggable_database_id, enable_pluggable_database_management_details, opts = {}) ⇒ Response

Note:

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

Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.

Parameters:

  • pluggable_database_id (String) —

    The database OCID.

  • enable_pluggable_database_management_details (OCI::Database::Models::EnablePluggableDatabaseManagementDetails) —

    Request to enable the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



11351
11352
11353
11354
11355
11356
11357
11358
11359
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
 
# File 'lib/oci/database/database_client.rb', line 11351

def enable_pluggable_database_management(pluggable_database_id, enable_pluggable_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#enable_pluggable_database_management.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/enablePluggableDatabaseManagement'.sub('{pluggableDatabaseId}', pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(enable_pluggable_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#enable_pluggable_database_management') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#execute_db_system_os_patch(execute_db_system_os_patch_details, db_system_id, opts = {}) ⇒ Response

Note:

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

Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



11422
11423
11424
11425
11426
11427
11428
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
 
# File 'lib/oci/database/database_client.rb', line 11422

def execute_db_system_os_patch(execute_db_system_os_patch_details, db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#execute_db_system_os_patch.' if logger

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

  path = '/dbSystems/{dbSystemId}/actions/osPatch'.sub('{dbSystemId}', db_system_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(execute_db_system_os_patch_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#execute_db_system_os_patch') 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

#fail_over_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional: - peerDbId Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the failover will happen in the same region.

Parameters:

  • autonomous_database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :peer_db_id (String) —

    The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



11500
11501
11502
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
 
# File 'lib/oci/database/database_client.rb', line 11500

def fail_over_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#fail_over_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/failover'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:peerDbId] = opts[:peer_db_id] if opts[:peer_db_id]

  # 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-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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # 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: 'DatabaseClient#fail_over_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#failover_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see Fail Over to the Standby in an Autonomous Data Guard Configuration.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

Returns:



11566
11567
11568
11569
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
 
# File 'lib/oci/database/database_client.rb', line 11566

def failover_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#failover_autonomous_container_database_dataguard.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/failover'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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: 'DatabaseClient#failover_autonomous_container_database_dataguard') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#failover_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the failover_autonomous_container_database_dataguard operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable.

A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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.

Returns:



11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
 
# File 'lib/oci/database/database_client.rb', line 11628

def failover_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#failover_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/failover'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#failover_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#failover_data_guard(database_id, failover_data_guard_details, opts = {}) ⇒ Response

Note:

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

Performs a failover to transition the standby database identified by the databaseId path parameter into the primary role after the existing primary database fails or becomes unreachable.

A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

This operation should be performed on respective standby database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
 
# File 'lib/oci/database/database_client.rb', line 11703

def failover_data_guard(database_id, failover_data_guard_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#failover_data_guard.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/failover'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(failover_data_guard_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#failover_data_guard') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#failover_data_guard_association(database_id, data_guard_association_id, failover_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association's primary role after the existing primary database fails or becomes unreachable.

A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

Parameters:

  • database_id (String) —

    The database OCID.

  • data_guard_association_id (String) —

    The Data Guard association's OCID.

  • failover_data_guard_association_details (OCI::Database::Models::FailoverDataGuardAssociationDetails) —

    A request to perform a failover, transitioning a standby database into a primary database.

  • 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.

Returns:



11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
 
# File 'lib/oci/database/database_client.rb', line 11771

def failover_data_guard_association(database_id, data_guard_association_id, failover_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#failover_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/failover'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(failover_data_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#failover_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_autonomous_database_wallet(autonomous_database_id, generate_autonomous_database_wallet_details, opts = {}, &block) ⇒ Response

Note:

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

Creates and downloads a wallet for the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database OCID.

  • generate_autonomous_database_wallet_details (OCI::Database::Models::GenerateAutonomousDatabaseWalletDetails) —

    Request to create a new Autonomous AI Database wallet.

  • 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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

  • :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



11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
 
# File 'lib/oci/database/database_client.rb', line 11842

def generate_autonomous_database_wallet(autonomous_database_id, generate_autonomous_database_wallet_details, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#generate_autonomous_database_wallet.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/generateWallet'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_autonomous_database_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#generate_autonomous_database_wallet') 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

#generate_recommended_vm_cluster_network(exadata_infrastructure_id, generate_recommended_network_details, opts = {}) ⇒ Response

Note:

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

Generates a recommended Cloud@Customer VM cluster network configuration.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • generate_recommended_network_details (OCI::Database::Models::GenerateRecommendedNetworkDetails) —

    Request to generate a recommended Cloud@Customer VM cluster network configuration.

  • 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.

  • :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 may be rejected).

Returns:



11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
 
# File 'lib/oci/database/database_client.rb', line 11953

def generate_recommended_vm_cluster_network(exadata_infrastructure_id, generate_recommended_network_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#generate_recommended_vm_cluster_network.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/actions/generateRecommendedNetwork'.sub('{exadataInfrastructureId}', exadata_infrastructure_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(generate_recommended_network_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#generate_recommended_vm_cluster_network') 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::Database::Models::VmClusterNetworkDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified advanced cluster file systems.

Parameters:

  • advanced_cluster_file_system_id (String) —

    The advanced cluster file system Id 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) —

    Unique identifier for the request.

Returns:



12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
 
# File 'lib/oci/database/database_client.rb', line 12012

def get_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_advanced_cluster_file_system.' if logger

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

  path = '/advancedClusterFileSystems/{advancedClusterFileSystemId}'.sub('{advancedClusterFileSystemId}', advanced_cluster_file_system_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: 'DatabaseClient#get_advanced_cluster_file_system') 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::Database::Models::AdvancedClusterFileSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_application_vip(application_vip_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified application virtual IP (VIP) address.

Parameters:

  • application_vip_id (String) —

    The OCID of the application virtual IP (VIP) address.

  • 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.

Returns:



12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
 
# File 'lib/oci/database/database_client.rb', line 12067

def get_application_vip(application_vip_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_application_vip.' if logger

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

  path = '/applicationVip/{applicationVipId}'.sub('{applicationVipId}', application_vip_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: 'DatabaseClient#get_application_vip') 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::Database::Models::ApplicationVip'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_container_database(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Autonomous Container Database.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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

Returns:



12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
 
# File 'lib/oci/database/database_client.rb', line 12121

def get_autonomous_container_database(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the get_autonomous_container_database operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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

Returns:



12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
 
# File 'lib/oci/database/database_client.rb', line 12177

def get_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_container_database_resource_usage(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Get resource usage details for the specified Autonomous Container Database.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

Returns:



12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
 
# File 'lib/oci/database/database_client.rb', line 12235

def get_autonomous_container_database_resource_usage(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_container_database_resource_usage.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/resourceUsage'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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: 'DatabaseClient#get_autonomous_container_database_resource_usage') 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::Database::Models::AutonomousContainerDatabaseResourceUsage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

Returns:



12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
 
# File 'lib/oci/database/database_client.rb', line 12291

def get_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}'.sub('{autonomousDatabaseId}', autonomous_database_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: 'DatabaseClient#get_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database_backup(autonomous_database_backup_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Autonomous AI Database backup.

Parameters:

  • autonomous_database_backup_id (String) —

    The OCID of the Autonomous AI Database backup.

  • 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.

Returns:



12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
 
# File 'lib/oci/database/database_client.rb', line 12346

def get_autonomous_database_backup(autonomous_database_backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database_backup.' if logger

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

  path = '/autonomousDatabaseBackups/{autonomousDatabaseBackupId}'.sub('{autonomousDatabaseBackupId}', autonomous_database_backup_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: 'DatabaseClient#get_autonomous_database_backup') 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::Database::Models::AutonomousDatabaseBackup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database_dataguard_association(autonomous_database_id, autonomous_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the get_autonomous_container_database operation to gets an Autonomous Data Guard-enabled database associated with the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database OCID.

  • autonomous_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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) —

    Unique identifier for the request.

Returns:



12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
 
# File 'lib/oci/database/database_client.rb', line 12403

def get_autonomous_database_dataguard_association(autonomous_database_id, autonomous_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database_dataguard_association.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations/{autonomousDatabaseDataguardAssociationId}'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s).sub('{autonomousDatabaseDataguardAssociationId}', autonomous_database_dataguard_association_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: 'DatabaseClient#get_autonomous_database_dataguard_association') 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::Database::Models::AutonomousDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database_regional_wallet(opts = {}) ⇒ Response

Note:

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

Gets the Autonomous AI Database regional wallet details.

Parameters:

  • 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.

Returns:



12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
 
# File 'lib/oci/database/database_client.rb', line 12460

def get_autonomous_database_regional_wallet(opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database_regional_wallet.' if logger


  path = '/autonomousDatabases/wallet'
  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: 'DatabaseClient#get_autonomous_database_regional_wallet') 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::Database::Models::AutonomousDatabaseWallet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database_software_image(autonomous_database_software_image_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Autonomous AI Database Software Image.

Parameters:

  • autonomous_database_software_image_id (String) —

    The Autonomous AI Database Software Image 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) —

    Unique identifier for the request.

Returns:



12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
 
# File 'lib/oci/database/database_client.rb', line 12513

def get_autonomous_database_software_image(autonomous_database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database_software_image.' if logger

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

  path = '/autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}'.sub('{autonomousDatabaseSoftwareImageId}', autonomous_database_software_image_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: 'DatabaseClient#get_autonomous_database_software_image') 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::Database::Models::AutonomousDatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_database_wallet(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Gets the wallet details for the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

Returns:



12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
 
# File 'lib/oci/database/database_client.rb', line 12569

def get_autonomous_database_wallet(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_database_wallet.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/wallet'.sub('{autonomousDatabaseId}', autonomous_database_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: 'DatabaseClient#get_autonomous_database_wallet') 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::Database::Models::AutonomousDatabaseWallet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the get_cloud_exadata_infrastructure operation to get details of an Exadata Infrastructure resource and the get_cloud_autonomous_vm_cluster operation to get details of an Autonomous Exadata VM cluster.

Parameters:

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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

Returns:



12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
 
# File 'lib/oci/database/database_client.rb', line 12624

def get_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_exadata_infrastructure.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_autonomous_exadata_infrastructure') 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::Database::Models::AutonomousExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_patch(autonomous_patch_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specific autonomous patch.

Parameters:

  • autonomous_patch_id (String) —

    The autonomous patch 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

Returns:



12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
 
# File 'lib/oci/database/database_client.rb', line 12678

def get_autonomous_patch(autonomous_patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_patch.' if logger

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

  path = '/autonomousPatches/{autonomousPatchId}'.sub('{autonomousPatchId}', autonomous_patch_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_autonomous_patch') 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::Database::Models::AutonomousPatch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_virtual_machine(autonomous_virtual_machine_id, opts = {}) ⇒ Response

Note:

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

Gets the details of specific Autonomous Virtual Machine.

Parameters:

  • autonomous_virtual_machine_id (String) —

    The Autonomous Virtual machine 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) —

    Unique identifier for the request.

Returns:



12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
 
# File 'lib/oci/database/database_client.rb', line 12734

def get_autonomous_virtual_machine(autonomous_virtual_machine_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_virtual_machine.' if logger

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

  path = '/autonomousVirtualMachines/{autonomousVirtualMachineId}'.sub('{autonomousVirtualMachineId}', autonomous_virtual_machine_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: 'DatabaseClient#get_autonomous_virtual_machine') 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::Database::Models::AutonomousVirtualMachine'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_vm_cluster(autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see get_cloud_autonomous_vm_cluster.

Parameters:

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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) —

    Unique identifier for the request.

Returns:



12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
 
# File 'lib/oci/database/database_client.rb', line 12790

def get_autonomous_vm_cluster(autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_vm_cluster.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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: 'DatabaseClient#get_autonomous_vm_cluster') 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::Database::Models::AutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_autonomous_vm_cluster_resource_usage(autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Get the resource usage details for the specified Autonomous Exadata VM cluster.

Parameters:

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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) —

    Unique identifier for the request.

Returns:



12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
 
# File 'lib/oci/database/database_client.rb', line 12846

def get_autonomous_vm_cluster_resource_usage(autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_autonomous_vm_cluster_resource_usage.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/resourceUsage'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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: 'DatabaseClient#get_autonomous_vm_cluster_resource_usage') 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::Database::Models::AutonomousVmClusterResourceUsage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backup(backup_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified backup.

Parameters:

  • backup_id (String) —

    The backup 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

Returns:



12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
 
# File 'lib/oci/database/database_client.rb', line 12900

def get_backup(backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_backup.' if logger

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

  path = '/backups/{backupId}'.sub('{backupId}', backup_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_backup') 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::Database::Models::Backup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backup_destination(backup_destination_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified backup destination in an Exadata Cloud@Customer system.

Parameters:

  • backup_destination_id (String) —

    The OCID of the backup destination.

  • 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.

Returns:



12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
 
# File 'lib/oci/database/database_client.rb', line 12956

def get_backup_destination(backup_destination_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_backup_destination.' if logger

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

  path = '/backupDestinations/{backupDestinationId}'.sub('{backupDestinationId}', backup_destination_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: 'DatabaseClient#get_backup_destination') 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::Database::Models::BackupDestination'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_basecc_vm_cluster(basecc_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster 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) —

    Unique identifier for the request.

Returns:



13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
 
# File 'lib/oci/database/database_client.rb', line 13012

def get_basecc_vm_cluster(basecc_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_basecc_vm_cluster.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}'.sub('{baseccVmClusterId}', basecc_vm_cluster_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: 'DatabaseClient#get_basecc_vm_cluster') 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::Database::Models::BaseccVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_basecc_vm_cluster_update(basecc_vm_cluster_id, update_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified maintenance update package for a BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster OCID.

  • update_id (String) —

    The OCID of the maintenance update.

  • 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.

Returns:



13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
 
# File 'lib/oci/database/database_client.rb', line 13069

def get_basecc_vm_cluster_update(basecc_vm_cluster_id, update_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_basecc_vm_cluster_update.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}/updates/{updateId}'.sub('{baseccVmClusterId}', basecc_vm_cluster_id.to_s).sub('{updateId}', update_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: 'DatabaseClient#get_basecc_vm_cluster_update') 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::Database::Models::BaseccVmClusterUpdate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_basecc_vm_cluster_update_history_entry(basecc_vm_cluster_id, update_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the maintenance update history details for the specified update history entry. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster OCID.

  • update_history_entry_id (String) —

    The OCID of the maintenance update history entry.

  • 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.

Returns:



13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
 
# File 'lib/oci/database/database_client.rb', line 13128

def get_basecc_vm_cluster_update_history_entry(basecc_vm_cluster_id, update_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_basecc_vm_cluster_update_history_entry.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}'.sub('{baseccVmClusterId}', basecc_vm_cluster_id.to_s).sub('{updateHistoryEntryId}', update_history_entry_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: 'DatabaseClient#get_basecc_vm_cluster_update_history_entry') 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::Database::Models::BaseccVmClusterUpdateHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see get_autonomous_vm_cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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) —

    Unique identifier for the request.

Returns:



13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
 
# File 'lib/oci/database/database_client.rb', line 13186

def get_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_autonomous_vm_cluster.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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: 'DatabaseClient#get_cloud_autonomous_vm_cluster') 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::Database::Models::CloudAutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_autonomous_vm_cluster_resource_usage(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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) —

    Unique identifier for the request.

Returns:



13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
 
# File 'lib/oci/database/database_client.rb', line 13242

def get_cloud_autonomous_vm_cluster_resource_usage(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_autonomous_vm_cluster_resource_usage.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/resourceUsage'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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: 'DatabaseClient#get_cloud_autonomous_vm_cluster_resource_usage') 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::Database::Models::CloudAutonomousVmClusterResourceUsage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_exadata_infrastructure_id (String) —

    The cloud Exadata infrastructure 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) —

    Unique identifier for the request.

Returns:



13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
 
# File 'lib/oci/database/database_client.rb', line 13298

def get_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_exadata_infrastructure.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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: 'DatabaseClient#get_cloud_exadata_infrastructure') 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::Database::Models::CloudExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_exadata_infrastructure_unallocated_resources(cloud_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets unallocated resources information for the specified Cloud Exadata infrastructure.

Parameters:

  • cloud_exadata_infrastructure_id (String) —

    The cloud Exadata infrastructure 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) —

    Unique identifier for the request.

  • :db_servers (Array<String>) —

    The list of OCIDs of the Db servers.

Returns:



13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
 
# File 'lib/oci/database/database_client.rb', line 13355

def get_cloud_exadata_infrastructure_unallocated_resources(cloud_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_exadata_infrastructure_unallocated_resources.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/unAllocatedResources'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:dbServers] = OCI::ApiClient.build_collection_params(opts[:db_servers], :multi) if opts[:db_servers] && !opts[:db_servers].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: 'DatabaseClient#get_cloud_exadata_infrastructure_unallocated_resources') 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::Database::Models::CloudExadataInfrastructureUnallocatedResources'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_vm_cluster(cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster 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) —

    Unique identifier for the request.

Returns:



13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
 
# File 'lib/oci/database/database_client.rb', line 13412

def get_cloud_vm_cluster(cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_vm_cluster.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}'.sub('{cloudVmClusterId}', cloud_vm_cluster_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: 'DatabaseClient#get_cloud_vm_cluster') 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::Database::Models::CloudVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_vm_cluster_iorm_config(cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster 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) —

    Unique identifier for the request.

Returns:



13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
 
# File 'lib/oci/database/database_client.rb', line 13469

def get_cloud_vm_cluster_iorm_config(cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_vm_cluster_iorm_config.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/CloudVmClusterIormConfig'.sub('{cloudVmClusterId}', cloud_vm_cluster_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: 'DatabaseClient#get_cloud_vm_cluster_iorm_config') 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::Database::Models::ExadataIormConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_vm_cluster_update(cloud_vm_cluster_id, update_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster OCID.

  • update_id (String) —

    The OCID of the maintenance update.

  • 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.

Returns:



13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
 
# File 'lib/oci/database/database_client.rb', line 13526

def get_cloud_vm_cluster_update(cloud_vm_cluster_id, update_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_vm_cluster_update.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/updates/{updateId}'.sub('{cloudVmClusterId}', cloud_vm_cluster_id.to_s).sub('{updateId}', update_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: 'DatabaseClient#get_cloud_vm_cluster_update') 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::Database::Models::Update'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_vm_cluster_update_history_entry(cloud_vm_cluster_id, update_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster OCID.

  • update_history_entry_id (String) —

    The OCID of the maintenance update history entry.

  • 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.

Returns:



13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
 
# File 'lib/oci/database/database_client.rb', line 13585

def get_cloud_vm_cluster_update_history_entry(cloud_vm_cluster_id, update_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_cloud_vm_cluster_update_history_entry.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}'.sub('{cloudVmClusterId}', cloud_vm_cluster_id.to_s).sub('{updateHistoryEntryId}', update_history_entry_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: 'DatabaseClient#get_cloud_vm_cluster_update_history_entry') 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::Database::Models::UpdateHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_console_connection(db_node_id, console_connection_id, opts = {}) ⇒ Response

Note:

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

Gets the specified database node console connection's information.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_connection_id (String) —

    The OCID of the console 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

Returns:



13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
 
# File 'lib/oci/database/database_client.rb', line 13642

def get_console_connection(db_node_id, console_connection_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_console_connection.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleConnectionId}', console_connection_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_console_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::Database::Models::ConsoleConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_console_history(db_node_id, console_history_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified database node console history.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_history_id (String) —

    The OCID of the console history.

  • 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.

Returns:



13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
 
# File 'lib/oci/database/database_client.rb', line 13701

def get_console_history(db_node_id, console_history_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_console_history.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleHistoryId}', console_history_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: 'DatabaseClient#get_console_history') 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::Database::Models::ConsoleHistory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_console_history_content(db_node_id, console_history_id, opts = {}, &block) ⇒ Response

Note:

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

Retrieves the specified database node console history contents upto a megabyte.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_history_id (String) —

    The OCID of the console history.

  • 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) —

    Unique identifier for the request.

  • :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



13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
 
# File 'lib/oci/database/database_client.rb', line 13762

def get_console_history_content(db_node_id, console_history_id, opts = {}, &block)
  logger.debug 'Calling operation DatabaseClient#get_console_history_content.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}/content'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleHistoryId}', console_history_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_console_history_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: '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(
            :GET,
            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(
        :GET,
        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

#get_data_guard_association(database_id, data_guard_association_id, opts = {}) ⇒ Response

Note:

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

Gets the specified Data Guard association's configuration information.

Parameters:

  • database_id (String) —

    The database OCID.

  • data_guard_association_id (String) —

    The Data Guard association'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

Returns:



13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
 
# File 'lib/oci/database/database_client.rb', line 13864

def get_data_guard_association(database_id, data_guard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database(database_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified database.

Parameters:

  • database_id (String) —

    The database 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

Returns:



13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
 
# File 'lib/oci/database/database_client.rb', line 13920

def get_database(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_database.' if logger

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

  path = '/databases/{databaseId}'.sub('{databaseId}', database_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_database') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_software_image(database_software_image_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified database software image.

Parameters:

  • database_software_image_id (String) —

    The DB system 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

Returns:



13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
 
# File 'lib/oci/database/database_client.rb', line 13974

def get_database_software_image(database_software_image_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_database_software_image.' if logger

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

  path = '/databaseSoftwareImages/{databaseSoftwareImageId}'.sub('{databaseSoftwareImageId}', database_software_image_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_database_software_image') 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::Database::Models::DatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_upgrade_history_entry(database_id, upgrade_history_entry_id, opts = {}) ⇒ Response

Note:

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

gets the upgrade history for a specified database.

Parameters:

  • database_id (String) —

    The database OCID.

  • upgrade_history_entry_id (String) —

    The database/db system upgrade History 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) —

    Unique identifier for the request.

Returns:



14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
 
# File 'lib/oci/database/database_client.rb', line 14031

def get_database_upgrade_history_entry(database_id, upgrade_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_database_upgrade_history_entry.' if logger

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

  path = '/databases/{databaseId}/upgradeHistoryEntries/{upgradeHistoryEntryId}'.sub('{databaseId}', database_id.to_s).sub('{upgradeHistoryEntryId}', upgrade_history_entry_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: 'DatabaseClient#get_database_upgrade_history_entry') 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::Database::Models::DatabaseUpgradeHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_connection_bundle(db_connection_bundle_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified database connection bundle.

Parameters:

  • db_connection_bundle_id (String) —

    The OCID of the database connection bundle.

  • 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.

Returns:



14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
 
# File 'lib/oci/database/database_client.rb', line 14088

def get_db_connection_bundle(db_connection_bundle_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_connection_bundle.' if logger

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

  path = '/dbConnectionBundles/{dbConnectionBundleId}'.sub('{dbConnectionBundleId}', db_connection_bundle_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: 'DatabaseClient#get_db_connection_bundle') 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::Database::Models::DbConnectionBundle'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_home(db_home_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Database Home.

Parameters:

  • db_home_id (String) —

    The Database Home 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

Returns:



14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
 
# File 'lib/oci/database/database_client.rb', line 14142

def get_db_home(db_home_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_home.' if logger

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

  path = '/dbHomes/{dbHomeId}'.sub('{dbHomeId}', db_home_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_home') 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::Database::Models::DbHome'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_home_patch(db_home_id, patch_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified patch package.

Parameters:

  • db_home_id (String) —

    The Database Home OCID.

  • patch_id (String) —

    The OCID of the patch.

  • 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

Returns:



14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
 
# File 'lib/oci/database/database_client.rb', line 14198

def get_db_home_patch(db_home_id, patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_home_patch.' if logger

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

  path = '/dbHomes/{dbHomeId}/patches/{patchId}'.sub('{dbHomeId}', db_home_id.to_s).sub('{patchId}', patch_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_home_patch') 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::Database::Models::Patch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_home_patch_history_entry(db_home_id, patch_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the patch history details for the specified patchHistoryEntryId

Parameters:

  • db_home_id (String) —

    The Database Home OCID.

  • patch_history_entry_id (String) —

    The OCID of the patch history entry.

  • 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

Returns:



14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
 
# File 'lib/oci/database/database_client.rb', line 14256

def get_db_home_patch_history_entry(db_home_id, patch_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_home_patch_history_entry.' if logger

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

  path = '/dbHomes/{dbHomeId}/patchHistoryEntries/{patchHistoryEntryId}'.sub('{dbHomeId}', db_home_id.to_s).sub('{patchHistoryEntryId}', patch_history_entry_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_home_patch_history_entry') 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::Database::Models::PatchHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_node(db_node_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified database node.

Parameters:

  • db_node_id (String) —

    The database node 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

Returns:



14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
 
# File 'lib/oci/database/database_client.rb', line 14312

def get_db_node(db_node_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_node.' if logger

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

  path = '/dbNodes/{dbNodeId}'.sub('{dbNodeId}', db_node_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_node') 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::Database::Models::DbNode'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_server(exadata_infrastructure_id, db_server_id, opts = {}) ⇒ Response

Note:

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

Gets information about the Exadata Db server.

Parameters:

  • exadata_infrastructure_id (String) —

    The OCID of the ExadataInfrastructure.

  • db_server_id (String) —

    The DB server 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) —

    Unique identifier for the request.

Returns:



14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
 
# File 'lib/oci/database/database_client.rb', line 14369

def get_db_server(exadata_infrastructure_id, db_server_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_server.' if logger

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

  path = '/dbServers/{dbServerId}'.sub('{dbServerId}', db_server_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:exadataInfrastructureId] = exadata_infrastructure_id

  # 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: 'DatabaseClient#get_db_server') 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::Database::Models::DbServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_system(db_system_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified DB system.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Parameters:

  • db_system_id (String) —

    The DB system 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

Returns:



14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
 
# File 'lib/oci/database/database_client.rb', line 14430

def get_db_system(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_system.' if logger

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

  path = '/dbSystems/{dbSystemId}'.sub('{dbSystemId}', db_system_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_system') 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::Database::Models::DbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_system_os_patch_history_entry(db_system_id, os_patch_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the specified OS patch action for the specified DB system.

Parameters:

  • db_system_id (String) —

    The DB system OCID.

  • os_patch_history_entry_id (String) —

    The OCID of the patch history entry.

  • 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.

Returns:



14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
 
# File 'lib/oci/database/database_client.rb', line 14487

def get_db_system_os_patch_history_entry(db_system_id, os_patch_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_system_os_patch_history_entry.' if logger

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

  path = '/dbSystems/{dbSystemId}/osPatchHistoryEntries/{osPatchHistoryEntryId}'.sub('{dbSystemId}', db_system_id.to_s).sub('{osPatchHistoryEntryId}', os_patch_history_entry_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: 'DatabaseClient#get_db_system_os_patch_history_entry') 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::Database::Models::DbSystemOsPatchHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_system_patch(db_system_id, patch_id, opts = {}) ⇒ Response

Note:

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

Gets information the specified patch.

Parameters:

  • db_system_id (String) —

    The DB system OCID.

  • patch_id (String) —

    The OCID of the patch.

  • 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

Returns:



14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
 
# File 'lib/oci/database/database_client.rb', line 14545

def get_db_system_patch(db_system_id, patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_system_patch.' if logger

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

  path = '/dbSystems/{dbSystemId}/patches/{patchId}'.sub('{dbSystemId}', db_system_id.to_s).sub('{patchId}', patch_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_system_patch') 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::Database::Models::Patch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_system_patch_history_entry(db_system_id, patch_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the specified patch operation on the specified DB system.

Parameters:

  • db_system_id (String) —

    The DB system OCID.

  • patch_history_entry_id (String) —

    The OCID of the patch history entry.

  • 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

Returns:



14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
 
# File 'lib/oci/database/database_client.rb', line 14603

def get_db_system_patch_history_entry(db_system_id, patch_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_system_patch_history_entry.' if logger

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

  path = '/dbSystems/{dbSystemId}/patchHistoryEntries/{patchHistoryEntryId}'.sub('{dbSystemId}', db_system_id.to_s).sub('{patchHistoryEntryId}', patch_history_entry_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_db_system_patch_history_entry') 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::Database::Models::PatchHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_db_system_upgrade_history_entry(db_system_id, upgrade_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the specified operating system upgrade operation for the specified DB system.

Parameters:

  • db_system_id (String) —

    The DB system OCID.

  • upgrade_history_entry_id (String) —

    The database/db system upgrade History 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) —

    Unique identifier for the request.

Returns:



14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
 
# File 'lib/oci/database/database_client.rb', line 14662

def get_db_system_upgrade_history_entry(db_system_id, upgrade_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_db_system_upgrade_history_entry.' if logger

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

  path = '/dbSystems/{dbSystemId}/upgradeHistoryEntries/{upgradeHistoryEntryId}'.sub('{dbSystemId}', db_system_id.to_s).sub('{upgradeHistoryEntryId}', upgrade_history_entry_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: 'DatabaseClient#get_db_system_upgrade_history_entry') 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::Database::Models::DbSystemUpgradeHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_dbnode_snapshot(dbnode_snapshot_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Exadata Database Node Snapshot in the specified compartment.

Parameters:

  • dbnode_snapshot_id (String) —

    The Exadata Database Node Snapshot 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) —

    Unique identifier for the request.

Returns:



14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
 
# File 'lib/oci/database/database_client.rb', line 14720

def get_dbnode_snapshot(dbnode_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_dbnode_snapshot.' if logger

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

  path = '/dbnodeSnapshots/{dbnodeSnapshotId}'.sub('{dbnodeSnapshotId}', dbnode_snapshot_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: 'DatabaseClient#get_dbnode_snapshot') 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::Database::Models::DbnodeSnapshot'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadata_infrastructure(exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure resource, use the get_cloud_exadata_infrastructure operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure 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) —

    Unique identifier for the request.

  • :excluded_fields (Array<String>) —

    If provided, the specified fields will be excluded in the response. Allowed values are: multiRackConfigurationFile

Returns:



14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
 
# File 'lib/oci/database/database_client.rb', line 14779

def get_exadata_infrastructure(exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'exadata_infrastructure_id' when calling get_exadata_infrastructure." if exadata_infrastructure_id.nil?


  excluded_fields_allowable_values = %w[multiRackConfigurationFile]
  if opts[:excluded_fields] && !opts[:excluded_fields].empty?
    opts[:excluded_fields].each do |val_to_check|
      unless excluded_fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "excluded_fields", must be one of multiRackConfigurationFile.'
      end
    end
  end
  raise "Parameter value for 'exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(exadata_infrastructure_id)

  path = '/exadataInfrastructures/{exadataInfrastructureId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:excludedFields] = OCI::ApiClient.build_collection_params(opts[:excluded_fields], :multi) if opts[:excluded_fields] && !opts[:excluded_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: 'DatabaseClient#get_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadata_infrastructure_ocpus(autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.

Parameters:

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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) —

    Unique identifier for the request.

Returns:



14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
 
# File 'lib/oci/database/database_client.rb', line 14846

def get_exadata_infrastructure_ocpus(autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadata_infrastructure_ocpus.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/ocpus'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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: 'DatabaseClient#get_exadata_infrastructure_ocpus') 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::Database::Models::OCPUs'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadata_infrastructure_un_allocated_resources(exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure 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) —

    Unique identifier for the request.

  • :db_servers (Array<String>) —

    The list of OCIDs of the Db servers.

Returns:



14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
 
# File 'lib/oci/database/database_client.rb', line 14903

def get_exadata_infrastructure_un_allocated_resources(exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadata_infrastructure_un_allocated_resources.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/unAllocatedResources'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:dbServers] = OCI::ApiClient.build_collection_params(opts[:db_servers], :multi) if opts[:db_servers] && !opts[:db_servers].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: 'DatabaseClient#get_exadata_infrastructure_un_allocated_resources') 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::Database::Models::ExadataInfrastructureUnAllocatedResources'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadata_iorm_config(db_system_id, opts = {}) ⇒ Response

Note:

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

Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

The get_cloud_vm_cluster_iorm_config API is used for this operation with Exadata systems using the new resource model.

Parameters:

  • db_system_id (String) —

    The DB system 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) —

    Unique identifier for the request.

Returns:



14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
 
# File 'lib/oci/database/database_client.rb', line 14968

def get_exadata_iorm_config(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadata_iorm_config.' if logger

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

  path = '/dbSystems/{dbSystemId}/ExadataIormConfig'.sub('{dbSystemId}', db_system_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: 'DatabaseClient#get_exadata_iorm_config') 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::Database::Models::ExadataIormConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadb_vm_cluster(exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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.

Returns:



15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
 
# File 'lib/oci/database/database_client.rb', line 15024

def get_exadb_vm_cluster(exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadb_vm_cluster.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}'.sub('{exadbVmClusterId}', exadb_vm_cluster_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: 'DatabaseClient#get_exadb_vm_cluster') 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::Database::Models::ExadbVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadb_vm_cluster_update(exadb_vm_cluster_id, update_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • update_id (String) —

    The OCID of the maintenance update.

  • 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.

Returns:



15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
 
# File 'lib/oci/database/database_client.rb', line 15081

def get_exadb_vm_cluster_update(exadb_vm_cluster_id, update_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadb_vm_cluster_update.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/updates/{updateId}'.sub('{exadbVmClusterId}', exadb_vm_cluster_id.to_s).sub('{updateId}', update_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: 'DatabaseClient#get_exadb_vm_cluster_update') 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::Database::Models::ExadbVmClusterUpdate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exadb_vm_cluster_update_history_entry(exadb_vm_cluster_id, update_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the maintenance update history details for the specified update history entry.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • update_history_entry_id (String) —

    The OCID of the maintenance update history entry.

  • 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.

Returns:



15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
 
# File 'lib/oci/database/database_client.rb', line 15140

def get_exadb_vm_cluster_update_history_entry(exadb_vm_cluster_id, update_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exadb_vm_cluster_update_history_entry.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}'.sub('{exadbVmClusterId}', exadb_vm_cluster_id.to_s).sub('{updateHistoryEntryId}', update_history_entry_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: 'DatabaseClient#get_exadb_vm_cluster_update_history_entry') 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::Database::Models::ExadbVmClusterUpdateHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_exascale_db_storage_vault(exascale_db_storage_vault_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Exadata Database Storage Vaults in the specified compartment.

Parameters:

  • exascale_db_storage_vault_id (String) —

    The Exadata Database Storage Vault 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) —

    Unique identifier for the request.

Returns:



15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
 
# File 'lib/oci/database/database_client.rb', line 15198

def get_exascale_db_storage_vault(exascale_db_storage_vault_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_exascale_db_storage_vault.' if logger

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

  path = '/exascaleDbStorageVaults/{exascaleDbStorageVaultId}'.sub('{exascaleDbStorageVaultId}', exascale_db_storage_vault_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: 'DatabaseClient#get_exascale_db_storage_vault') 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::Database::Models::ExascaleDbStorageVault'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_execution_action(execution_action_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified execution action.

Parameters:

  • execution_action_id (String) —

    The execution action 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) —

    Unique identifier for the request.

Returns:



15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
 
# File 'lib/oci/database/database_client.rb', line 15254

def get_execution_action(execution_action_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_execution_action.' if logger

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

  path = '/executionActions/{executionActionId}'.sub('{executionActionId}', execution_action_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: 'DatabaseClient#get_execution_action') 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::Database::Models::ExecutionAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_execution_window(execution_window_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified execution window.

Parameters:

  • execution_window_id (String) —

    The execution window 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) —

    Unique identifier for the request.

Returns:



15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
 
# File 'lib/oci/database/database_client.rb', line 15310

def get_execution_window(execution_window_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_execution_window.' if logger

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

  path = '/executionWindows/{executionWindowId}'.sub('{executionWindowId}', execution_window_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: 'DatabaseClient#get_execution_window') 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::Database::Models::ExecutionWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_backup_job(backup_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified external backup job.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Parameters:

  • backup_id (String) —

    The backup 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

Returns:



15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
 
# File 'lib/oci/database/database_client.rb', line 15367

def get_external_backup_job(backup_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_external_backup_job.' if logger

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

  path = '/externalBackupJobs/{backupId}'.sub('{backupId}', backup_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_external_backup_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::Database::Models::ExternalBackupJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_container_database(external_container_database_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified external container database.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase 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) —

    Unique identifier for the request.

Returns:



15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
 
# File 'lib/oci/database/database_client.rb', line 15422

def get_external_container_database(external_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_external_container_database.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}'.sub('{externalContainerDatabaseId}', external_container_database_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: 'DatabaseClient#get_external_container_database') 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::Database::Models::ExternalContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_database_connector(external_database_connector_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified external database connector.

Parameters:

  • external_database_connector_id (String) —

    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

  • 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.

Returns:



15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
 
# File 'lib/oci/database/database_client.rb', line 15479

def get_external_database_connector(external_database_connector_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_external_database_connector.' if logger

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

  path = '/externaldatabaseconnectors/{externalDatabaseConnectorId}'.sub('{externalDatabaseConnectorId}', external_database_connector_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: 'DatabaseClient#get_external_database_connector') 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::Database::Models::ExternalDatabaseConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_non_container_database(external_non_container_database_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specific external non-container database.

Parameters:

  • external_non_container_database_id (String) —

    The external non-container database 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) —

    Unique identifier for the request.

Returns:



15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
 
# File 'lib/oci/database/database_client.rb', line 15534

def get_external_non_container_database(external_non_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_external_non_container_database.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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: 'DatabaseClient#get_external_non_container_database') 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::Database::Models::ExternalNonContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_external_pluggable_database(external_pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specific create_external_pluggable_database_details resource.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId 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) —

    Unique identifier for the request.

Returns:



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
 
# File 'lib/oci/database/database_client.rb', line 15591

def get_external_pluggable_database(external_pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_external_pluggable_database.' if logger

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

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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: 'DatabaseClient#get_external_pluggable_database') 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::Database::Models::ExternalPluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_infrastructure_target_versions(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates. Applies to Exadata Cloud@Customer and Exadata Cloud instances only.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :target_resource_id (String) —

    The target resource ID.

  • :target_resource_type (String) —

    The type of the target resource.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
 
# File 'lib/oci/database/database_client.rb', line 15650

def get_infrastructure_target_versions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_infrastructure_target_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_infrastructure_target_versions." if compartment_id.nil?

  if opts[:target_resource_type] && !OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.include?(opts[:target_resource_type])
    raise 'Invalid value for "target_resource_type", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.'
  end

  path = '/infrastructureTargetVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetResourceId] = opts[:target_resource_id] if opts[:target_resource_id]
  query_params[:targetResourceType] = opts[:target_resource_type] if opts[:target_resource_type]

  # 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: 'DatabaseClient#get_infrastructure_target_versions') 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::Database::Models::InfrastructureTargetVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_key_store(key_store_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified key store.

Parameters:

  • key_store_id (String) —

    The OCID of the key store.

  • 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.

Returns:



15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
 
# File 'lib/oci/database/database_client.rb', line 15712

def get_key_store(key_store_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_key_store.' if logger

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

  path = '/keyStores/{keyStoreId}'.sub('{keyStoreId}', key_store_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: 'DatabaseClient#get_key_store') 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::Database::Models::KeyStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_maintenance_run(maintenance_run_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified maintenance run.

Parameters:

  • maintenance_run_id (String) —

    The maintenance run 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

Returns:



15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
 
# File 'lib/oci/database/database_client.rb', line 15766

def get_maintenance_run(maintenance_run_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_maintenance_run.' if logger

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

  path = '/maintenanceRuns/{maintenanceRunId}'.sub('{maintenanceRunId}', maintenance_run_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_maintenance_run') 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::Database::Models::MaintenanceRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_maintenance_run_history(maintenance_run_history_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified maintenance run history.

Parameters:

  • maintenance_run_history_id (String) —

    The maintenance run history 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

Returns:



15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
 
# File 'lib/oci/database/database_client.rb', line 15820

def get_maintenance_run_history(maintenance_run_history_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_maintenance_run_history.' if logger

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

  path = '/maintenanceRunHistory/{maintenanceRunHistoryId}'.sub('{maintenanceRunHistoryId}', maintenance_run_history_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_maintenance_run_history') 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::Database::Models::MaintenanceRunHistory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_oneoff_patch(oneoff_patch_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified one-off patch.

Parameters:

  • oneoff_patch_id (String) —

    The one-off patch 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) —

    Unique identifier for the request.

Returns:



15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
 
# File 'lib/oci/database/database_client.rb', line 15876

def get_oneoff_patch(oneoff_patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_oneoff_patch.' if logger

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

  path = '/oneoffPatches/{oneoffPatchId}'.sub('{oneoffPatchId}', oneoff_patch_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: 'DatabaseClient#get_oneoff_patch') 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::Database::Models::OneoffPatch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pdb_conversion_history_entry(database_id, pdb_conversion_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB).

Parameters:

  • database_id (String) —

    The database OCID.

  • pdb_conversion_history_entry_id (String) —

    The database conversion history 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) —

    Unique identifier for the request.

Returns:



15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
 
# File 'lib/oci/database/database_client.rb', line 15933

def get_pdb_conversion_history_entry(database_id, pdb_conversion_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_pdb_conversion_history_entry.' if logger

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

  path = '/databases/{databaseId}/pdbConversionHistoryEntries/{pdbConversionHistoryEntryId}'.sub('{databaseId}', database_id.to_s).sub('{pdbConversionHistoryEntryId}', pdb_conversion_history_entry_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: 'DatabaseClient#get_pdb_conversion_history_entry') 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::Database::Models::PdbConversionHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pluggable_database(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified pluggable database.

Parameters:

  • pluggable_database_id (String) —

    The database 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

Returns:



15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
 
# File 'lib/oci/database/database_client.rb', line 15989

def get_pluggable_database(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}'.sub('{pluggableDatabaseId}', pluggable_database_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pluggable_database_snapshot(pluggable_database_snapshot_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment.

Parameters:

  • pluggable_database_snapshot_id (String) —

    The Exadata Pluggable Database Snapshot 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) —

    Unique identifier for the request.

Returns:



16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
 
# File 'lib/oci/database/database_client.rb', line 16045

def get_pluggable_database_snapshot(pluggable_database_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_pluggable_database_snapshot.' if logger

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

  path = '/pluggableDatabaseSnapshots/{pluggableDatabaseSnapshotId}'.sub('{pluggableDatabaseSnapshotId}', pluggable_database_snapshot_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: 'DatabaseClient#get_pluggable_database_snapshot') 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::Database::Models::PluggableDatabaseSnapshot'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduled_action(scheduled_action_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Scheduled Action.

Parameters:

  • scheduled_action_id (String) —

    The Scheduled Action 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) —

    Unique identifier for the request.

Returns:



16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
 
# File 'lib/oci/database/database_client.rb', line 16101

def get_scheduled_action(scheduled_action_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_scheduled_action.' if logger

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

  path = '/scheduledActions/{scheduledActionId}'.sub('{scheduledActionId}', scheduled_action_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: 'DatabaseClient#get_scheduled_action') 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::Database::Models::ScheduledAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduling_plan(scheduling_plan_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Scheduling Plan.

Parameters:

  • scheduling_plan_id (String) —

    The Schedule Plan 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) —

    Unique identifier for the request.

Returns:



16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
 
# File 'lib/oci/database/database_client.rb', line 16157

def get_scheduling_plan(scheduling_plan_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_scheduling_plan.' if logger

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

  path = '/schedulingPlans/{schedulingPlanId}'.sub('{schedulingPlanId}', scheduling_plan_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: 'DatabaseClient#get_scheduling_plan') 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::Database::Models::SchedulingPlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduling_policy(scheduling_policy_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Scheduling Policy.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy 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) —

    Unique identifier for the request.

Returns:



16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
 
# File 'lib/oci/database/database_client.rb', line 16213

def get_scheduling_policy(scheduling_policy_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_scheduling_policy.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}'.sub('{schedulingPolicyId}', scheduling_policy_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: 'DatabaseClient#get_scheduling_policy') 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::Database::Models::SchedulingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduling_window(scheduling_policy_id, scheduling_window_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified Scheduling Window.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy OCID.

  • scheduling_window_id (String) —

    The Scheduling Window 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) —

    Unique identifier for the request.

Returns:



16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
 
# File 'lib/oci/database/database_client.rb', line 16270

def get_scheduling_window(scheduling_policy_id, scheduling_window_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_scheduling_window.' if logger

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

  path = '/schedulingPolicies/{schedulingPolicyId}/schedulingWindows/{schedulingWindowId}'.sub('{schedulingPolicyId}', scheduling_policy_id.to_s).sub('{schedulingWindowId}', scheduling_window_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: 'DatabaseClient#get_scheduling_window') 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::Database::Models::SchedulingWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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) —

    Unique identifier for the request.

Returns:



16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
 
# File 'lib/oci/database/database_client.rb', line 16328

def get_vm_cluster(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster.' if logger

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

  path = '/vmClusters/{vmClusterId}'.sub('{vmClusterId}', vm_cluster_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: 'DatabaseClient#get_vm_cluster') 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::Database::Models::VmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the get_cloud_vm_cluster operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network 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) —

    Unique identifier for the request.

Returns:



16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
 
# File 'lib/oci/database/database_client.rb', line 16386

def get_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster_network.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_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: 'DatabaseClient#get_vm_cluster_network') 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::Database::Models::VmClusterNetwork'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster_patch(vm_cluster_id, patch_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified patch package.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster OCID.

  • patch_id (String) —

    The OCID of the patch.

  • 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

Returns:



16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
 
# File 'lib/oci/database/database_client.rb', line 16444

def get_vm_cluster_patch(vm_cluster_id, patch_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster_patch.' if logger

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

  path = '/vmClusters/{vmClusterId}/patches/{patchId}'.sub('{vmClusterId}', vm_cluster_id.to_s).sub('{patchId}', patch_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_vm_cluster_patch') 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::Database::Models::Patch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster_patch_history_entry(vm_cluster_id, patch_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the patch history details for the specified patch history entry.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster OCID.

  • patch_history_entry_id (String) —

    The OCID of the patch history entry.

  • 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

Returns:



16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
 
# File 'lib/oci/database/database_client.rb', line 16502

def get_vm_cluster_patch_history_entry(vm_cluster_id, patch_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster_patch_history_entry.' if logger

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

  path = '/vmClusters/{vmClusterId}/patchHistoryEntries/{patchHistoryEntryId}'.sub('{vmClusterId}', vm_cluster_id.to_s).sub('{patchHistoryEntryId}', patch_history_entry_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#get_vm_cluster_patch_history_entry') 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::Database::Models::PatchHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster_update(vm_cluster_id, update_id, opts = {}) ⇒ Response

Note:

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

Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster OCID.

  • update_id (String) —

    The OCID of the maintenance update.

  • 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.

Returns:



16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
 
# File 'lib/oci/database/database_client.rb', line 16561

def get_vm_cluster_update(vm_cluster_id, update_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster_update.' if logger

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

  path = '/vmClusters/{vmClusterId}/updates/{updateId}'.sub('{vmClusterId}', vm_cluster_id.to_s).sub('{updateId}', update_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: 'DatabaseClient#get_vm_cluster_update') 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::Database::Models::VmClusterUpdate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vm_cluster_update_history_entry(vm_cluster_id, update_history_entry_id, opts = {}) ⇒ Response

Note:

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

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster OCID.

  • update_history_entry_id (String) —

    The OCID of the maintenance update history entry.

  • 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.

Returns:



16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
 
# File 'lib/oci/database/database_client.rb', line 16620

def get_vm_cluster_update_history_entry(vm_cluster_id, update_history_entry_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#get_vm_cluster_update_history_entry.' if logger

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

  path = '/vmClusters/{vmClusterId}/updateHistoryEntries/{updateHistoryEntryId}'.sub('{vmClusterId}', vm_cluster_id.to_s).sub('{updateHistoryEntryId}', update_history_entry_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: 'DatabaseClient#get_vm_cluster_update_history_entry') 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::Database::Models::VmClusterUpdateHistoryEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_transportable_tablespace(autonomous_database_id, import_transportable_tablespace_details, opts = {}) ⇒ Response

Note:

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

Imports transportable tablespace for the specified Autonomous AI Database.

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
 
# File 'lib/oci/database/database_client.rb', line 16692

def import_transportable_tablespace(autonomous_database_id, import_transportable_tablespace_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#import_transportable_tablespace.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/importTransportableTablespace'.sub('{autonomousDatabaseId}', autonomous_database_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-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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_transportable_tablespace_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#import_transportable_tablespace') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#launch_autonomous_exadata_infrastructure(launch_autonomous_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Deprecated To create a new Autonomous AI Database system on dedicated Exadata Infrastructure, use the create_cloud_exadata_infrastructure and create_cloud_autonomous_vm_cluster operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.

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 may be rejected).

Returns:



16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
 
# File 'lib/oci/database/database_client.rb', line 16758

def launch_autonomous_exadata_infrastructure(launch_autonomous_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#launch_autonomous_exadata_infrastructure.' if logger

  raise "Missing the required parameter 'launch_autonomous_exadata_infrastructure_details' when calling launch_autonomous_exadata_infrastructure." if launch_autonomous_exadata_infrastructure_details.nil?

  path = '/autonomousExadataInfrastructures'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(launch_autonomous_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#launch_autonomous_exadata_infrastructure') 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::Database::Models::AutonomousExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#launch_db_system(launch_db_system_details, opts = {}) ⇒ Response

Note:

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

Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.

An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see Bare metal and virtual machine DB system default options.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Use the create_cloud_exadata_infrastructure and create_cloud_vm_cluster APIs to provision a new Exadata Cloud Service instance.

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 may be rejected).

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
 
# File 'lib/oci/database/database_client.rb', line 16836

def launch_db_system(launch_db_system_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#launch_db_system.' if logger

  raise "Missing the required parameter 'launch_db_system_details' when calling launch_db_system." if launch_db_system_details.nil?

  path = '/dbSystems'
  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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(launch_db_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#launch_db_system') 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::Database::Models::DbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_advanced_cluster_file_systems(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the advanced cluster file system resources in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :vm_cluster_id (String) —

    A filter to return only ACFS that match the given vm cluster id exactly.

  • :resource_id (String) —

    If provided, filters the results for the specified resource Id.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :name (String) —

    A filter to return only resources that match the entire name given. The match is not case sensitive.

Returns:



16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
 
# File 'lib/oci/database/database_client.rb', line 16904

def list_advanced_cluster_file_systems(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_advanced_cluster_file_systems.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_advanced_cluster_file_systems." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Database::Models::AdvancedClusterFileSystem::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AdvancedClusterFileSystem::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

  path = '/advancedClusterFileSystems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vmClusterId] = opts[:vm_cluster_id] if opts[:vm_cluster_id]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:name] = opts[:name] if opts[:name]

  # 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: 'DatabaseClient#list_advanced_cluster_file_systems') 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::Database::Models::AdvancedClusterFileSystemCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_application_vips(compartment_id, cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • cloud_vm_cluster_id (String) —

    The OCID of the cloud VM cluster associated with the application virtual IP (VIP) address.

  • 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 per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: DISPLAYNAME, TIMECREATED

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

Returns:



16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
 
# File 'lib/oci/database/database_client.rb', line 16992

def list_application_vips(compartment_id, cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_application_vips.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_application_vips." if compartment_id.nil?
  raise "Missing the required parameter 'cloud_vm_cluster_id' when calling list_application_vips." if cloud_vm_cluster_id.nil?

  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 TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, TIMECREATED.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::ApplicationVipSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ApplicationVipSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/applicationVip'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:cloudVmClusterId] = cloud_vm_cluster_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # 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: 'DatabaseClient#list_application_vips') 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::Database::Models::ApplicationVipSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_container_database_backups(opts = {}) ⇒ Response

Note:

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

Gets a list of Autonomous Container Database backups by using either the 'autonomousDatabaseId' or 'compartmentId' as your query parameter.

Parameters:

  • 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

  • :compartment_id (String) —

    The compartment OCID.

  • :autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • :is_remote (BOOLEAN) —

    call for all remote backups (default to false)

  • :infrastructure_type (String) —

    A filter to return only resources that match the given Infrastructure Type.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
 
# File 'lib/oci/database/database_client.rb', line 17081

def list_autonomous_container_database_backups(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_container_database_backups.' if logger


  if opts[:infrastructure_type] && !OCI::Database::Models::AutonomousContainerDatabaseBackupSummary::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::Database::Models::AutonomousContainerDatabaseBackupSummary::INFRASTRUCTURE_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousContainerDatabaseBackupSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousContainerDatabaseBackupSummary::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

  path = '/autonomousContainerDatabaseBackups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:autonomousContainerDatabaseId] = opts[:autonomous_container_database_id] if opts[:autonomous_container_database_id]
  query_params[:isRemote] = opts[:is_remote] if !opts[:is_remote].nil?
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_autonomous_container_database_backups') 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::Database::Models::AutonomousContainerDatabaseBackupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_container_database_dataguard_associations(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the list_autonomous_container_databases operation to get a list of the Autonomous Container Databases (ACDs)with Autonomous Data Guard-enabled associated with the specified ACD.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
 
# File 'lib/oci/database/database_client.rb', line 17161

def list_autonomous_container_database_dataguard_associations(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_container_database_dataguard_associations.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_container_database_dataguard_associations') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_container_database_versions(compartment_id, service_component, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Autonomous Container Database versions.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • service_component (String) —

    The service component to use, either ADBD or EXACC. Allowed values are: ADBD, EXACC

  • 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 per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

Returns:



17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
 
# File 'lib/oci/database/database_client.rb', line 17223

def list_autonomous_container_database_versions(compartment_id, service_component, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_container_database_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_container_database_versions." if compartment_id.nil?
  raise "Missing the required parameter 'service_component' when calling list_autonomous_container_database_versions." if service_component.nil?
  unless %w[ADBD EXACC].include?(service_component)
    raise "Invalid value for 'service_component', must be one of ADBD, EXACC."
  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

  path = '/autonomousContainerDatabaseVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:serviceComponent] = service_component
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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: 'DatabaseClient#list_autonomous_container_database_versions') 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::Database::Models::AutonomousContainerDatabaseVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_container_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the Autonomous Container Databases in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure OCID.

  • :autonomous_vm_cluster_id (String) —

    The Autonomous VM Cluster OCID.

  • :infrastructure_type (String) —

    A filter to return only resources that match the given Infrastructure Type.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :service_level_agreement_type (String) —

    A filter to return only resources that match the given service-level agreement type exactly.

  • :cloud_autonomous_vm_cluster_id (String) —

    The cloud Autonomous VM Cluster OCID.

Returns:



17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
 
# File 'lib/oci/database/database_client.rb', line 17306

def list_autonomous_container_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_container_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_container_databases." if compartment_id.nil?

  if opts[:infrastructure_type] && !OCI::Database::Models::AutonomousContainerDatabaseSummary::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::Database::Models::AutonomousContainerDatabaseSummary::INFRASTRUCTURE_TYPE_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

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousContainerDatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousContainerDatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/autonomousContainerDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:autonomousExadataInfrastructureId] = opts[:autonomous_exadata_infrastructure_id] if opts[:autonomous_exadata_infrastructure_id]
  query_params[:autonomousVmClusterId] = opts[:autonomous_vm_cluster_id] if opts[:autonomous_vm_cluster_id]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:serviceLevelAgreementType] = opts[:service_level_agreement_type] if opts[:service_level_agreement_type]
  query_params[:cloudAutonomousVmClusterId] = opts[:cloud_autonomous_vm_cluster_id] if opts[:cloud_autonomous_vm_cluster_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_container_databases') 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::Database::Models::AutonomousContainerDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_backups(opts = {}) ⇒ Response

Note:

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

Gets a list of Autonomous AI Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.

Parameters:

  • 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

  • :autonomous_database_id (String) —

    The database OCID.

  • :compartment_id (String) —

    The compartment OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :type (String) —

    A filter to return only backups that matches with the given type of Backup.

  • :backup_destination_id (String) —

    A filter to return only resources that have the given backup destination id.

  • :key_store_id (String) —

    A filter to return only resources that have the given key store id.

  • :infrastructure_type (String) —

    A filter to return only resources that match the given Infrastructure Type.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
 
# File 'lib/oci/database/database_client.rb', line 17405

def list_autonomous_database_backups(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_backups.' if logger


  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

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousDatabaseBackupSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousDatabaseBackupSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:infrastructure_type] && !OCI::Database::Models::AutonomousDatabaseBackupSummary::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::Database::Models::AutonomousDatabaseBackupSummary::INFRASTRUCTURE_TYPE_ENUM.'
  end

  path = '/autonomousDatabaseBackups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:autonomousDatabaseId] = opts[:autonomous_database_id] if opts[:autonomous_database_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:backupDestinationId] = opts[:backup_destination_id] if opts[:backup_destination_id]
  query_params[:keyStoreId] = opts[:key_store_id] if opts[:key_store_id]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]

  # 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: 'DatabaseClient#list_autonomous_database_backups') 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::Database::Models::AutonomousDatabaseBackupSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_character_sets(opts = {}) ⇒ Response

Note:

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

Gets a list of supported character sets. Allowed values are: DATABASE, NATIONAL

Parameters:

  • 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.

  • :is_shared (BOOLEAN) —

    Specifies whether this request is for an Autonomous AI Database Serverless instance. By default, this request will be for Autonomous AI Database on Dedicated Exadata Infrastructure.

  • :is_dedicated (BOOLEAN) —

    Specifies if the request is for an Autonomous AI Database Dedicated instance. The default request is for an Autonomous AI Database Dedicated instance.

  • :character_set_type (String) —

    Specifies whether this request pertains to database character sets or national character sets. (default to DATABASE)

Returns:



17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
 
# File 'lib/oci/database/database_client.rb', line 17492

def list_autonomous_database_character_sets(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_character_sets.' if logger


  if opts[:character_set_type] && !%w[DATABASE NATIONAL].include?(opts[:character_set_type])
    raise 'Invalid value for "character_set_type", must be one of DATABASE, NATIONAL.'
  end

  path = '/autonomousDatabaseCharacterSets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isShared] = opts[:is_shared] if !opts[:is_shared].nil?
  query_params[:isDedicated] = opts[:is_dedicated] if !opts[:is_dedicated].nil?
  query_params[:characterSetType] = opts[:character_set_type] if opts[:character_set_type]

  # 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: 'DatabaseClient#list_autonomous_database_character_sets') 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::Database::Models::AutonomousDatabaseCharacterSets>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_clones(compartment_id, autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Lists the Autonomous AI Database clones for the specified Autonomous AI Database.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. (default to NONE) Allowed values are: NONE, TIMECREATED, DISPLAYNAME

  • :clone_type (String) —

    A filter to return only resources that match the given clone type exactly. Allowed values are: REFRESHABLE_CLONE

Returns:



17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
 
# File 'lib/oci/database/database_client.rb', line 17567

def list_autonomous_database_clones(compartment_id, autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_clones.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_database_clones." if compartment_id.nil?
  raise "Missing the required parameter 'autonomous_database_id' when calling list_autonomous_database_clones." if autonomous_database_id.nil?

  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[:lifecycle_state] && !OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[NONE TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of NONE, TIMECREATED, DISPLAYNAME.'
  end

  if opts[:clone_type] && !%w[REFRESHABLE_CLONE].include?(opts[:clone_type])
    raise 'Invalid value for "clone_type", must be one of REFRESHABLE_CLONE.'
  end
  raise "Parameter value for 'autonomous_database_id' must not be blank" if OCI::Internal::Util.blank_string?(autonomous_database_id)

  path = '/autonomousDatabases/{autonomousDatabaseId}/clones'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:cloneType] = opts[:clone_type] if opts[:clone_type]

  # 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: 'DatabaseClient#list_autonomous_database_clones') 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::Database::Models::AutonomousDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_dataguard_associations(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the get_autonomous_container_database operation to get a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
 
# File 'lib/oci/database/database_client.rb', line 17648

def list_autonomous_database_dataguard_associations(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_dataguard_associations.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations'.sub('{autonomousDatabaseId}', autonomous_database_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_database_dataguard_associations') 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::Database::Models::AutonomousDatabaseDataguardAssociation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_peers(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Lists the Autonomous AI Database peers for the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
 
# File 'lib/oci/database/database_client.rb', line 17707

def list_autonomous_database_peers(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_peers.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/peers'.sub('{autonomousDatabaseId}', autonomous_database_id.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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_database_peers') 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::Database::Models::AutonomousDatabasePeerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_refreshable_clones(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Lists the OCIDs of the Autonomous AI Database local and connected remote refreshable clones with the region where they exist for the specified source database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
 
# File 'lib/oci/database/database_client.rb', line 17767

def list_autonomous_database_refreshable_clones(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_refreshable_clones.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/refreshableClones'.sub('{autonomousDatabaseId}', autonomous_database_id.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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_database_refreshable_clones') 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::Database::Models::RefreshableCloneCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_database_software_images(compartment_id, image_shape_family, opts = {}) ⇒ Response

Note:

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

Gets a list of the Autonomous AI Database Software Images in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • image_shape_family (String) —

    A filter to return only resources that match the given image shape family exactly.

  • 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 per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    parameter according to which Autonomous AI Database Software Images will be sorted. (default to TIMECREATED)

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
 
# File 'lib/oci/database/database_client.rb', line 17835

def list_autonomous_database_software_images(compartment_id, image_shape_family, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_database_software_images.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_database_software_images." if compartment_id.nil?
  raise "Missing the required parameter 'image_shape_family' when calling list_autonomous_database_software_images." if image_shape_family.nil?
  unless OCI::Database::Models::AutonomousDatabaseSoftwareImage::IMAGE_SHAPE_FAMILY_ENUM.include?(image_shape_family)
    raise 'Invalid value for "image_shape_family", must be one of the values in OCI::Database::Models::AutonomousDatabaseSoftwareImage::IMAGE_SHAPE_FAMILY_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

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousDatabaseSoftwareImage::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousDatabaseSoftwareImage::LIFECYCLE_STATE_ENUM.'
  end

  path = '/autonomousDatabaseSoftwareImages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:imageShapeFamily] = image_shape_family
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_autonomous_database_software_images') 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::Database::Models::AutonomousDatabaseSoftwareImageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of Autonomous AI Databases based on the query parameters specified.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :infrastructure_type (String) —

    A filter to return only resources that match the given Infrastructure Type.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :lifecycle_state_not_equal_to (String) —

    A filter to return only resources that not match the given lifecycle state.

  • :db_workload (String) —

    A filter to return only Autonomous AI Database resources that match the specified workload type.

  • :db_version (String) —

    A filter to return only Autonomous AI Database resources that match the specified dbVersion.

  • :is_free_tier (BOOLEAN) —

    Filter on the value of the resource's 'isFreeTier' property. A value of true returns only Always Free resources. A value of false excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_refreshable_clone (BOOLEAN) —

    Filter on the value of the resource's 'isRefreshableClone' property. A value of true returns only refreshable clones. A value of false excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.

  • :is_data_guard_enabled (BOOLEAN) —

    A filter to return only resources that have Data Guard enabled.

  • :is_resource_pool_leader (BOOLEAN) —

    Filter if the resource is the resource pool leader. A value of true returns only resource pool leader.

  • :resource_pool_leader_id (String) —

    The database OCID of the resourcepool Leader Autonomous AI Database.

Returns:



17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
 
# File 'lib/oci/database/database_client.rb', line 17941

def list_autonomous_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_databases." if compartment_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

  if opts[:infrastructure_type] && !OCI::Database::Models::AutonomousDatabaseSummary::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::INFRASTRUCTURE_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:lifecycle_state_not_equal_to] && !OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state_not_equal_to])
    raise 'Invalid value for "lifecycle_state_not_equal_to", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:db_workload] && !OCI::Database::Models::AutonomousDatabaseSummary::DB_WORKLOAD_ENUM.include?(opts[:db_workload])
    raise 'Invalid value for "db_workload", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::DB_WORKLOAD_ENUM.'
  end

  path = '/autonomousDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:autonomousContainerDatabaseId] = opts[:autonomous_container_database_id] if opts[:autonomous_container_database_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleStateNotEqualTo] = opts[:lifecycle_state_not_equal_to] if opts[:lifecycle_state_not_equal_to]
  query_params[:dbWorkload] = opts[:db_workload] if opts[:db_workload]
  query_params[:dbVersion] = opts[:db_version] if opts[:db_version]
  query_params[:isFreeTier] = opts[:is_free_tier] if !opts[:is_free_tier].nil?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isRefreshableClone] = opts[:is_refreshable_clone] if !opts[:is_refreshable_clone].nil?
  query_params[:isDataGuardEnabled] = opts[:is_data_guard_enabled] if !opts[:is_data_guard_enabled].nil?
  query_params[:isResourcePoolLeader] = opts[:is_resource_pool_leader] if !opts[:is_resource_pool_leader].nil?
  query_params[:resourcePoolLeaderId] = opts[:resource_pool_leader_id] if opts[:resource_pool_leader_id]

  # 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: 'DatabaseClient#list_autonomous_databases') 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::Database::Models::AutonomousDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_db_preview_versions(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Autonomous AI Database versions. Note that preview version software is only available for Autonomous AI Database Serverless (docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for DBWORKLOAD is ascending.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: DBWORKLOAD

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

Returns:



18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
 
# File 'lib/oci/database/database_client.rb', line 18047

def list_autonomous_db_preview_versions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_db_preview_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_db_preview_versions." if compartment_id.nil?

  if opts[:sort_by] && !%w[DBWORKLOAD].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DBWORKLOAD.'
  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

  path = '/autonomousDbPreviewVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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: 'DatabaseClient#list_autonomous_db_preview_versions') 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::Database::Models::AutonomousDbPreviewVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_db_versions(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Autonomous AI Database versions.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :db_workload (String) —

    A filter to return only Autonomous AI Database resources that match the specified workload type.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

Returns:



18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
 
# File 'lib/oci/database/database_client.rb', line 18119

def list_autonomous_db_versions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_db_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_db_versions." if compartment_id.nil?

  if opts[:db_workload] && !OCI::Database::Models::AutonomousDatabaseSummary::DB_WORKLOAD_ENUM.include?(opts[:db_workload])
    raise 'Invalid value for "db_workload", must be one of the values in OCI::Database::Models::AutonomousDatabaseSummary::DB_WORKLOAD_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

  path = '/autonomousDbVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:dbWorkload] = opts[:db_workload] if opts[:db_workload]
  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: 'DatabaseClient#list_autonomous_db_versions') 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::Database::Models::AutonomousDbVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_exadata_infrastructure_shapes(availability_domain, compartment_id, opts = {}) ⇒ Response

Note:

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

Deprecated.

Parameters:

  • availability_domain (String) —

    The name of the Availability Domain.

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
 
# File 'lib/oci/database/database_client.rb', line 18190

def list_autonomous_exadata_infrastructure_shapes(availability_domain, compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_exadata_infrastructure_shapes.' if logger

  raise "Missing the required parameter 'availability_domain' when calling list_autonomous_exadata_infrastructure_shapes." if availability_domain.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_exadata_infrastructure_shapes." if compartment_id.nil?

  path = '/autonomousExadataInfrastructureShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:availabilityDomain] = availability_domain
  query_params[:compartmentId] = compartment_id
  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: 'DatabaseClient#list_autonomous_exadata_infrastructure_shapes') 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::Database::Models::AutonomousExadataInfrastructureShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_exadata_infrastructures(compartment_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the list_cloud_exadata_infrastructures operation to list Exadata Infrastructures in the Oracle cloud and the list_cloud_autonomous_vm_clusters operation to list Autonomous Exadata VM clusters.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
 
# File 'lib/oci/database/database_client.rb', line 18260

def list_autonomous_exadata_infrastructures(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_exadata_infrastructures.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_exadata_infrastructures." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/autonomousExadataInfrastructures'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_autonomous_exadata_infrastructures') 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::Database::Models::AutonomousExadataInfrastructureSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_virtual_machines(compartment_id, autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • autonomous_vm_cluster_id (String) —

    The Autonomous Virtual machine 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

Returns:



18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
 
# File 'lib/oci/database/database_client.rb', line 18338

def list_autonomous_virtual_machines(compartment_id, autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_virtual_machines.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_virtual_machines." if compartment_id.nil?
  raise "Missing the required parameter 'autonomous_vm_cluster_id' when calling list_autonomous_virtual_machines." if autonomous_vm_cluster_id.nil?

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousVirtualMachineSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousVirtualMachineSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/autonomousVirtualMachines'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:autonomousVmClusterId] = autonomous_vm_cluster_id
  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]

  # 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: 'DatabaseClient#list_autonomous_virtual_machines') 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::Database::Models::AutonomousVirtualMachineSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_vm_cluster_acd_resource_usage(autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster.

Parameters:

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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

  • :compartment_id (String) —

    The compartment OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
 
# File 'lib/oci/database/database_client.rb', line 18406

def list_autonomous_vm_cluster_acd_resource_usage(autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_vm_cluster_acd_resource_usage.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/acdResourceUsage'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  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: 'DatabaseClient#list_autonomous_vm_cluster_acd_resource_usage') 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::Database::Models::AutonomousContainerDatabaseResourceUsage>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_autonomous_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see list_cloud_autonomous_vm_clusters.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :exadata_infrastructure_id (String) —

    If provided, filters the results for the given Exadata Infrastructure. (default to default)

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
 
# File 'lib/oci/database/database_client.rb', line 18475

def list_autonomous_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_autonomous_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_autonomous_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::AutonomousVmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::AutonomousVmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/autonomousVmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:exadataInfrastructureId] = opts[:exadata_infrastructure_id] if opts[:exadata_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_autonomous_vm_clusters') 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::Database::Models::AutonomousVmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backup_destination(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of backup destinations in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :type (String) —

    A filter to return only resources that match the given type of the Backup Destination.

Returns:



18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
 
# File 'lib/oci/database/database_client.rb', line 18553

def list_backup_destination(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_backup_destination.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_backup_destination." if compartment_id.nil?

  path = '/backupDestinations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:type] = opts[:type] if opts[:type]

  # 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: 'DatabaseClient#list_backup_destination') 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::Database::Models::BackupDestinationSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backups(opts = {}) ⇒ Response

Note:

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

Gets a list of backups based on the databaseId or compartmentId specified. Either one of these query parameters must be provided.

Parameters:

  • 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

  • :database_id (String) —

    The OCID of the database.

  • :compartment_id (String) —

    The compartment OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :shape_family (String) —

    If provided, filters the results to the set of database versions which are supported for the given shape family. Allowed values are: SINGLENODE, YODA, VIRTUALMACHINE, EXADATA, EXACC, EXADB_XS

  • :version (String) —

    A filter to return only resources that match the given database version.

  • :type (String) —

    A filter to return only backups that matches with the given type of Backup.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :time_expiry_scheduled_greater_than_or_equal_to (DateTime) —

    The start of date-time range of expiration for the long term backups to be fetched.

  • :time_expiry_scheduled_less_than (DateTime) —

    The end of date-time range of expiration for the long term backups to be fetched.

  • :backup_destination_type (String) —

    A filter to return only resources that match the given backup destination type.

Returns:



18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
 
# File 'lib/oci/database/database_client.rb', line 18621

def list_backups(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_backups.' if logger


  if opts[:shape_family] && !%w[SINGLENODE YODA VIRTUALMACHINE EXADATA EXACC EXADB_XS].include?(opts[:shape_family])
    raise 'Invalid value for "shape_family", must be one of SINGLENODE, YODA, VIRTUALMACHINE, EXADATA, EXACC, EXADB_XS.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::BackupSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::BackupSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/backups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:shapeFamily] = opts[:shape_family] if opts[:shape_family]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeExpiryScheduledGreaterThanOrEqualTo] = opts[:time_expiry_scheduled_greater_than_or_equal_to] if opts[:time_expiry_scheduled_greater_than_or_equal_to]
  query_params[:timeExpiryScheduledLessThan] = opts[:time_expiry_scheduled_less_than] if opts[:time_expiry_scheduled_less_than]
  query_params[:backupDestinationType] = opts[:backup_destination_type] if opts[:backup_destination_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_backups') 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::Database::Models::BackupSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_basecc_vm_cluster_update_history_entries(basecc_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the maintenance update actions performed on the specified BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. (default to GI_UPGRADE) Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
 
# File 'lib/oci/database/database_client.rb', line 18698

def list_basecc_vm_cluster_update_history_entries(basecc_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_basecc_vm_cluster_update_history_entries.' if logger

  raise "Missing the required parameter 'basecc_vm_cluster_id' when calling list_basecc_vm_cluster_update_history_entries." if basecc_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::BaseccVmClusterUpdateHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::BaseccVmClusterUpdateHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'basecc_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(basecc_vm_cluster_id)

  path = '/baseccVmClusters/{baseccVmClusterId}/updateHistoryEntries'.sub('{baseccVmClusterId}', basecc_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_basecc_vm_cluster_update_history_entries') 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::Database::Models::BaseccVmClusterUpdateHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_basecc_vm_cluster_updates(basecc_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the maintenance updates that can be applied to the specified BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. (default to GI_UPGRADE) Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
 
# File 'lib/oci/database/database_client.rb', line 18771

def list_basecc_vm_cluster_updates(basecc_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_basecc_vm_cluster_updates.' if logger

  raise "Missing the required parameter 'basecc_vm_cluster_id' when calling list_basecc_vm_cluster_updates." if basecc_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::BaseccVmClusterUpdateSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::BaseccVmClusterUpdateSummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'basecc_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(basecc_vm_cluster_id)

  path = '/baseccVmClusters/{baseccVmClusterId}/updates'.sub('{baseccVmClusterId}', basecc_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_basecc_vm_cluster_updates') 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::Database::Models::BaseccVmClusterUpdateSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_basecc_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the BaseDB-C@C VM clusters in the specified compartment. Applies to Base Database Service on Cloud@Customer instances only.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :base_infrastructure_id (String) —

    If provided, filters the results for the given Oracle Data Cloud@Customer Infrastructure. (default to default)

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :vm_cluster_type (String) —

    A filter to return only BaseDB-C@C VM clusters that match the given VM Cluster type exactly.

Returns:



18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
 
# File 'lib/oci/database/database_client.rb', line 18851

def list_basecc_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_basecc_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_basecc_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::BaseccVmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::BaseccVmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:vm_cluster_type] && !OCI::Database::Models::BaseccVmClusterSummary::VM_CLUSTER_TYPE_ENUM.include?(opts[:vm_cluster_type])
    raise 'Invalid value for "vm_cluster_type", must be one of the values in OCI::Database::Models::BaseccVmClusterSummary::VM_CLUSTER_TYPE_ENUM.'
  end

  path = '/baseccVmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:baseInfrastructureId] = opts[:base_infrastructure_id] if opts[:base_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vmClusterType] = opts[:vm_cluster_type] if opts[:vm_cluster_type]

  # 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: 'DatabaseClient#list_basecc_vm_clusters') 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::Database::Models::BaseccVmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_autonomous_vm_cluster_acd_resource_usage(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the list of resource usage details for all the Cloud Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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

  • :compartment_id (String) —

    The compartment OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
 
# File 'lib/oci/database/database_client.rb', line 18936

def list_cloud_autonomous_vm_cluster_acd_resource_usage(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_autonomous_vm_cluster_acd_resource_usage.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/acdResourceUsage'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  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: 'DatabaseClient#list_cloud_autonomous_vm_cluster_acd_resource_usage') 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::Database::Models::AutonomousContainerDatabaseResourceUsage>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_autonomous_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see list_autonomous_vm_clusters.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :cloud_exadata_infrastructure_id (String) —

    If provided, filters the results for the specified cloud Exadata infrastructure.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
 
# File 'lib/oci/database/database_client.rb', line 19006

def list_cloud_autonomous_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_autonomous_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cloud_autonomous_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::CloudAutonomousVmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::CloudAutonomousVmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/cloudAutonomousVmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:cloudExadataInfrastructureId] = opts[:cloud_exadata_infrastructure_id] if opts[:cloud_exadata_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_cloud_autonomous_vm_clusters') 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::Database::Models::CloudAutonomousVmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_exadata_infrastructures(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :cluster_placement_group_id (String) —

    A filter to return only resources that match the given cluster placement group ID exactly.

Returns:



19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
 
# File 'lib/oci/database/database_client.rb', line 19092

def list_cloud_exadata_infrastructures(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_exadata_infrastructures.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cloud_exadata_infrastructures." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::CloudExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::CloudExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/cloudExadataInfrastructures'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:clusterPlacementGroupId] = opts[:cluster_placement_group_id] if opts[:cluster_placement_group_id]

  # 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: 'DatabaseClient#list_cloud_exadata_infrastructures') 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::Database::Models::CloudExadataInfrastructureSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_vm_cluster_update_history_entries(cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
 
# File 'lib/oci/database/database_client.rb', line 19171

def list_cloud_vm_cluster_update_history_entries(cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_vm_cluster_update_history_entries.' if logger

  raise "Missing the required parameter 'cloud_vm_cluster_id' when calling list_cloud_vm_cluster_update_history_entries." if cloud_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end
  raise "Parameter value for 'cloud_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_vm_cluster_id)

  path = '/cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries'.sub('{cloudVmClusterId}', cloud_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  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: 'DatabaseClient#list_cloud_vm_cluster_update_history_entries') 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::Database::Models::UpdateHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_vm_cluster_updates(cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:

  • cloud_vm_cluster_id (String) —

    The cloud VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
 
# File 'lib/oci/database/database_client.rb', line 19238

def list_cloud_vm_cluster_updates(cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_vm_cluster_updates.' if logger

  raise "Missing the required parameter 'cloud_vm_cluster_id' when calling list_cloud_vm_cluster_updates." if cloud_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end
  raise "Parameter value for 'cloud_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_vm_cluster_id)

  path = '/cloudVmClusters/{cloudVmClusterId}/updates'.sub('{cloudVmClusterId}', cloud_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  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: 'DatabaseClient#list_cloud_vm_cluster_updates') 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::Database::Models::UpdateSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :cloud_exadata_infrastructure_id (String) —

    If provided, filters the results for the specified cloud Exadata infrastructure.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only cloud VM clusters that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :vm_cluster_type (String) —

    A filter to return only cloud vmclusters that match the given cloud vmcluster type exactly.

Returns:



19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
 
# File 'lib/oci/database/database_client.rb', line 19312

def list_cloud_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_cloud_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cloud_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::CloudVmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::CloudVmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:vm_cluster_type] && !OCI::Database::Models::CloudVmClusterSummary::VM_CLUSTER_TYPE_ENUM.include?(opts[:vm_cluster_type])
    raise 'Invalid value for "vm_cluster_type", must be one of the values in OCI::Database::Models::CloudVmClusterSummary::VM_CLUSTER_TYPE_ENUM.'
  end

  path = '/cloudVmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:cloudExadataInfrastructureId] = opts[:cloud_exadata_infrastructure_id] if opts[:cloud_exadata_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vmClusterType] = opts[:vm_cluster_type] if opts[:vm_cluster_type]

  # 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: 'DatabaseClient#list_cloud_vm_clusters') 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::Database::Models::CloudVmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_console_connections(db_node_id, opts = {}) ⇒ Response

Note:

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

Lists the console connections for the specified database node.

Parameters:

  • db_node_id (String) —

    The database node 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

Returns:



19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
 
# File 'lib/oci/database/database_client.rb', line 19391

def list_console_connections(db_node_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_console_connections.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleConnections'.sub('{dbNodeId}', db_node_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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_console_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: 'Array<OCI::Database::Models::ConsoleConnectionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_console_histories(db_node_id, opts = {}) ⇒ Response

Note:

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

Lists the console histories for the specified database node.

Parameters:

  • db_node_id (String) —

    The database node 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
 
# File 'lib/oci/database/database_client.rb', line 19456

def list_console_histories(db_node_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_console_histories.' if logger

  raise "Missing the required parameter 'db_node_id' when calling list_console_histories." if db_node_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ConsoleHistorySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ConsoleHistorySummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'db_node_id' must not be blank" if OCI::Internal::Util.blank_string?(db_node_id)

  path = '/dbNodes/{dbNodeId}/consoleHistories'.sub('{dbNodeId}', db_node_id.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]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_console_histories') 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::Database::Models::ConsoleHistoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_container_database_patches(autonomous_container_database_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the patches applicable to the requested container database.

Allowed values are: QUARTERLY, TIMEZONE

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :autonomous_patch_type (String) —

    Autonomous patch type, either "QUARTERLY" or "TIMEZONE". (default to QUARTERLY)

Returns:



19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
 
# File 'lib/oci/database/database_client.rb', line 19534

def list_container_database_patches(autonomous_container_database_id, compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_container_database_patches.' if logger

  raise "Missing the required parameter 'autonomous_container_database_id' when calling list_container_database_patches." if autonomous_container_database_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_container_database_patches." if compartment_id.nil?

  if opts[:autonomous_patch_type] && !%w[QUARTERLY TIMEZONE].include?(opts[:autonomous_patch_type])
    raise 'Invalid value for "autonomous_patch_type", must be one of QUARTERLY, TIMEZONE.'
  end
  raise "Parameter value for 'autonomous_container_database_id' must not be blank" if OCI::Internal::Util.blank_string?(autonomous_container_database_id)

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/patches'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:autonomousPatchType] = opts[:autonomous_patch_type] if opts[:autonomous_patch_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_container_database_patches') 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::Database::Models::AutonomousPatchSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_guard_associations(database_id, opts = {}) ⇒ Response

Note:

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

Lists all Data Guard associations for the specified database.

Parameters:

  • database_id (String) —

    The database 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
 
# File 'lib/oci/database/database_client.rb', line 19598

def list_data_guard_associations(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_data_guard_associations.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations'.sub('{databaseId}', database_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_data_guard_associations') 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::Database::Models::DataGuardAssociationSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_software_images(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the database software images in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Default order for PATCHSET is descending. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, PATCHSET

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :image_type (String) —

    A filter to return only resources that match the given image type exactly.

  • :image_shape_family (String) —

    A filter to return only resources that match the given image shape family exactly.

  • :patch_set_greater_than_or_equal_to (String) —

    A filter to return only resources with patchSet greater than or equal to given value.

  • :db_system_id (String) —

    The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • :is_upgrade_supported (BOOLEAN) —

    If provided, filters the results to the set of database versions which are supported for Upgrade.

Returns:



19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
 
# File 'lib/oci/database/database_client.rb', line 19668

def list_database_software_images(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_database_software_images.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_database_software_images." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME PATCHSET].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, PATCHSET.'
  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[:lifecycle_state] && !OCI::Database::Models::DatabaseSoftwareImageSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DatabaseSoftwareImageSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:image_type] && !OCI::Database::Models::DatabaseSoftwareImageSummary::IMAGE_TYPE_ENUM.include?(opts[:image_type])
    raise 'Invalid value for "image_type", must be one of the values in OCI::Database::Models::DatabaseSoftwareImageSummary::IMAGE_TYPE_ENUM.'
  end

  if opts[:image_shape_family] && !OCI::Database::Models::DatabaseSoftwareImageSummary::IMAGE_SHAPE_FAMILY_ENUM.include?(opts[:image_shape_family])
    raise 'Invalid value for "image_shape_family", must be one of the values in OCI::Database::Models::DatabaseSoftwareImageSummary::IMAGE_SHAPE_FAMILY_ENUM.'
  end

  path = '/databaseSoftwareImages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:imageType] = opts[:image_type] if opts[:image_type]
  query_params[:imageShapeFamily] = opts[:image_shape_family] if opts[:image_shape_family]
  query_params[:patchSetGreaterThanOrEqualTo] = opts[:patch_set_greater_than_or_equal_to] if opts[:patch_set_greater_than_or_equal_to]
  query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id]
  query_params[:isUpgradeSupported] = opts[:is_upgrade_supported] if !opts[:is_upgrade_supported].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_database_software_images') 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::Database::Models::DatabaseSoftwareImageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_upgrade_history_entries(database_id, opts = {}) ⇒ Response

Note:

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

Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.

Allowed values are: TIMESTARTED

Parameters:

  • database_id (String) —

    The database 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

  • :upgrade_action (String) —

    A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.

  • :lifecycle_state (String) —

    A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is ascending. (default to TIMESTARTED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
 
# File 'lib/oci/database/database_client.rb', line 19763

def list_database_upgrade_history_entries(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_database_upgrade_history_entries.' if logger

  raise "Missing the required parameter 'database_id' when calling list_database_upgrade_history_entries." if database_id.nil?

  if opts[:upgrade_action] && !OCI::Database::Models::DatabaseUpgradeHistoryEntrySummary::ACTION_ENUM.include?(opts[:upgrade_action])
    raise 'Invalid value for "upgrade_action", must be one of the values in OCI::Database::Models::DatabaseUpgradeHistoryEntrySummary::ACTION_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::DatabaseUpgradeHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DatabaseUpgradeHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMESTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMESTARTED.'
  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 'database_id' must not be blank" if OCI::Internal::Util.blank_string?(database_id)

  path = '/databases/{databaseId}/upgradeHistoryEntries'.sub('{databaseId}', database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:upgradeAction] = opts[:upgrade_action] if opts[:upgrade_action]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_database_upgrade_history_entries') 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::Database::Models::DatabaseUpgradeHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the databases in the specified Database Home.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :db_home_id (String) —

    A Database Home OCID.

  • :system_id (String) —

    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive. Allowed values are: DBNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :db_name (String) —

    A filter to return only resources that match the entire database name given. The match is not case sensitive.

Returns:



19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
 
# File 'lib/oci/database/database_client.rb', line 19849

def list_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_databases." if compartment_id.nil?

  if opts[:sort_by] && !%w[DBNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DBNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::DatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/databases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:dbHomeId] = opts[:db_home_id] if opts[:db_home_id]
  query_params[:systemId] = opts[:system_id] if opts[:system_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:dbName] = opts[:db_name] if opts[:db_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_databases') 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::Database::Models::DatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_connection_bundles(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists all database connection bundles that match the query parameters.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for TIMEREFRESHED is descending.

    Allowed values are: TIMECREATED, TIMEREFRESHED

  • :lifecycle_state (String) —

    A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED, FAILED

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :db_connection_bundle_type (String) —

    A filter that returns only resources that match the specified database connection bundle type. Allowed values are: TLS, MTLS

  • :associated_resource_id (String) —

    The OCID of the VM cluster associated with the connection bundle. If the parameter is set to null, all bundles are returned.

Returns:



19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
 
# File 'lib/oci/database/database_client.rb', line 19939

def list_db_connection_bundles(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_connection_bundles.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_connection_bundles." if compartment_id.nil?

  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 TIMEREFRESHED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, TIMEREFRESHED.'
  end

  if opts[:lifecycle_state] && !%w[CREATING ACTIVE INACTIVE UPDATING DELETING DELETED FAILED].include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED, FAILED.'
  end

  if opts[:db_connection_bundle_type] && !%w[TLS MTLS].include?(opts[:db_connection_bundle_type])
    raise 'Invalid value for "db_connection_bundle_type", must be one of TLS, MTLS.'
  end

  path = '/dbConnectionBundles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:dbConnectionBundleType] = opts[:db_connection_bundle_type] if opts[:db_connection_bundle_type]
  query_params[:associatedResourceId] = opts[:associated_resource_id] if opts[:associated_resource_id]

  # 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: 'DatabaseClient#list_db_connection_bundles') 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::Database::Models::DbConnectionBundleSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_home_patch_history_entries(db_home_id, opts = {}) ⇒ Response

Note:

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

Lists the history of patch operations on the specified Database Home.

Parameters:

  • db_home_id (String) —

    The Database Home 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
 
# File 'lib/oci/database/database_client.rb', line 20019

def list_db_home_patch_history_entries(db_home_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_home_patch_history_entries.' if logger

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

  path = '/dbHomes/{dbHomeId}/patchHistoryEntries'.sub('{dbHomeId}', db_home_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_home_patch_history_entries') 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::Database::Models::PatchHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_home_patches(db_home_id, opts = {}) ⇒ Response

Note:

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

Lists patches applicable to the requested Database Home.

Parameters:

  • db_home_id (String) —

    The Database Home 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
20090
20091
20092
20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
 
# File 'lib/oci/database/database_client.rb', line 20076

def list_db_home_patches(db_home_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_home_patches.' if logger

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

  path = '/dbHomes/{dbHomeId}/patches'.sub('{dbHomeId}', db_home_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_home_patches') 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::Database::Models::PatchSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_homes(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :db_system_id (String) —

    The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • :vm_cluster_id (String) —

    The OCID of the VM cluster.

  • :backup_id (String) —

    The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • :db_version (String) —

    A filter to return only DB Homes that match the specified dbVersion. (default to NONE)

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
20155
20156
20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
 
# File 'lib/oci/database/database_client.rb', line 20143

def list_db_homes(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_homes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_homes." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::DbHomeSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbHomeSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dbHomes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id]
  query_params[:vmClusterId] = opts[:vm_cluster_id] if opts[:vm_cluster_id]
  query_params[:backupId] = opts[:backup_id] if opts[:backup_id]
  query_params[:dbVersion] = opts[:db_version] if opts[:db_version]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_homes') 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::Database::Models::DbHomeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_nodes(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either '–db-system-id' or '–vm-cluster-id' also must be provided, depending on the service being accessed.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :db_system_id (String) —

    The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • :vm_cluster_id (String) —

    The OCID of the VM cluster.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    Sort by TIMECREATED. Default order for TIMECREATED is descending. Allowed values are: TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :db_server_id (String) —

    The OCID of the Exacc Db server.

Returns:



20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/oci/database/database_client.rb', line 20228

def list_db_nodes(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_nodes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_nodes." if compartment_id.nil?

  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

  if opts[:lifecycle_state] && !OCI::Database::Models::DbNodeSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbNodeSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dbNodes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id]
  query_params[:vmClusterId] = opts[:vm_cluster_id] if opts[:vm_cluster_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:dbServerId] = opts[:db_server_id] if opts[:db_server_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_nodes') 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::Database::Models::DbNodeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_servers(compartment_id, exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • exadata_infrastructure_id (String) —

    The OCID of the ExadataInfrastructure.

  • 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 per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    Sort by TIMECREATED. Default order for TIMECREATED is descending. Allowed values are: TIMECREATED

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
 
# File 'lib/oci/database/database_client.rb', line 20312

def list_db_servers(compartment_id, exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_servers.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_servers." if compartment_id.nil?
  raise "Missing the required parameter 'exadata_infrastructure_id' when calling list_db_servers." if exadata_infrastructure_id.nil?

  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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::DbServerSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbServerSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dbServers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:exadataInfrastructureId] = exadata_infrastructure_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_db_servers') 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::Database::Models::DbServerSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_compute_performances(opts = {}) ⇒ Response

Note:

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

Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration. Adding compartmentId does not affect results.

Parameters:

  • 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

  • :db_system_shape (String) —

    If provided, filters the results to the set of database versions which are supported for the given shape.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id (String) —

    The compartment OCID.

Returns:



20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
 
# File 'lib/oci/database/database_client.rb', line 20389

def list_db_system_compute_performances(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_compute_performances.' if logger


  path = '/dbSystemComputePerformance'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:dbSystemShape] = opts[:db_system_shape] if opts[:db_system_shape]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # 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: 'DatabaseClient#list_db_system_compute_performances') 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::Database::Models::DbSystemComputePerformanceSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_os_patch_history_entries(db_system_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the OS patch actions performed on the specified DB system.

Allowed values are: TIMESTARTED, ACTION

Parameters:

  • db_system_id (String) —

    The DB system 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMESTARTED is descending. (default to TIMESTARTED)

  • :lifecycle_state (String) —

    A filter to return only OS patch history entries that match the given lifecycle state exactly.

  • :action (String) —

    A filter to return only OS patch history entries that match the specified OS patch action.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
 
# File 'lib/oci/database/database_client.rb', line 20454

def list_db_system_os_patch_history_entries(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_os_patch_history_entries.' if logger

  raise "Missing the required parameter 'db_system_id' when calling list_db_system_os_patch_history_entries." if db_system_id.nil?

  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[TIMESTARTED ACTION].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMESTARTED, ACTION.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::DbSystemOsPatchHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbSystemOsPatchHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:action] && !OCI::Database::Models::DbSystemOsPatchHistoryEntrySummary::ACTION_ENUM.include?(opts[:action])
    raise 'Invalid value for "action", must be one of the values in OCI::Database::Models::DbSystemOsPatchHistoryEntrySummary::ACTION_ENUM.'
  end
  raise "Parameter value for 'db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(db_system_id)

  path = '/dbSystems/{dbSystemId}/osPatchHistoryEntries'.sub('{dbSystemId}', db_system_id.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]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:action] = opts[:action] if opts[:action]

  # 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: 'DatabaseClient#list_db_system_os_patch_history_entries') 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::Database::Models::DbSystemOsPatchHistoryEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_patch_history_entries(db_system_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the patch actions performed on the specified DB system.

Parameters:

  • db_system_id (String) —

    The DB system 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
 
# File 'lib/oci/database/database_client.rb', line 20532

def list_db_system_patch_history_entries(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_patch_history_entries.' if logger

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

  path = '/dbSystems/{dbSystemId}/patchHistoryEntries'.sub('{dbSystemId}', db_system_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_system_patch_history_entries') 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::Database::Models::PatchHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_patches(db_system_id, opts = {}) ⇒ Response

Note:

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

Lists the patches applicable to the specified DB system.

Parameters:

  • db_system_id (String) —

    The DB system 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
 
# File 'lib/oci/database/database_client.rb', line 20589

def list_db_system_patches(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_patches.' if logger

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

  path = '/dbSystems/{dbSystemId}/patches'.sub('{dbSystemId}', db_system_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_system_patches') 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::Database::Models::PatchSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_shapes(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :availability_domain (String) —

    The name of the Availability Domain.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :shape_attribute (String) —

    If provided and applicable, return DB System shape parameters based on the shapeAttribute provided

Returns:



20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
 
# File 'lib/oci/database/database_client.rb', line 20647

def list_db_system_shapes(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_shapes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_system_shapes." if compartment_id.nil?

  path = '/dbSystemShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:shapeAttribute] = opts[:shape_attribute] if opts[:shape_attribute]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_system_shapes') 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::Database::Models::DbSystemShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_storage_performances(storage_management, opts = {}) ⇒ Response

Note:

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

Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration.

Parameters:

  • storage_management (String) —

    The DB system storage management option. Used to list database versions available for that storage manager. Valid values are ASM and LVM. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager.

  • 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

  • :shape_type (String) —

    Optional. Filters the performance results by shape type.

  • :database_edition (String) —

    The database edition of quota (STANDARD_EDITION/ENTERPRISE_EDITION/ENTERPRISE_EDITION_HIGH_PERFORMANCE/ENTERPRISE_EDITION_EXTREME_PERFORMANCE/ENTERPRISE_EDITION_DEVELOPER) Allowed values are: STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id (String) —

    The compartment OCID.

Returns:



20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
 
# File 'lib/oci/database/database_client.rb', line 20713

def list_db_system_storage_performances(storage_management, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_storage_performances.' if logger

  raise "Missing the required parameter 'storage_management' when calling list_db_system_storage_performances." if storage_management.nil?
  unless OCI::Database::Models::DbSystemOptions::STORAGE_MANAGEMENT_ENUM.include?(storage_management)
    raise 'Invalid value for "storage_management", must be one of the values in OCI::Database::Models::DbSystemOptions::STORAGE_MANAGEMENT_ENUM.'
  end


  if opts[:database_edition] && !%w[STANDARD_EDITION ENTERPRISE_EDITION ENTERPRISE_EDITION_HIGH_PERFORMANCE ENTERPRISE_EDITION_EXTREME_PERFORMANCE ENTERPRISE_EDITION_DEVELOPER].include?(opts[:database_edition])
    raise 'Invalid value for "database_edition", must be one of STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER.'
  end

  path = '/dbSystemStoragePerformance'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:storageManagement] = storage_management
  query_params[:shapeType] = opts[:shape_type] if opts[:shape_type]
  query_params[:databaseEdition] = opts[:database_edition] if opts[:database_edition]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # 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: 'DatabaseClient#list_db_system_storage_performances') 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::Database::Models::DbSystemStoragePerformanceSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_upgrade_history_entries(db_system_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the upgrade actions performed on the specified DB system.

Allowed values are: TIMESTARTED

Parameters:

  • db_system_id (String) —

    The DB system 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is ascending. (default to TIMESTARTED)

  • :upgrade_action (String) —

    A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.

  • :lifecycle_state (String) —

    A filter to return only upgrade history entries that match the given lifecycle state exactly.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
 
# File 'lib/oci/database/database_client.rb', line 20789

def list_db_system_upgrade_history_entries(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_upgrade_history_entries.' if logger

  raise "Missing the required parameter 'db_system_id' when calling list_db_system_upgrade_history_entries." if db_system_id.nil?

  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[TIMESTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMESTARTED.'
  end

  if opts[:upgrade_action] && !OCI::Database::Models::DbSystemUpgradeHistoryEntrySummary::ACTION_ENUM.include?(opts[:upgrade_action])
    raise 'Invalid value for "upgrade_action", must be one of the values in OCI::Database::Models::DbSystemUpgradeHistoryEntrySummary::ACTION_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::DbSystemUpgradeHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbSystemUpgradeHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(db_system_id)

  path = '/dbSystems/{dbSystemId}/upgradeHistoryEntries'.sub('{dbSystemId}', db_system_id.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]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:upgradeAction] = opts[:upgrade_action] if opts[:upgrade_action]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # 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: 'DatabaseClient#list_db_system_upgrade_history_entries') 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::Database::Models::DbSystemUpgradeHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_system_upgrades(db_system_id, opts = {}) ⇒ Response

Note:

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

Lists the applicable upgrade components for a DB systems.

Parameters:

  • db_system_id (String) —

    The DB system 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
 
# File 'lib/oci/database/database_client.rb', line 20867

def list_db_system_upgrades(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_system_upgrades.' if logger

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

  path = '/dbSystems/{dbSystemId}/dbSystemUpgrades'.sub('{dbSystemId}', db_system_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_system_upgrades') 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::Database::Models::DbSystemUpgradeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_systems(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :backup_id (String) —

    The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
 
# File 'lib/oci/database/database_client.rb', line 20939

def list_db_systems(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_systems.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_systems." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::DbSystemSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbSystemSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dbSystems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:backupId] = opts[:backup_id] if opts[:backup_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_systems') 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::Database::Models::DbSystemSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_db_versions(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Oracle Database versions.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :db_system_shape (String) —

    If provided, filters the results to the set of database versions which are supported for the given shape.

  • :db_system_id (String) —

    The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

  • :storage_management (String) —

    The DB system storage management option. Used to list database versions available for that storage manager. Valid values are ASM and LVM. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager.

  • :shape_attribute (String) —

    If provided and applicable, return DB System shape parameters based on the shapeAttribute provided

  • :is_upgrade_supported (BOOLEAN) —

    If provided, filters the results to the set of database versions which are supported for Upgrade.

  • :is_database_software_image_supported (BOOLEAN) —

    If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images.

Returns:



21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
 
# File 'lib/oci/database/database_client.rb', line 21022

def list_db_versions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_db_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_db_versions." if compartment_id.nil?

  if opts[:storage_management] && !OCI::Database::Models::DbSystemOptions::STORAGE_MANAGEMENT_ENUM.include?(opts[:storage_management])
    raise 'Invalid value for "storage_management", must be one of the values in OCI::Database::Models::DbSystemOptions::STORAGE_MANAGEMENT_ENUM.'
  end

  path = '/dbVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:dbSystemShape] = opts[:db_system_shape] if opts[:db_system_shape]
  query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id]
  query_params[:storageManagement] = opts[:storage_management] if opts[:storage_management]
  query_params[:shapeAttribute] = opts[:shape_attribute] if opts[:shape_attribute]
  query_params[:isUpgradeSupported] = opts[:is_upgrade_supported] if !opts[:is_upgrade_supported].nil?
  query_params[:isDatabaseSoftwareImageSupported] = opts[:is_database_software_image_supported] if !opts[:is_database_software_image_supported].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_db_versions') 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::Database::Models::DbVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_dbnode_snapshots(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the Exadata Database Node Snapshots in the specified compartment.

Allowed values are: TIMECREATED, NAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. (default to TIMECREATED)

  • :name (String) —

    A filter to return only resources that match the entire name given. The match is not case sensitive.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only Exadata Database Snapshots that match the given lifecycle state exactly.

  • :cluster_id (String) —

    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.

  • :source_dbnode_id (String) —

    A filter to return only Exadata Database Snapshots that match the given database node.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
 
# File 'lib/oci/database/database_client.rb', line 21100

def list_dbnode_snapshots(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_dbnode_snapshots.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_dbnode_snapshots." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  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[:lifecycle_state] && !OCI::Database::Models::DbnodeSnapshot::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::DbnodeSnapshot::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dbnodeSnapshots'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:clusterId] = opts[:cluster_id] if opts[:cluster_id]
  query_params[:sourceDbnodeId] = opts[:source_dbnode_id] if opts[:source_dbnode_id]

  # 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: 'DatabaseClient#list_dbnode_snapshots') 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::Database::Models::DbnodeSnapshotSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_estimate_cost_savings(is_cpu_autoscale, autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Gets the estimate cost savings of the Autonomous AI Database.

Parameters:

  • is_cpu_autoscale (BOOLEAN) —

    If provided as true, cost estimate with cpu autoscaling.

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



21178
21179
21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
 
# File 'lib/oci/database/database_client.rb', line 21178

def list_estimate_cost_savings(is_cpu_autoscale, autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_estimate_cost_savings.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/estimateCostSavings'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isCpuAutoscale] = is_cpu_autoscale
  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: 'DatabaseClient#list_estimate_cost_savings') 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::Database::Models::EstimateCostSavingsSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_exadata_infrastructures(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the list_cloud_exadata_infrastructures operation.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :excluded_fields (Array<String>) —

    If provided, the specified fields will be excluded in the response. Allowed values are: multiRackConfigurationFile

Returns:



21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
 
# File 'lib/oci/database/database_client.rb', line 21250

def list_exadata_infrastructures(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_exadata_infrastructures.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_exadata_infrastructures." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExadataInfrastructureSummary::LIFECYCLE_STATE_ENUM.'
  end


  excluded_fields_allowable_values = %w[multiRackConfigurationFile]
  if opts[:excluded_fields] && !opts[:excluded_fields].empty?
    opts[:excluded_fields].each do |val_to_check|
      unless excluded_fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "excluded_fields", must be one of multiRackConfigurationFile.'
      end
    end
  end

  path = '/exadataInfrastructures'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:excludedFields] = OCI::ApiClient.build_collection_params(opts[:excluded_fields], :multi) if opts[:excluded_fields] && !opts[:excluded_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: 'DatabaseClient#list_exadata_infrastructures') 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::Database::Models::ExadataInfrastructureSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_exadb_vm_cluster_update_history_entries(exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. (default to GI_UPGRADE) Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
21376
21377
21378
21379
21380
21381
21382
 
# File 'lib/oci/database/database_client.rb', line 21339

def list_exadb_vm_cluster_update_history_entries(exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_exadb_vm_cluster_update_history_entries.' if logger

  raise "Missing the required parameter 'exadb_vm_cluster_id' when calling list_exadb_vm_cluster_update_history_entries." if exadb_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end
  raise "Parameter value for 'exadb_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(exadb_vm_cluster_id)

  path = '/exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries'.sub('{exadbVmClusterId}', exadb_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  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: 'DatabaseClient#list_exadb_vm_cluster_update_history_entries') 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::Database::Models::ExadbVmClusterUpdateHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_exadb_vm_cluster_updates(exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. (default to GI_UPGRADE) Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :version (String) —

    A filter to return only resources that match the given update version exactly.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
 
# File 'lib/oci/database/database_client.rb', line 21407

def list_exadb_vm_cluster_updates(exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_exadb_vm_cluster_updates.' if logger

  raise "Missing the required parameter 'exadb_vm_cluster_id' when calling list_exadb_vm_cluster_updates." if exadb_vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end
  raise "Parameter value for 'exadb_vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(exadb_vm_cluster_id)

  path = '/exadbVmClusters/{exadbVmClusterId}/updates'.sub('{exadbVmClusterId}', exadb_vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  query_params[:version] = opts[:version] if opts[:version]
  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: 'DatabaseClient#list_exadb_vm_cluster_updates') 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::Database::Models::ExadbVmClusterUpdateSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_exadb_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly.

  • :exascale_db_storage_vault_id (String) —

    A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID.

  • :cluster_placement_group_id (String) —

    A filter to return only resources that match the given cluster placement group ID exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
 
# File 'lib/oci/database/database_client.rb', line 21484

def list_exadb_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_exadb_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_exadb_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExadbVmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExadbVmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/exadbVmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:exascaleDbStorageVaultId] = opts[:exascale_db_storage_vault_id] if opts[:exascale_db_storage_vault_id]
  query_params[:clusterPlacementGroupId] = opts[:cluster_placement_group_id] if opts[:cluster_placement_group_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_exadb_vm_clusters') 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::Database::Models::ExadbVmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_exascale_db_storage_vaults(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the Exadata Database Storage Vaults in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly.

  • :cluster_placement_group_id (String) —

    A filter to return only resources that match the given cluster placement group ID exactly.

  • :attached_shape_attributes_not_equal_to (String) —

    A filter to return only Exadata Database Storage Vaults which do not match the given attachedShapeAttributes

  • :attached_shape_attributes (String) —

    A filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes

  • :vm_cluster_count_less_than_or_equal_to (Integer) —

    A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters less than or equal to the given count

  • :vm_cluster_count_greater_than_or_equal_to (Integer) —

    A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters greater than or equal to the given count

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :exadata_infrastructure_id (String) —

    A filter to return only list of Vaults that are linked to the exadata infrastructure Id.

Returns:



21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
 
# File 'lib/oci/database/database_client.rb', line 21575

def list_exascale_db_storage_vaults(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_exascale_db_storage_vaults.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_exascale_db_storage_vaults." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExascaleDbStorageVault::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExascaleDbStorageVault::LIFECYCLE_STATE_ENUM.'
  end

  path = '/exascaleDbStorageVaults'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:clusterPlacementGroupId] = opts[:cluster_placement_group_id] if opts[:cluster_placement_group_id]
  query_params[:attachedShapeAttributesNotEqualTo] = opts[:attached_shape_attributes_not_equal_to] if opts[:attached_shape_attributes_not_equal_to]
  query_params[:attachedShapeAttributes] = opts[:attached_shape_attributes] if opts[:attached_shape_attributes]
  query_params[:vmClusterCountLessThanOrEqualTo] = opts[:vm_cluster_count_less_than_or_equal_to] if opts[:vm_cluster_count_less_than_or_equal_to]
  query_params[:vmClusterCountGreaterThanOrEqualTo] = opts[:vm_cluster_count_greater_than_or_equal_to] if opts[:vm_cluster_count_greater_than_or_equal_to]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:exadataInfrastructureId] = opts[:exadata_infrastructure_id] if opts[:exadata_infrastructure_id]

  # 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: 'DatabaseClient#list_exascale_db_storage_vaults') 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::Database::Models::ExascaleDbStorageVaultSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_execution_actions(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the execution action resources in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :execution_window_id (String) —

    A filter to return only resources that match the given execution wondow id.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
 
# File 'lib/oci/database/database_client.rb', line 21665

def list_execution_actions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_execution_actions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_execution_actions." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExecutionActionSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExecutionActionSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/executionActions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:executionWindowId] = opts[:execution_window_id] if opts[:execution_window_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_execution_actions') 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::Database::Models::ExecutionActionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_execution_windows(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the execution window resources in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED)

  • :execution_resource_id (String) —

    A filter to return only resources that match the given resource id exactly.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
 
# File 'lib/oci/database/database_client.rb', line 21750

def list_execution_windows(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_execution_windows.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_execution_windows." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExecutionWindowSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExecutionWindowSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/executionWindows'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:executionResourceId] = opts[:execution_resource_id] if opts[:execution_resource_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_execution_windows') 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::Database::Models::ExecutionWindowSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_container_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the external container databases in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: DISPLAYNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
 
# File 'lib/oci/database/database_client.rb', line 21837

def list_external_container_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_external_container_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_container_databases." if compartment_id.nil?

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.'
  end

  path = '/externalcontainerdatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_external_container_databases') 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::Database::Models::ExternalContainerDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_database_connectors(compartment_id, external_database_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the external database connectors in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • external_database_id (String) —

    The OCID of the external database whose connectors will be listed.

  • 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.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: DISPLAYNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
 
# File 'lib/oci/database/database_client.rb', line 21925

def list_external_database_connectors(compartment_id, external_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_external_database_connectors.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_database_connectors." if compartment_id.nil?
  raise "Missing the required parameter 'external_database_id' when calling list_external_database_connectors." if external_database_id.nil?

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExternalDatabaseConnector::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExternalDatabaseConnector::LIFECYCLE_STATE_ENUM.'
  end

  path = '/externaldatabaseconnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:externalDatabaseId] = external_database_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_external_database_connectors') 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::Database::Models::ExternalDatabaseConnectorSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_non_container_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the ExternalNonContainerDatabases in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: DISPLAYNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
 
# File 'lib/oci/database/database_client.rb', line 22013

def list_external_non_container_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_external_non_container_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_non_container_databases." if compartment_id.nil?

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.'
  end

  path = '/externalnoncontainerdatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_external_non_container_databases') 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::Database::Models::ExternalNonContainerDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_pluggable_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the create_external_pluggable_database_details resources in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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) —

    Unique identifier for the request.

  • :external_container_database_id (String) —

    The ExternalContainerDatabase OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: DISPLAYNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
22135
22136
22137
22138
22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
 
# File 'lib/oci/database/database_client.rb', line 22101

def list_external_pluggable_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_external_pluggable_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_external_pluggable_databases." if compartment_id.nil?

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ExternalDatabaseBase::LIFECYCLE_STATE_ENUM.'
  end

  path = '/externalpluggabledatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:externalContainerDatabaseId] = opts[:external_container_database_id] if opts[:external_container_database_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_external_pluggable_databases') 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::Database::Models::ExternalPluggableDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_flex_components(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :name (String) —

    A filter to return only resources that match the entire name given. The match is not case sensitive.

  • :shape (String) —

    A filter to return only resources that belong to the entire shape name given. The match is not case sensitive.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for NAME is ascending. The NAME sort order is case sensitive.

    Allowed values are: NAME

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
 
# File 'lib/oci/database/database_client.rb', line 22182

def list_flex_components(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_flex_components.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_flex_components." if compartment_id.nil?

  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[NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of NAME.'
  end

  path = '/dbSystemShapes/flexComponents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:shape] = opts[:shape] if opts[:shape]
  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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_flex_components') 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::Database::Models::FlexComponentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_gi_version_minor_versions(version, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family.

Parameters:

  • version (String) —

    The Oracle Grid Infrastructure major version.

  • 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

  • :availability_domain (String) —

    The target availability domain. Only passed if the limit is AD-specific.

  • :compartment_id (String) —

    The compartment OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :exadata_infrastructure_id (String) —

    If provided, filters the results for the given Exadata Infrastructure. (default to default)

  • :shape_family (String) —

    If provided, filters the results to the set of database versions which are supported for the given shape family. Allowed values are: SINGLENODE, YODA, VIRTUALMACHINE, EXADATA, EXACC, EXADB_XS

  • :is_gi_version_for_provisioning (BOOLEAN) —

    If true, returns the Grid Infrastructure versions that can be used for provisioning a cluster (default to false)

  • :shape (String) —

    If provided, filters the results for the given shape. (default to default)

  • :sort_by (String) —

    Sort by VERSION. Default order for VERSION is descending. Allowed values are: VERSION

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
 
# File 'lib/oci/database/database_client.rb', line 22263

def list_gi_version_minor_versions(version, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_gi_version_minor_versions.' if logger

  raise "Missing the required parameter 'version' when calling list_gi_version_minor_versions." if version.nil?

  if opts[:shape_family] && !%w[SINGLENODE YODA VIRTUALMACHINE EXADATA EXACC EXADB_XS].include?(opts[:shape_family])
    raise 'Invalid value for "shape_family", must be one of SINGLENODE, YODA, VIRTUALMACHINE, EXADATA, EXACC, EXADB_XS.'
  end

  if opts[:sort_by] && !%w[VERSION].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of VERSION.'
  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 'version' must not be blank" if OCI::Internal::Util.blank_string?(version)

  path = '/giVersions/{version}/minorVersions'.sub('{version}', version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:exadataInfrastructureId] = opts[:exadata_infrastructure_id] if opts[:exadata_infrastructure_id]
  query_params[:shapeFamily] = opts[:shape_family] if opts[:shape_family]
  query_params[:isGiVersionForProvisioning] = opts[:is_gi_version_for_provisioning] if !opts[:is_gi_version_for_provisioning].nil?
  query_params[:shape] = opts[:shape] if opts[:shape]
  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: 'DatabaseClient#list_gi_version_minor_versions') 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::Database::Models::GiMinorVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_gi_versions(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of supported GI versions.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :shape (String) —

    If provided, filters the results for the given shape. (default to default)

  • :availability_domain (String) —

    The target availability domain. Only passed if the limit is AD-specific.

  • :resource_id (String) —

    If provided, filters the results for the specified resource Id.

  • :shape_attribute (String) —

    If provided and applicable, return DB System shape parameters based on the shapeAttribute provided

Returns:



22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
 
# File 'lib/oci/database/database_client.rb', line 22346

def list_gi_versions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_gi_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_gi_versions." if compartment_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/giVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:shape] = opts[:shape] if opts[:shape]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:shapeAttribute] = opts[:shape_attribute] if opts[:shape_attribute]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_gi_versions') 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::Database::Models::GiVersionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_key_stores(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of key stores in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
22452
 
# File 'lib/oci/database/database_client.rb', line 22414

def list_key_stores(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_key_stores.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_key_stores." if compartment_id.nil?

  path = '/keyStores'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  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: 'DatabaseClient#list_key_stores') 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::Database::Models::KeyStoreSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_maintenance_run_history(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the maintenance run histories in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :target_resource_id (String) —

    The target resource ID.

  • :target_resource_type (String) —

    The type of the target resource.

  • :maintenance_type (String) —

    The maintenance type.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIME_SCHEDULED, TIME_ENDED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    The state of the maintenance run history.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :maintenance_subtype (String) —

    The sub-type of the maintenance run.

Returns:



22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
22553
22554
 
# File 'lib/oci/database/database_client.rb', line 22485

def list_maintenance_run_history(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_maintenance_run_history.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_maintenance_run_history." if compartment_id.nil?

  if opts[:target_resource_type] && !OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.include?(opts[:target_resource_type])
    raise 'Invalid value for "target_resource_type", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.'
  end

  if opts[:maintenance_type] && !OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_TYPE_ENUM.include?(opts[:maintenance_type])
    raise 'Invalid value for "maintenance_type", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_TYPE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIME_SCHEDULED TIME_ENDED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_SCHEDULED, TIME_ENDED, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::MaintenanceRunSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:maintenance_subtype] && !OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_SUBTYPE_ENUM.include?(opts[:maintenance_subtype])
    raise 'Invalid value for "maintenance_subtype", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_SUBTYPE_ENUM.'
  end

  path = '/maintenanceRunHistory'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetResourceId] = opts[:target_resource_id] if opts[:target_resource_id]
  query_params[:targetResourceType] = opts[:target_resource_type] if opts[:target_resource_type]
  query_params[:maintenanceType] = opts[:maintenance_type] if opts[:maintenance_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:maintenanceSubtype] = opts[:maintenance_subtype] if opts[:maintenance_subtype]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_maintenance_run_history') 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::Database::Models::MaintenanceRunHistorySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_maintenance_runs(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the maintenance runs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :target_resource_id (String) —

    The target resource ID.

  • :target_resource_type (String) —

    The type of the target resource.

  • :maintenance_type (String) —

    The maintenance type.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :is_local_adg (BOOLEAN) —

    A filter to return the maintenance history results for the local standby Autonomous AI Database Serverless only. (default to false)

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIME_SCHEDULED, TIME_ENDED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :availability_domain (String) —

    A filter to return only resources that match the given availability domain exactly.

  • :maintenance_subtype (String) —

    The sub-type of the maintenance run.

Returns:



22588
22589
22590
22591
22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
22603
22604
22605
22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
22658
 
# File 'lib/oci/database/database_client.rb', line 22588

def list_maintenance_runs(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_maintenance_runs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_maintenance_runs." if compartment_id.nil?

  if opts[:target_resource_type] && !OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.include?(opts[:target_resource_type])
    raise 'Invalid value for "target_resource_type", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::TARGET_RESOURCE_TYPE_ENUM.'
  end

  if opts[:maintenance_type] && !OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_TYPE_ENUM.include?(opts[:maintenance_type])
    raise 'Invalid value for "maintenance_type", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_TYPE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIME_SCHEDULED TIME_ENDED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_SCHEDULED, TIME_ENDED, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::MaintenanceRunSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:maintenance_subtype] && !OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_SUBTYPE_ENUM.include?(opts[:maintenance_subtype])
    raise 'Invalid value for "maintenance_subtype", must be one of the values in OCI::Database::Models::MaintenanceRunSummary::MAINTENANCE_SUBTYPE_ENUM.'
  end

  path = '/maintenanceRuns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetResourceId] = opts[:target_resource_id] if opts[:target_resource_id]
  query_params[:targetResourceType] = opts[:target_resource_type] if opts[:target_resource_type]
  query_params[:maintenanceType] = opts[:maintenance_type] if opts[:maintenance_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:isLocalAdg] = opts[:is_local_adg] if !opts[:is_local_adg].nil?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:maintenanceSubtype] = opts[:maintenance_subtype] if opts[:maintenance_subtype]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_maintenance_runs') 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::Database::Models::MaintenanceRunSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_oneoff_patches(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists one-off patches in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22687
22688
22689
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
22701
22702
22703
22704
22705
22706
22707
22708
22709
22710
22711
22712
22713
22714
22715
22716
22717
22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
 
# File 'lib/oci/database/database_client.rb', line 22687

def list_oneoff_patches(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_oneoff_patches.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_oneoff_patches." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::OneoffPatchSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::OneoffPatchSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/oneoffPatches'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_oneoff_patches') 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::Database::Models::OneoffPatchSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_params_for_action_type(type, opts = {}) ⇒ Response

Note:

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

List all the action params and their possible values for a given action type

Parameters:

  • type (String) —

    The type of the scheduled action

  • 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

  • :plan_intent (String) —

    The plan intent the action will be used for. Relevant to action type that can be used in multiple plans Allowed values are: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22765
22766
22767
22768
22769
22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
22783
22784
22785
22786
22787
22788
22789
22790
22791
22792
22793
22794
22795
22796
22797
22798
22799
22800
22801
22802
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
 
# File 'lib/oci/database/database_client.rb', line 22765

def list_params_for_action_type(type, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_params_for_action_type.' if logger

  raise "Missing the required parameter 'type' when calling list_params_for_action_type." if type.nil?
  unless OCI::Database::Models::RecommendedScheduledActionSummary::ACTION_TYPE_ENUM.include?(type)
    raise 'Invalid value for "type", must be one of the values in OCI::Database::Models::RecommendedScheduledActionSummary::ACTION_TYPE_ENUM.'
  end


  if opts[:plan_intent] && !%w[EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE EXADATA_INFRASTRUCTURE_SECURITY_UPDATE].include?(opts[:plan_intent])
    raise 'Invalid value for "plan_intent", must be one of EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE.'
  end

  path = '/scheduledActionParams'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:type] = type
  query_params[:planIntent] = opts[:plan_intent] if opts[:plan_intent]
  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: 'DatabaseClient#list_params_for_action_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::Database::Models::ActionParamValuesCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pdb_conversion_history_entries(database_id, opts = {}) ⇒ Response

Note:

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

Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system.

Allowed values are: TIMESTARTED

Parameters:

  • database_id (String) —

    The database 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

  • :pdb_conversion_action (String) —

    A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation.

  • :lifecycle_state (String) —

    A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the "failed" lifecycle state.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). The default order for TIMECREATED is ascending. (default to TIMESTARTED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



22841
22842
22843
22844
22845
22846
22847
22848
22849
22850
22851
22852
22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
22867
22868
22869
22870
22871
22872
22873
22874
22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
 
# File 'lib/oci/database/database_client.rb', line 22841

def list_pdb_conversion_history_entries(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_pdb_conversion_history_entries.' if logger

  raise "Missing the required parameter 'database_id' when calling list_pdb_conversion_history_entries." if database_id.nil?

  if opts[:pdb_conversion_action] && !OCI::Database::Models::PdbConversionHistoryEntrySummary::ACTION_ENUM.include?(opts[:pdb_conversion_action])
    raise 'Invalid value for "pdb_conversion_action", must be one of the values in OCI::Database::Models::PdbConversionHistoryEntrySummary::ACTION_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::PdbConversionHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::PdbConversionHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[TIMESTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMESTARTED.'
  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 'database_id' must not be blank" if OCI::Internal::Util.blank_string?(database_id)

  path = '/databases/{databaseId}/pdbConversionHistoryEntries'.sub('{databaseId}', database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:pdbConversionAction] = opts[:pdb_conversion_action] if opts[:pdb_conversion_action]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_pdb_conversion_history_entries') 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::Database::Models::PdbConversionHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pluggable_database_snapshots(opts = {}) ⇒ Response

Note:

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

Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment.

Allowed values are: TIMECREATED, NAME

Parameters:

  • 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

  • :compartment_id (String) —

    The compartment OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. (default to TIMECREATED)

  • :name (String) —

    A filter to return only resources that match the entire name given. The match is not case sensitive.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.

  • :cluster_id (String) —

    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.

  • :pluggable_database_id (String) —

    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22930
22931
22932
22933
22934
22935
22936
22937
22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
 
# File 'lib/oci/database/database_client.rb', line 22930

def list_pluggable_database_snapshots(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_pluggable_database_snapshots.' if logger


  if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.'
  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[:lifecycle_state] && !OCI::Database::Models::PluggableDatabaseSnapshot::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::PluggableDatabaseSnapshot::LIFECYCLE_STATE_ENUM.'
  end

  path = '/pluggableDatabaseSnapshots'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:clusterId] = opts[:cluster_id] if opts[:cluster_id]
  query_params[:pluggableDatabaseId] = opts[:pluggable_database_id] if opts[:pluggable_database_id]

  # 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: 'DatabaseClient#list_pluggable_database_snapshots') 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::Database::Models::PluggableDatabaseSnapshotSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pluggable_databases(opts = {}) ⇒ Response

Note:

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

Gets a list of the pluggable databases in a database or compartment. You must provide either a databaseId or compartmentId value.

Parameters:

  • 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

  • :compartment_id (String) —

    The compartment OCID.

  • :database_id (String) —

    The OCID of the database.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: PDBNAME, TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :pdb_name (String) —

    A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

Returns:



23012
23013
23014
23015
23016
23017
23018
23019
23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
23030
23031
23032
23033
23034
23035
23036
23037
23038
23039
23040
23041
23042
23043
23044
23045
23046
23047
23048
23049
23050
23051
23052
23053
23054
23055
23056
23057
23058
23059
23060
23061
23062
23063
23064
23065
 
# File 'lib/oci/database/database_client.rb', line 23012

def list_pluggable_databases(opts = {})
  logger.debug 'Calling operation DatabaseClient#list_pluggable_databases.' if logger


  if opts[:sort_by] && !%w[PDBNAME TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of PDBNAME, 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

  if opts[:lifecycle_state] && !OCI::Database::Models::PluggableDatabaseSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::PluggableDatabaseSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/pluggableDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:pdbName] = opts[:pdb_name] if opts[:pdb_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_pluggable_databases') 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::Database::Models::PluggableDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_recommended_scheduled_actions(scheduling_policy_id, scheduling_policy_target_resource_id, plan_intent, opts = {}) ⇒ Response

Note:

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

Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy OCID.

  • scheduling_policy_target_resource_id (String) —

    The target resource OCID the scheduled actions will be for.

  • plan_intent (String) —

    The scheduling plan intent the scheduled actions will be for. Allowed values are: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE

  • 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 per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
23127
23128
23129
23130
23131
23132
23133
23134
23135
 
# File 'lib/oci/database/database_client.rb', line 23090

def list_recommended_scheduled_actions(scheduling_policy_id, scheduling_policy_target_resource_id, plan_intent, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_recommended_scheduled_actions.' if logger

  raise "Missing the required parameter 'scheduling_policy_id' when calling list_recommended_scheduled_actions." if scheduling_policy_id.nil?
  raise "Missing the required parameter 'scheduling_policy_target_resource_id' when calling list_recommended_scheduled_actions." if scheduling_policy_target_resource_id.nil?
  raise "Missing the required parameter 'plan_intent' when calling list_recommended_scheduled_actions." if plan_intent.nil?
  unless %w[EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE EXADATA_INFRASTRUCTURE_SECURITY_UPDATE].include?(plan_intent)
    raise "Invalid value for 'plan_intent', must be one of EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE."
  end
  raise "Parameter value for 'scheduling_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduling_policy_id)

  path = '/schedulingPolicies/{schedulingPolicyId}/recommendedScheduledActions'.sub('{schedulingPolicyId}', scheduling_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schedulingPolicyTargetResourceId] = scheduling_policy_target_resource_id
  query_params[:planIntent] = plan_intent
  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: 'DatabaseClient#list_recommended_scheduled_actions') 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::Database::Models::RecommendedScheduledActionsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_pool_members(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



23157
23158
23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
23169
23170
23171
23172
23173
23174
23175
23176
23177
23178
23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
 
# File 'lib/oci/database/database_client.rb', line 23157

def list_resource_pool_members(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_resource_pool_members.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/resourcePoolMembers'.sub('{autonomousDatabaseId}', autonomous_database_id.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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_resource_pool_members') 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::Database::Models::ResourcePoolMemberCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduled_actions(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the Scheduled Action resources in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :service_type (String) —

    A filter to return only resources that match the given service type exactly.

  • :scheduling_plan_id (String) —

    A filter to return only resources that match the given scheduling policy id exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. (default to TIMECREATED)

  • :id (String) —

    A filter to return only resources that match the given Scheduled Action id exactly.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

Returns:



23227
23228
23229
23230
23231
23232
23233
23234
23235
23236
23237
23238
23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
 
# File 'lib/oci/database/database_client.rb', line 23227

def list_scheduled_actions(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_scheduled_actions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_scheduled_actions." if compartment_id.nil?

  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

  if opts[:lifecycle_state] && !OCI::Database::Models::ScheduledActionSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::ScheduledActionSummary::LIFECYCLE_STATE_ENUM.'
  end

  path = '/scheduledActions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:serviceType] = opts[:service_type] if opts[:service_type]
  query_params[:schedulingPlanId] = opts[:scheduling_plan_id] if opts[:scheduling_plan_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # 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: 'DatabaseClient#list_scheduled_actions') 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::Database::Models::ScheduledActionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduling_plans(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the Scheduling Plan resources in the specified compartment.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :scheduling_policy_id (String) —

    A filter to return only resources that match the given scheduling policy id exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :resource_id (String) —

    A filter to return only resources that match the given resource id exactly.

  • :id (String) —

    A filter to return only resources that match the given Schedule Plan id exactly.

  • :plan_intent (String) —

    A filter to return only resources that match the given plan intent exactly. Allowed values are: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE

Returns:



23318
23319
23320
23321
23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
23369
23370
23371
23372
23373
23374
23375
23376
23377
23378
23379
23380
 
# File 'lib/oci/database/database_client.rb', line 23318

def list_scheduling_plans(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_scheduling_plans.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_scheduling_plans." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::SchedulingPlanSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::SchedulingPlanSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:plan_intent] && !%w[EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE EXADATA_INFRASTRUCTURE_SECURITY_UPDATE].include?(opts[:plan_intent])
    raise 'Invalid value for "plan_intent", must be one of EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE.'
  end

  path = '/schedulingPlans'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:schedulingPolicyId] = opts[:scheduling_policy_id] if opts[:scheduling_policy_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:planIntent] = opts[:plan_intent] if opts[:plan_intent]

  # 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: 'DatabaseClient#list_scheduling_plans') 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::Database::Models::SchedulingPlanCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduling_policies(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the Scheduling Policy resources in the specified compartment.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :cadence (String) —

    A filter to return only resources that match the given cadence period exactly.

Returns:



23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
23450
23451
23452
23453
23454
23455
23456
23457
23458
23459
23460
23461
23462
23463
23464
23465
23466
23467
23468
23469
 
# File 'lib/oci/database/database_client.rb', line 23410

def list_scheduling_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_scheduling_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_scheduling_policies." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::SchedulingPolicySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::SchedulingPolicySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:cadence] && !OCI::Database::Models::SchedulingPolicySummary::CADENCE_ENUM.include?(opts[:cadence])
    raise 'Invalid value for "cadence", must be one of the values in OCI::Database::Models::SchedulingPolicySummary::CADENCE_ENUM.'
  end

  path = '/schedulingPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:cadence] = opts[:cadence] if opts[:cadence]

  # 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: 'DatabaseClient#list_scheduling_policies') 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::Database::Models::SchedulingPolicySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduling_windows(scheduling_policy_id, opts = {}) ⇒ Response

Note:

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

Lists the Scheduling Window resources in the specified compartment.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy 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

  • :compartment_id (String) —

    The compartment OCID.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

Returns:



23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
23510
23511
23512
23513
23514
23515
23516
23517
23518
23519
23520
23521
23522
23523
23524
23525
23526
23527
23528
23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
 
# File 'lib/oci/database/database_client.rb', line 23499

def list_scheduling_windows(scheduling_policy_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_scheduling_windows.' if logger

  raise "Missing the required parameter 'scheduling_policy_id' when calling list_scheduling_windows." if scheduling_policy_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

  if opts[:lifecycle_state] && !OCI::Database::Models::SchedulingWindowSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::SchedulingWindowSummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'scheduling_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduling_policy_id)

  path = '/schedulingPolicies/{schedulingPolicyId}/schedulingWindows'.sub('{schedulingPolicyId}', scheduling_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_scheduling_windows') 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::Database::Models::SchedulingWindowSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_system_version_minor_versions(major_version, compartment_id, gi_version, opts = {}) ⇒ Response

Note:

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

Retrieves a list of supported minor versions for the specified Exadata System Software major version. You must provide either a shape or resourceId value.

Parameters:

  • major_version (String) —

    The System major version.

  • compartment_id (String) —

    The compartment OCID.

  • gi_version (String) —

    Specifies gi version query 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :shape (String) —

    If provided, filters the results for the given shape. (default to default)

  • :resource_id (String) —

    If provided, filters the results for the specified resource Id.

  • :is_latest (BOOLEAN) —

    If provided, return highest versions from each major version family. (default to false)

Returns:



23582
23583
23584
23585
23586
23587
23588
23589
23590
23591
23592
23593
23594
23595
23596
23597
23598
23599
23600
23601
23602
23603
23604
23605
23606
23607
23608
23609
23610
23611
23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
23627
23628
23629
23630
23631
23632
 
# File 'lib/oci/database/database_client.rb', line 23582

def list_system_version_minor_versions(major_version, compartment_id, gi_version, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_system_version_minor_versions.' if logger

  raise "Missing the required parameter 'major_version' when calling list_system_version_minor_versions." if major_version.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_system_version_minor_versions." if compartment_id.nil?
  raise "Missing the required parameter 'gi_version' when calling list_system_version_minor_versions." if gi_version.nil?

  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 'major_version' must not be blank" if OCI::Internal::Util.blank_string?(major_version)

  path = '/systemVersions/{majorVersion}/minorVersions'.sub('{majorVersion}', major_version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:giVersion] = gi_version
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:shape] = opts[:shape] if opts[:shape]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:isLatest] = opts[:is_latest] if !opts[:is_latest].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: 'DatabaseClient#list_system_version_minor_versions') 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::Database::Models::SystemVersionMinorVersionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_system_versions(compartment_id, gi_version, opts = {}) ⇒ Response

Note:

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

Gets a list of supported Exadata system versions for a given shape and GI version.

Parameters:

  • compartment_id (String) —

    The compartment OCID.

  • gi_version (String) —

    Specifies gi version query 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :shape (String) —

    If provided, filters the results for the given shape. (default to default)

  • :is_latest (BOOLEAN) —

    If provided, return highest versions from each major version family. (default to false)

  • :resource_id (String) —

    If provided, filters the results for the specified resource Id.

Returns:



23659
23660
23661
23662
23663
23664
23665
23666
23667
23668
23669
23670
23671
23672
23673
23674
23675
23676
23677
23678
23679
23680
23681
23682
23683
23684
23685
23686
23687
23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
23706
23707
 
# File 'lib/oci/database/database_client.rb', line 23659

def list_system_versions(compartment_id, gi_version, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_system_versions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_system_versions." if compartment_id.nil?
  raise "Missing the required parameter 'gi_version' when calling list_system_versions." if gi_version.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/systemVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:giVersion] = gi_version
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:shape] = opts[:shape] if opts[:shape]
  query_params[:isLatest] = opts[:is_latest] if !opts[:is_latest].nil?
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]

  # 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: 'DatabaseClient#list_system_versions') 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::Database::Models::SystemVersionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_cluster_networks(exadata_infrastructure_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • compartment_id (String) —

    The compartment 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



23737
23738
23739
23740
23741
23742
23743
23744
23745
23746
23747
23748
23749
23750
23751
23752
23753
23754
23755
23756
23757
23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
23775
23776
23777
23778
23779
23780
23781
23782
23783
23784
23785
23786
23787
23788
23789
23790
23791
23792
23793
 
# File 'lib/oci/database/database_client.rb', line 23737

def list_vm_cluster_networks(exadata_infrastructure_id, compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_cluster_networks.' if logger

  raise "Missing the required parameter 'exadata_infrastructure_id' when calling list_vm_cluster_networks." if exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_vm_cluster_networks." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::VmClusterNetworkSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::VmClusterNetworkSummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(exadata_infrastructure_id)

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'DatabaseClient#list_vm_cluster_networks') 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::Database::Models::VmClusterNetworkSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_cluster_patch_history_entries(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



23813
23814
23815
23816
23817
23818
23819
23820
23821
23822
23823
23824
23825
23826
23827
23828
23829
23830
23831
23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
 
# File 'lib/oci/database/database_client.rb', line 23813

def list_vm_cluster_patch_history_entries(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_cluster_patch_history_entries.' if logger

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

  path = '/vmClusters/{vmClusterId}/patchHistoryEntries'.sub('{vmClusterId}', vm_cluster_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_vm_cluster_patch_history_entries') 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::Database::Models::PatchHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_cluster_patches(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

Returns:



23870
23871
23872
23873
23874
23875
23876
23877
23878
23879
23880
23881
23882
23883
23884
23885
23886
23887
23888
23889
23890
23891
23892
23893
23894
23895
23896
23897
23898
23899
23900
23901
23902
23903
23904
23905
23906
23907
 
# File 'lib/oci/database/database_client.rb', line 23870

def list_vm_cluster_patches(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_cluster_patches.' if logger

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

  path = '/vmClusters/{vmClusterId}/patches'.sub('{vmClusterId}', vm_cluster_id.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#list_vm_cluster_patches') 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::Database::Models::PatchSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_cluster_update_history_entries(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



23932
23933
23934
23935
23936
23937
23938
23939
23940
23941
23942
23943
23944
23945
23946
23947
23948
23949
23950
23951
23952
23953
23954
23955
23956
23957
23958
23959
23960
23961
23962
23963
23964
23965
23966
23967
23968
23969
23970
23971
23972
23973
23974
23975
23976
23977
23978
23979
23980
 
# File 'lib/oci/database/database_client.rb', line 23932

def list_vm_cluster_update_history_entries(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_cluster_update_history_entries.' if logger

  raise "Missing the required parameter 'vm_cluster_id' when calling list_vm_cluster_update_history_entries." if vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::VmClusterUpdateHistoryEntrySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::VmClusterUpdateHistoryEntrySummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(vm_cluster_id)

  path = '/vmClusters/{vmClusterId}/updateHistoryEntries'.sub('{vmClusterId}', vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_vm_cluster_update_history_entries') 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::Database::Models::VmClusterUpdateHistoryEntrySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_cluster_updates(vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • vm_cluster_id (String) —

    The VM cluster 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

  • :update_type (String) —

    A filter to return only resources that match the given update type exactly. Allowed values are: GI_UPGRADE, GI_PATCH, OS_UPDATE

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



24005
24006
24007
24008
24009
24010
24011
24012
24013
24014
24015
24016
24017
24018
24019
24020
24021
24022
24023
24024
24025
24026
24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
24037
24038
24039
24040
24041
24042
24043
24044
24045
24046
24047
24048
24049
24050
24051
24052
24053
 
# File 'lib/oci/database/database_client.rb', line 24005

def list_vm_cluster_updates(vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_cluster_updates.' if logger

  raise "Missing the required parameter 'vm_cluster_id' when calling list_vm_cluster_updates." if vm_cluster_id.nil?

  if opts[:update_type] && !%w[GI_UPGRADE GI_PATCH OS_UPDATE].include?(opts[:update_type])
    raise 'Invalid value for "update_type", must be one of GI_UPGRADE, GI_PATCH, OS_UPDATE.'
  end

  if opts[:lifecycle_state] && !OCI::Database::Models::VmClusterUpdateSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::VmClusterUpdateSummary::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(vm_cluster_id)

  path = '/vmClusters/{vmClusterId}/updates'.sub('{vmClusterId}', vm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:updateType] = opts[:update_type] if opts[:update_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'DatabaseClient#list_vm_cluster_updates') 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::Database::Models::VmClusterUpdateSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the list_cloud_vm_clusters operation.

Parameters:

  • compartment_id (String) —

    The compartment 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

  • :exadata_infrastructure_id (String) —

    If provided, filters the results for the given Exadata Infrastructure. (default to default)

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state exactly.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given. The match is not case sensitive.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :vm_cluster_type (String) —

    A filter to return only vmclusters that match the given vmcluster type exactly.

Returns:



24085
24086
24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
24107
24108
24109
24110
24111
24112
24113
24114
24115
24116
24117
24118
24119
24120
24121
24122
24123
24124
24125
24126
24127
24128
24129
24130
24131
24132
24133
24134
24135
24136
24137
24138
24139
24140
24141
24142
24143
24144
24145
 
# File 'lib/oci/database/database_client.rb', line 24085

def list_vm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#list_vm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vm_clusters." if compartment_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

  if opts[:lifecycle_state] && !OCI::Database::Models::VmClusterSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Database::Models::VmClusterSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:vm_cluster_type] && !OCI::Database::Models::VmClusterSummary::VM_CLUSTER_TYPE_ENUM.include?(opts[:vm_cluster_type])
    raise 'Invalid value for "vm_cluster_type", must be one of the values in OCI::Database::Models::VmClusterSummary::VM_CLUSTER_TYPE_ENUM.'
  end

  path = '/vmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:exadataInfrastructureId] = opts[:exadata_infrastructure_id] if opts[:exadata_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vmClusterType] = opts[:vm_cluster_type] if opts[:vm_cluster_type]

  # 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: 'DatabaseClient#list_vm_clusters') 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::Database::Models::VmClusterSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#local_clone_pluggable_database(local_clone_pluggable_database_details, pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use create_pluggable_database for Pluggable Database LocalClone Operation. Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the READ_WRITE openMode to perform the clone operation.

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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



24177
24178
24179
24180
24181
24182
24183
24184
24185
24186
24187
24188
24189
24190
24191
24192
24193
24194
24195
24196
24197
24198
24199
24200
24201
24202
24203
24204
24205
24206
24207
24208
24209
24210
24211
24212
24213
24214
24215
24216
24217
 
# File 'lib/oci/database/database_client.rb', line 24177

def local_clone_pluggable_database(local_clone_pluggable_database_details, pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#local_clone_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/localClone'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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(local_clone_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#local_clone_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  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.



94
95
96
 
# File 'lib/oci/database/database_client.rb', line 94

def logger
  @api_client.config.logger
end

#migrate_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Migrate Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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) —

    Unique identifier for the request.

Returns:



24242
24243
24244
24245
24246
24247
24248
24249
24250
24251
24252
24253
24254
24255
24256
24257
24258
24259
24260
24261
24262
24263
24264
24265
24266
24267
24268
24269
24270
24271
24272
24273
24274
24275
24276
24277
24278
24279
24280
24281
 
# File 'lib/oci/database/database_client.rb', line 24242

def migrate_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#migrate_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/migrate'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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: 'DatabaseClient#migrate_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#migrate_data_guard_association_to_multi_data_guards(database_id, data_guard_association_id, opts = {}) ⇒ Response

Note:

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

Migrates the existing Data Guard association to new Data Guard model to support multiple standby databases functionality.

This operation should always be performed on primary.

Parameters:

  • database_id (String) —

    The database OCID.

  • data_guard_association_id (String) —

    The Data Guard association'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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24314
24315
24316
24317
24318
24319
24320
24321
24322
24323
24324
24325
24326
24327
24328
24329
24330
24331
24332
24333
24334
24335
24336
24337
24338
24339
24340
24341
24342
24343
24344
24345
24346
24347
24348
24349
24350
24351
24352
24353
24354
24355
 
# File 'lib/oci/database/database_client.rb', line 24314

def migrate_data_guard_association_to_multi_data_guards(database_id, data_guard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#migrate_data_guard_association_to_multi_data_guards.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/migrate'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#migrate_data_guard_association_to_multi_data_guards') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#migrate_exadata_db_system_resource_model(db_system_id, opts = {}) ⇒ Response

Note:

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

Migrates the Exadata DB system to the new Exadata resource model. All related resources will be migrated.

Parameters:

  • db_system_id (String) —

    The DB system 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



24386
24387
24388
24389
24390
24391
24392
24393
24394
24395
24396
24397
24398
24399
24400
24401
24402
24403
24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
24425
 
# File 'lib/oci/database/database_client.rb', line 24386

def migrate_exadata_db_system_resource_model(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#migrate_exadata_db_system_resource_model.' if logger

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

  path = '/dbSystems/{dbSystemId}/actions/migration'.sub('{dbSystemId}', db_system_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]
  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: 'DatabaseClient#migrate_exadata_db_system_resource_model') 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::Database::Models::ExadataDbSystemMigration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#migrate_vault_key(database_id, migrate_vault_key_details, opts = {}) ⇒ Response

Note:

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

Changes encryption key management from customer-managed, using the Vault service, to Oracle-managed.

Parameters:

  • database_id (String) —

    The database OCID.

  • migrate_vault_key_details (OCI::Database::Models::MigrateVaultKeyDetails) —

    Request to change the source of the encryption key for the database.

  • 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



24455
24456
24457
24458
24459
24460
24461
24462
24463
24464
24465
24466
24467
24468
24469
24470
24471
24472
24473
24474
24475
24476
24477
24478
24479
24480
24481
24482
24483
24484
24485
24486
24487
24488
24489
24490
24491
24492
24493
24494
24495
 
# File 'lib/oci/database/database_client.rb', line 24455

def migrate_vault_key(database_id, migrate_vault_key_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#migrate_vault_key.' if logger

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

  path = '/databases/{databaseId}/actions/migrateKey'.sub('{databaseId}', database_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-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(migrate_vault_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#migrate_vault_key') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_database_management(database_id, modify_database_management_details, opts = {}) ⇒ Response

Note:

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

Updates one or more attributes of the Database Management service for the database.

Parameters:

  • database_id (String) —

    The database OCID.

  • modify_database_management_details (OCI::Database::Models::ModifyDatabaseManagementDetails) —

    The data to update one or more attributes of the Database Management Service for the database.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24525
24526
24527
24528
24529
24530
24531
24532
24533
24534
24535
24536
24537
24538
24539
24540
24541
24542
24543
24544
24545
24546
24547
24548
24549
24550
24551
24552
24553
24554
24555
24556
24557
24558
24559
24560
24561
24562
24563
24564
24565
 
# File 'lib/oci/database/database_client.rb', line 24525

def modify_database_management(database_id, modify_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#modify_database_management.' if logger

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

  path = '/databases/{databaseId}/actions/modifyDatabaseManagement'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#modify_database_management') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_pluggable_database_management(pluggable_database_id, modify_pluggable_database_management_details, opts = {}) ⇒ Response

Note:

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

Updates one or more attributes of the Database Management service for the pluggable database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24595
24596
24597
24598
24599
24600
24601
24602
24603
24604
24605
24606
24607
24608
24609
24610
24611
24612
24613
24614
24615
24616
24617
24618
24619
24620
24621
24622
24623
24624
24625
24626
24627
24628
24629
24630
24631
24632
24633
24634
24635
 
# File 'lib/oci/database/database_client.rb', line 24595

def modify_pluggable_database_management(pluggable_database_id, modify_pluggable_database_management_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#modify_pluggable_database_management.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/modifyPluggableDatabaseManagement'.sub('{pluggableDatabaseId}', pluggable_database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_pluggable_database_management_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#modify_pluggable_database_management') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#mount_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {}) ⇒ Response

Note:

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

Mounts the advanced cluster file system to all the virtual machines within a vmcluster.

Parameters:

  • advanced_cluster_file_system_id (String) —

    The advanced cluster file system Id 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24665
24666
24667
24668
24669
24670
24671
24672
24673
24674
24675
24676
24677
24678
24679
24680
24681
24682
24683
24684
24685
24686
24687
24688
24689
24690
24691
24692
24693
24694
24695
24696
24697
24698
24699
24700
24701
24702
24703
24704
 
# File 'lib/oci/database/database_client.rb', line 24665

def mount_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#mount_advanced_cluster_file_system.' if logger

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

  path = '/advancedClusterFileSystems/{advancedClusterFileSystemId}/actions/mount'.sub('{advancedClusterFileSystemId}', advanced_cluster_file_system_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#mount_advanced_cluster_file_system') 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::Database::Models::AdvancedClusterFileSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#mount_dbnode_snapshot(mount_dbnode_snapshot_details, dbnode_snapshot_id, opts = {}) ⇒ Response

Note:

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

Mounts the snapshot for the provided dbNode.

Parameters:

  • mount_dbnode_snapshot_details (OCI::Database::Models::MountDbnodeSnapshotDetails) —

    Request to mount the snapshot for the provided Exadata Database Node.

  • dbnode_snapshot_id (String) —

    The Exadata Database Node Snapshot 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24735
24736
24737
24738
24739
24740
24741
24742
24743
24744
24745
24746
24747
24748
24749
24750
24751
24752
24753
24754
24755
24756
24757
24758
24759
24760
24761
24762
24763
24764
24765
24766
24767
24768
24769
24770
24771
24772
24773
24774
24775
 
# File 'lib/oci/database/database_client.rb', line 24735

def mount_dbnode_snapshot(mount_dbnode_snapshot_details, dbnode_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#mount_dbnode_snapshot.' if logger

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

  path = '/dbnodeSnapshots/{dbnodeSnapshotId}/actions/mount'.sub('{dbnodeSnapshotId}', dbnode_snapshot_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(mount_dbnode_snapshot_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#mount_dbnode_snapshot') 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::Database::Models::DbnodeSnapshot'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#move_execution_action_member(execution_action_id, move_execution_action_member_details, opts = {}) ⇒ Response

Note:

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

Moves an execution action member to this execution action resource from another.

Parameters:

  • execution_action_id (String) —

    The execution action OCID.

  • move_execution_action_member_details (OCI::Database::Models::MoveExecutionActionMemberDetails) —

    Request to move an execution action member to this execution action resource from another.

  • 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



24806
24807
24808
24809
24810
24811
24812
24813
24814
24815
24816
24817
24818
24819
24820
24821
24822
24823
24824
24825
24826
24827
24828
24829
24830
24831
24832
24833
24834
24835
24836
24837
24838
24839
24840
24841
24842
24843
24844
24845
24846
 
# File 'lib/oci/database/database_client.rb', line 24806

def move_execution_action_member(execution_action_id, move_execution_action_member_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#move_execution_action_member.' if logger

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

  path = '/executionActions/{executionActionId}/actions/moveActionMember'.sub('{executionActionId}', execution_action_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]
  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(move_execution_action_member_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#move_execution_action_member') 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::Database::Models::ExecutionAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_data_guard_health_status(database_id, opts = {}) ⇒ Response

Note:

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

Refreshes the Data Guard health status for the specified database. This operation is supported on both primary and standby databases.

Parameters:

  • database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



24876
24877
24878
24879
24880
24881
24882
24883
24884
24885
24886
24887
24888
24889
24890
24891
24892
24893
24894
24895
24896
24897
24898
24899
24900
24901
24902
24903
24904
24905
24906
24907
24908
24909
24910
24911
24912
24913
24914
24915
 
# File 'lib/oci/database/database_client.rb', line 24876

def refresh_data_guard_health_status(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#refresh_data_guard_health_status.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/refresh'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#refresh_data_guard_health_status') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_pluggable_database(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Refreshes a pluggable database (PDB) Refreshable clone.

Parameters:

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



24945
24946
24947
24948
24949
24950
24951
24952
24953
24954
24955
24956
24957
24958
24959
24960
24961
24962
24963
24964
24965
24966
24967
24968
24969
24970
24971
24972
24973
24974
24975
24976
24977
24978
24979
24980
24981
24982
24983
24984
 
# File 'lib/oci/database/database_client.rb', line 24945

def refresh_pluggable_database(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#refresh_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/refresh'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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: 'DatabaseClient#refresh_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#register_autonomous_database_data_safe(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Asynchronously registers this Autonomous AI Database with Data Safe.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

  • :register_autonomous_database_data_safe_details (OCI::Database::Models::RegisterAutonomousDatabaseDataSafeDetails) —

    Request to register an Autonomous AI Database with Data Safe.

Returns:

  • (Response) —

    A Response object with data of type nil



25008
25009
25010
25011
25012
25013
25014
25015
25016
25017
25018
25019
25020
25021
25022
25023
25024
25025
25026
25027
25028
25029
25030
25031
25032
25033
25034
25035
25036
25037
25038
25039
25040
25041
25042
25043
25044
 
# File 'lib/oci/database/database_client.rb', line 25008

def register_autonomous_database_data_safe(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#register_autonomous_database_data_safe.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/registerDataSafe'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(opts[:register_autonomous_database_data_safe_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#register_autonomous_database_data_safe') 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

#register_cloud_autonomous_vm_cluster_pkcs(cloud_autonomous_vm_cluster_id, register_cloud_autonomous_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Install the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



25075
25076
25077
25078
25079
25080
25081
25082
25083
25084
25085
25086
25087
25088
25089
25090
25091
25092
25093
25094
25095
25096
25097
25098
25099
25100
25101
25102
25103
25104
25105
25106
25107
25108
25109
25110
25111
25112
25113
25114
 
# File 'lib/oci/database/database_client.rb', line 25075

def register_cloud_autonomous_vm_cluster_pkcs(cloud_autonomous_vm_cluster_id, register_cloud_autonomous_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#register_cloud_autonomous_vm_cluster_pkcs.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/registerPkcs'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(register_cloud_autonomous_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#register_cloud_autonomous_vm_cluster_pkcs') 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

#register_cloud_vm_cluster_pkcs(cloud_vm_cluster_id, register_cloud_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Install the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



25145
25146
25147
25148
25149
25150
25151
25152
25153
25154
25155
25156
25157
25158
25159
25160
25161
25162
25163
25164
25165
25166
25167
25168
25169
25170
25171
25172
25173
25174
25175
25176
25177
25178
25179
25180
25181
25182
25183
25184
 
# File 'lib/oci/database/database_client.rb', line 25145

def register_cloud_vm_cluster_pkcs(cloud_vm_cluster_id, register_cloud_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#register_cloud_vm_cluster_pkcs.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/registerPkcs'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(register_cloud_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#register_cloud_vm_cluster_pkcs') 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

#register_exadb_vm_cluster_pkcs(exadb_vm_cluster_id, register_exadb_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Install the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
25254
 
# File 'lib/oci/database/database_client.rb', line 25215

def register_exadb_vm_cluster_pkcs(exadb_vm_cluster_id, register_exadb_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#register_exadb_vm_cluster_pkcs.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/registerPkcs'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(register_exadb_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#register_exadb_vm_cluster_pkcs') 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

#reinstate_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see Reinstate the Disabled Standby in an Autonomous Data Guard Configuration.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

Returns:



25279
25280
25281
25282
25283
25284
25285
25286
25287
25288
25289
25290
25291
25292
25293
25294
25295
25296
25297
25298
25299
25300
25301
25302
25303
25304
25305
25306
25307
25308
25309
25310
25311
25312
25313
25314
25315
25316
 
# File 'lib/oci/database/database_client.rb', line 25279

def reinstate_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#reinstate_autonomous_container_database_dataguard.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/reinstate'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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: 'DatabaseClient#reinstate_autonomous_container_database_dataguard') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reinstate_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the reinstate_autonomous_container_database_dataguard operation to reinstate a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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.

Returns:



25339
25340
25341
25342
25343
25344
25345
25346
25347
25348
25349
25350
25351
25352
25353
25354
25355
25356
25357
25358
25359
25360
25361
25362
25363
25364
25365
25366
25367
25368
25369
25370
25371
25372
25373
25374
25375
25376
25377
 
# File 'lib/oci/database/database_client.rb', line 25339

def reinstate_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#reinstate_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/reinstate'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#reinstate_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reinstate_data_guard(database_id, reinstate_data_guard_details, opts = {}) ⇒ Response

Note:

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

Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.

This operation should be performed on disabled standby database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



25410
25411
25412
25413
25414
25415
25416
25417
25418
25419
25420
25421
25422
25423
25424
25425
25426
25427
25428
25429
25430
25431
25432
25433
25434
25435
25436
25437
25438
25439
25440
25441
25442
25443
25444
25445
25446
25447
25448
25449
25450
 
# File 'lib/oci/database/database_client.rb', line 25410

def reinstate_data_guard(database_id, reinstate_data_guard_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#reinstate_data_guard.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/reinstate'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(reinstate_data_guard_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#reinstate_data_guard') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reinstate_data_guard_association(database_id, data_guard_association_id, reinstate_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.

Parameters:

  • database_id (String) —

    The database OCID.

  • data_guard_association_id (String) —

    The Data Guard association's OCID.

  • reinstate_data_guard_association_details (OCI::Database::Models::ReinstateDataGuardAssociationDetails) —

    A request to reinstate a database in a standby role.

  • 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.

Returns:



25474
25475
25476
25477
25478
25479
25480
25481
25482
25483
25484
25485
25486
25487
25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
25503
25504
25505
25506
25507
25508
25509
25510
25511
25512
25513
 
# File 'lib/oci/database/database_client.rb', line 25474

def reinstate_data_guard_association(database_id, data_guard_association_id, reinstate_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#reinstate_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/reinstate'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(reinstate_data_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#reinstate_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remote_clone_pluggable_database(remote_clone_pluggable_database_details, pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use create_pluggable_database for Pluggable Database RemoteClone Operation. Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the READ_WRITE openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone.

Parameters:

  • remote_clone_pluggable_database_details (OCI::Database::Models::RemoteClonePluggableDatabaseDetails) —

    Request to clone a pluggable database (PDB) to a different database (CDB) from the source PDB.

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



25546
25547
25548
25549
25550
25551
25552
25553
25554
25555
25556
25557
25558
25559
25560
25561
25562
25563
25564
25565
25566
25567
25568
25569
25570
25571
25572
25573
25574
25575
25576
25577
25578
25579
25580
25581
25582
25583
25584
25585
25586
 
# File 'lib/oci/database/database_client.rb', line 25546

def remote_clone_pluggable_database(remote_clone_pluggable_database_details, pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#remote_clone_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/remoteClone'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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(remote_clone_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#remote_clone_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_virtual_machine_from_cloud_vm_cluster(remove_virtual_machine_from_cloud_vm_cluster_details, cloud_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



25617
25618
25619
25620
25621
25622
25623
25624
25625
25626
25627
25628
25629
25630
25631
25632
25633
25634
25635
25636
25637
25638
25639
25640
25641
25642
25643
25644
25645
25646
25647
25648
25649
25650
25651
25652
25653
25654
25655
25656
25657
 
# File 'lib/oci/database/database_client.rb', line 25617

def remove_virtual_machine_from_cloud_vm_cluster(remove_virtual_machine_from_cloud_vm_cluster_details, cloud_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#remove_virtual_machine_from_cloud_vm_cluster.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/removeVirtualMachine'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_virtual_machine_from_cloud_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#remove_virtual_machine_from_cloud_vm_cluster') 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::Database::Models::CloudVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_virtual_machine_from_exadb_vm_cluster(remove_virtual_machine_from_exadb_vm_cluster_details, exadb_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud instances only.

Parameters:

  • remove_virtual_machine_from_exadb_vm_cluster_details (OCI::Database::Models::RemoveVirtualMachineFromExadbVmClusterDetails) —

    Request to remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure.

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • 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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



25688
25689
25690
25691
25692
25693
25694
25695
25696
25697
25698
25699
25700
25701
25702
25703
25704
25705
25706
25707
25708
25709
25710
25711
25712
25713
25714
25715
25716
25717
25718
25719
25720
25721
25722
25723
25724
25725
25726
25727
25728
 
# File 'lib/oci/database/database_client.rb', line 25688

def remove_virtual_machine_from_exadb_vm_cluster(remove_virtual_machine_from_exadb_vm_cluster_details, exadb_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#remove_virtual_machine_from_exadb_vm_cluster.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/removeVirtualMachine'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_virtual_machine_from_exadb_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#remove_virtual_machine_from_exadb_vm_cluster') 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::Database::Models::ExadbVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_virtual_machine_from_vm_cluster(remove_virtual_machine_from_vm_cluster_details, vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



25759
25760
25761
25762
25763
25764
25765
25766
25767
25768
25769
25770
25771
25772
25773
25774
25775
25776
25777
25778
25779
25780
25781
25782
25783
25784
25785
25786
25787
25788
25789
25790
25791
25792
25793
25794
25795
25796
25797
25798
25799
 
# File 'lib/oci/database/database_client.rb', line 25759

def remove_virtual_machine_from_vm_cluster(remove_virtual_machine_from_vm_cluster_details, vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#remove_virtual_machine_from_vm_cluster.' if logger

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

  path = '/vmClusters/{vmClusterId}/actions/removeVirtualMachine'.sub('{vmClusterId}', vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_virtual_machine_from_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#remove_virtual_machine_from_vm_cluster') 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::Database::Models::VmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reorder_execution_actions(execution_window_id, reorder_execution_action_details, opts = {}) ⇒ Response

Note:

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

Reorders the execution actions under this execution window resource.

Parameters:

  • execution_window_id (String) —

    The execution window OCID.

  • reorder_execution_action_details (OCI::Database::Models::ReorderExecutionActionDetails) —

    Request to reorder the execution actions under this execution window resource.

  • 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



25830
25831
25832
25833
25834
25835
25836
25837
25838
25839
25840
25841
25842
25843
25844
25845
25846
25847
25848
25849
25850
25851
25852
25853
25854
25855
25856
25857
25858
25859
25860
25861
25862
25863
25864
25865
25866
25867
25868
25869
25870
 
# File 'lib/oci/database/database_client.rb', line 25830

def reorder_execution_actions(execution_window_id, reorder_execution_action_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#reorder_execution_actions.' if logger

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

  path = '/executionWindows/{executionWindowId}/actions/reorder'.sub('{executionWindowId}', execution_window_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]
  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(reorder_execution_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#reorder_execution_actions') 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::Database::Models::ExecutionWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reorder_scheduled_actions(reorder_scheduled_actions_details, scheduling_plan_id, opts = {}) ⇒ Response

Note:

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

Re-order the scheduled actions under this scheduling plan 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



25901
25902
25903
25904
25905
25906
25907
25908
25909
25910
25911
25912
25913
25914
25915
25916
25917
25918
25919
25920
25921
25922
25923
25924
25925
25926
25927
25928
25929
25930
25931
25932
25933
25934
25935
25936
25937
25938
25939
25940
25941
 
# File 'lib/oci/database/database_client.rb', line 25901

def reorder_scheduled_actions(reorder_scheduled_actions_details, scheduling_plan_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#reorder_scheduled_actions.' if logger

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

  path = '/schedulingPlans/{schedulingPlanId}/actions/reorder'.sub('{schedulingPlanId}', scheduling_plan_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(reorder_scheduled_actions_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#reorder_scheduled_actions') 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::Database::Models::SchedulingPlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#reschedule_managed_db_software_update(database_id, opts = {}) ⇒ Response

Note:

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

Reschedule the Managed Database Software Update

Parameters:

  • database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



25971
25972
25973
25974
25975
25976
25977
25978
25979
25980
25981
25982
25983
25984
25985
25986
25987
25988
25989
25990
25991
25992
25993
25994
25995
25996
25997
25998
25999
26000
26001
26002
26003
26004
26005
26006
26007
26008
26009
26010
 
# File 'lib/oci/database/database_client.rb', line 25971

def reschedule_managed_db_software_update(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#reschedule_managed_db_software_update.' if logger

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

  path = '/databases/{databaseId}/actions/rescheduleManagedDbSoftwareUpdate'.sub('{databaseId}', database_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]
  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: 'DatabaseClient#reschedule_managed_db_software_update') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resize_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, resize_vm_cluster_network_details, opts = {}) ⇒ Response

Note:

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

Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network OCID.

  • resize_vm_cluster_network_details (OCI::Database::Models::ResizeVmClusterNetworkDetails) —

    Request to add or remove Db server network nodes in the VM cluster network.

  • 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.

  • :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 may be rejected).

  • :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:



26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
26054
26055
26056
26057
26058
26059
26060
26061
26062
26063
26064
26065
26066
26067
26068
26069
26070
26071
26072
26073
26074
26075
26076
26077
26078
26079
26080
26081
26082
26083
26084
26085
 
# File 'lib/oci/database/database_client.rb', line 26043

def resize_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, resize_vm_cluster_network_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#resize_vm_cluster_network.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/resize'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(resize_vm_cluster_network_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#resize_vm_cluster_network') 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::Database::Models::VmClusterNetwork'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resource_pool_shapes(opts = {}) ⇒ Response

Note:

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

Lists available resource pools shapes.

Parameters:

  • 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_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 may be rejected).

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 10)

  • :page (String) —

    The pagination token to continue listing from.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



26115
26116
26117
26118
26119
26120
26121
26122
26123
26124
26125
26126
26127
26128
26129
26130
26131
26132
26133
26134
26135
26136
26137
26138
26139
26140
26141
26142
26143
26144
26145
26146
26147
26148
26149
26150
26151
26152
26153
26154
 
# File 'lib/oci/database/database_client.rb', line 26115

def resource_pool_shapes(opts = {})
  logger.debug 'Calling operation DatabaseClient#resource_pool_shapes.' if logger


  path = '/autonomousDatabases/actions/listResourcePoolShapes'
  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[:'if-match'] = opts[:if_match] if opts[:if_match]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#resource_pool_shapes') 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::Database::Models::ResourcePoolShapeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restart_autonomous_container_database(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Rolling restarts the specified Autonomous Container Database.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

  • :restart_autonomous_container_database_details (OCI::Database::Models::RestartAutonomousContainerDatabaseDetails) —

    Request details to restart the Autonomous Container Database with force option.

Returns:



26179
26180
26181
26182
26183
26184
26185
26186
26187
26188
26189
26190
26191
26192
26193
26194
26195
26196
26197
26198
26199
26200
26201
26202
26203
26204
26205
26206
26207
26208
26209
26210
26211
26212
26213
26214
26215
26216
 
# File 'lib/oci/database/database_client.rb', line 26179

def restart_autonomous_container_database(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#restart_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/restart'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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(opts[:restart_autonomous_container_database_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#restart_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restart_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Restarts the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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.

  • :is_online_restart (BOOLEAN) —

    If provided, an online restart will be triggered. (default to false)

  • :restart_autonomous_database_details (OCI::Database::Models::RestartAutonomousDatabaseDetails) —

    Request details to restart the Autonomous Database with force option.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



26243
26244
26245
26246
26247
26248
26249
26250
26251
26252
26253
26254
26255
26256
26257
26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
26268
26269
26270
26271
26272
26273
26274
26275
26276
26277
26278
26279
26280
26281
 
# File 'lib/oci/database/database_client.rb', line 26243

def restart_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#restart_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/restart'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isOnlineRestart] = opts[:is_online_restart] if !opts[:is_online_restart].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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(opts[:restart_autonomous_database_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#restart_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restart_autonomous_vm_cluster_ords(autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster.

Parameters:

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



26311
26312
26313
26314
26315
26316
26317
26318
26319
26320
26321
26322
26323
26324
26325
26326
26327
26328
26329
26330
26331
26332
26333
26334
26335
26336
26337
26338
26339
26340
26341
26342
26343
26344
26345
26346
26347
26348
26349
 
# File 'lib/oci/database/database_client.rb', line 26311

def restart_autonomous_vm_cluster_ords(autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#restart_autonomous_vm_cluster_ords.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/actions/restartOrds'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#restart_autonomous_vm_cluster_ords') 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

#restart_cloud_autonomous_vm_cluster_ords(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



26379
26380
26381
26382
26383
26384
26385
26386
26387
26388
26389
26390
26391
26392
26393
26394
26395
26396
26397
26398
26399
26400
26401
26402
26403
26404
26405
26406
26407
26408
26409
26410
26411
26412
26413
26414
26415
26416
26417
 
# File 'lib/oci/database/database_client.rb', line 26379

def restart_cloud_autonomous_vm_cluster_ords(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#restart_cloud_autonomous_vm_cluster_ords.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/restartOrds'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#restart_cloud_autonomous_vm_cluster_ords') 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

#restore_autonomous_database(autonomous_database_id, restore_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Restores an Autonomous AI Database based on the provided request parameters.

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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



26443
26444
26445
26446
26447
26448
26449
26450
26451
26452
26453
26454
26455
26456
26457
26458
26459
26460
26461
26462
26463
26464
26465
26466
26467
26468
26469
26470
26471
26472
26473
26474
26475
26476
26477
26478
26479
26480
26481
 
# File 'lib/oci/database/database_client.rb', line 26443

def restore_autonomous_database(autonomous_database_id, restore_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#restore_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/restore'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(restore_autonomous_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#restore_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restore_database(database_id, restore_database_details, opts = {}) ⇒ Response

Note:

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

Restore a Database based on the request parameters you provide.

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.

Returns:



26504
26505
26506
26507
26508
26509
26510
26511
26512
26513
26514
26515
26516
26517
26518
26519
26520
26521
26522
26523
26524
26525
26526
26527
26528
26529
26530
26531
26532
26533
26534
26535
26536
26537
26538
26539
26540
26541
 
# File 'lib/oci/database/database_client.rb', line 26504

def restore_database(database_id, restore_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#restore_database.' if logger

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

  path = '/databases/{databaseId}/actions/restore'.sub('{databaseId}', database_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(restore_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#restore_database') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#rotate_autonomous_container_database_encryption_key(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Creates a new version of an existing Vault service key.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :rotate_autonomous_container_database_encryption_key_details (OCI::Database::Models::RotateAutonomousContainerDatabaseEncryptionKeyDetails) —

    Key details provided by the user for rotate key operation for Autonomous AI Database.

Returns:



26571
26572
26573
26574
26575
26576
26577
26578
26579
26580
26581
26582
26583
26584
26585
26586
26587
26588
26589
26590
26591
26592
26593
26594
26595
26596
26597
26598
26599
26600
26601
26602
26603
26604
26605
26606
26607
26608
26609
26610
 
# File 'lib/oci/database/database_client.rb', line 26571

def rotate_autonomous_container_database_encryption_key(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_autonomous_container_database_encryption_key.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/rotateKey'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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-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(opts[:rotate_autonomous_container_database_encryption_key_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_autonomous_container_database_encryption_key') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#rotate_autonomous_database_encryption_key(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Rotate existing AutonomousDatabase Vault service key.

Parameters:

  • autonomous_database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :rotate_autonomous_database_encryption_key_details (OCI::Database::Models::RotateAutonomousDatabaseEncryptionKeyDetails) —

    Key details provided by the user for rotate key operation for Autonomous AI Database.

Returns:



26640
26641
26642
26643
26644
26645
26646
26647
26648
26649
26650
26651
26652
26653
26654
26655
26656
26657
26658
26659
26660
26661
26662
26663
26664
26665
26666
26667
26668
26669
26670
26671
26672
26673
26674
26675
26676
26677
26678
26679
 
# File 'lib/oci/database/database_client.rb', line 26640

def rotate_autonomous_database_encryption_key(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_autonomous_database_encryption_key.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/rotateKey'.sub('{autonomousDatabaseId}', autonomous_database_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-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(opts[:rotate_autonomous_database_encryption_key_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_autonomous_database_encryption_key') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#rotate_autonomous_vm_cluster_ords_certs(rotate_autonomous_vm_cluster_ords_certs_details, autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.

Parameters:

  • rotate_autonomous_vm_cluster_ords_certs_details (OCI::Database::Models::RotateAutonomousVmClusterOrdsCertsDetails) —

    Request to rotate the Oracle REST Data Services (ORDS) certificates on Autonomous Exadata VM cluster.

  • autonomous_vm_cluster_id (String) —

    The autonomous VM cluster 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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :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:

  • (Response) —

    A Response object with data of type nil



26710
26711
26712
26713
26714
26715
26716
26717
26718
26719
26720
26721
26722
26723
26724
26725
26726
26727
26728
26729
26730
26731
26732
26733
26734
26735
26736
26737
26738
26739
26740
26741
26742
26743
26744
26745
26746
26747
26748
26749
 
# File 'lib/oci/database/database_client.rb', line 26710

def rotate_autonomous_vm_cluster_ords_certs(rotate_autonomous_vm_cluster_ords_certs_details, autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_autonomous_vm_cluster_ords_certs.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/actions/rotateOrdsCerts'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(rotate_autonomous_vm_cluster_ords_certs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_autonomous_vm_cluster_ords_certs') 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

#rotate_autonomous_vm_cluster_ssl_certs(rotate_autonomous_vm_cluster_ssl_certs_details, autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Rotates the SSL certificates for Autonomous Exadata VM cluster.

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.

  • :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 may be rejected).

  • :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:

  • (Response) —

    A Response object with data of type nil



26780
26781
26782
26783
26784
26785
26786
26787
26788
26789
26790
26791
26792
26793
26794
26795
26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
26809
26810
26811
26812
26813
26814
26815
26816
26817
26818
26819
 
# File 'lib/oci/database/database_client.rb', line 26780

def rotate_autonomous_vm_cluster_ssl_certs(rotate_autonomous_vm_cluster_ssl_certs_details, autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_autonomous_vm_cluster_ssl_certs.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}/actions/rotateSslCerts'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(rotate_autonomous_vm_cluster_ssl_certs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_autonomous_vm_cluster_ssl_certs') 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

#rotate_cloud_autonomous_vm_cluster_ords_certs(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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

  • :rotate_cloud_autonomous_vm_cluster_ords_certs_details (OCI::Database::Models::RotateCloudAutonomousVmClusterOrdsCertsDetails) —

    Request to rotate the Oracle REST Data Services (ORDS) certificates on Cloud Autonomous Exadata VM cluster.

  • :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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



26850
26851
26852
26853
26854
26855
26856
26857
26858
26859
26860
26861
26862
26863
26864
26865
26866
26867
26868
26869
26870
26871
26872
26873
26874
26875
26876
26877
26878
26879
26880
26881
26882
26883
26884
26885
26886
26887
26888
 
# File 'lib/oci/database/database_client.rb', line 26850

def rotate_cloud_autonomous_vm_cluster_ords_certs(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_cloud_autonomous_vm_cluster_ords_certs.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateOrdsCerts'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:rotate_cloud_autonomous_vm_cluster_ords_certs_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_cloud_autonomous_vm_cluster_ords_certs') 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

#rotate_cloud_autonomous_vm_cluster_ssl_certs(cloud_autonomous_vm_cluster_id, opts = {}) ⇒ Response

Note:

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

Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster.

Parameters:

  • cloud_autonomous_vm_cluster_id (String) —

    The Cloud VM cluster 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

  • :rotate_cloud_autonomous_vm_cluster_ssl_certs_details (OCI::Database::Models::RotateCloudAutonomousVmClusterSslCertsDetails) —

    Request to rotate the SSL certificates on Cloud Autonomous Exadata VM cluster.

  • :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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



26919
26920
26921
26922
26923
26924
26925
26926
26927
26928
26929
26930
26931
26932
26933
26934
26935
26936
26937
26938
26939
26940
26941
26942
26943
26944
26945
26946
26947
26948
26949
26950
26951
26952
26953
26954
26955
26956
26957
 
# File 'lib/oci/database/database_client.rb', line 26919

def rotate_cloud_autonomous_vm_cluster_ssl_certs(cloud_autonomous_vm_cluster_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_cloud_autonomous_vm_cluster_ssl_certs.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateSslCerts'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:rotate_cloud_autonomous_vm_cluster_ssl_certs_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_cloud_autonomous_vm_cluster_ssl_certs') 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

#rotate_ords_certs(autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the rotate_cloud_autonomous_vm_cluster_ords_certs to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.

Parameters:

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :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:

  • (Response) —

    A Response object with data of type nil



26987
26988
26989
26990
26991
26992
26993
26994
26995
26996
26997
26998
26999
27000
27001
27002
27003
27004
27005
27006
27007
27008
27009
27010
27011
27012
27013
27014
27015
27016
27017
27018
27019
27020
27021
27022
27023
27024
27025
 
# File 'lib/oci/database/database_client.rb', line 26987

def rotate_ords_certs(autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_ords_certs.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateOrdsCerts'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#rotate_ords_certs') 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

#rotate_pluggable_database_encryption_key(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Create a new version of the existing encryption key.

Parameters:

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
27072
27073
27074
27075
27076
27077
27078
27079
27080
27081
27082
27083
27084
27085
27086
27087
27088
27089
27090
27091
27092
 
# File 'lib/oci/database/database_client.rb', line 27054

def rotate_pluggable_database_encryption_key(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_pluggable_database_encryption_key.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/rotateKey'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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: 'DatabaseClient#rotate_pluggable_database_encryption_key') 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

#rotate_ssl_certs(autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the rotate_cloud_autonomous_vm_cluster_ssl_certs to rotate SSL certs for an Autonomous Exadata VM cluster instead.

Parameters:

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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) —

    Unique identifier for the request.

  • :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 may be rejected).

  • :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:

  • (Response) —

    A Response object with data of type nil



27122
27123
27124
27125
27126
27127
27128
27129
27130
27131
27132
27133
27134
27135
27136
27137
27138
27139
27140
27141
27142
27143
27144
27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
27155
27156
27157
27158
27159
27160
 
# File 'lib/oci/database/database_client.rb', line 27122

def rotate_ssl_certs(autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_ssl_certs.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateSslCerts'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#rotate_ssl_certs') 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

#rotate_vault_key(database_id, opts = {}) ⇒ Response

Note:

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

Creates a new version of an existing Vault service key.

Parameters:

  • database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



27189
27190
27191
27192
27193
27194
27195
27196
27197
27198
27199
27200
27201
27202
27203
27204
27205
27206
27207
27208
27209
27210
27211
27212
27213
27214
27215
27216
27217
27218
27219
27220
27221
27222
27223
27224
27225
27226
27227
27228
 
# File 'lib/oci/database/database_client.rb', line 27189

def rotate_vault_key(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#rotate_vault_key.' if logger

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

  path = '/databases/{databaseId}/actions/rotateKey'.sub('{databaseId}', database_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-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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#rotate_vault_key') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#run_data_patch(database_id, opts = {}) ⇒ Response

Note:

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

Run datapatch on the specified Oracle Database and optionally on the specified Pluggable databases.

Parameters:

  • database_id (String) —

    The database 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

  • :run_data_patch_details (OCI::Database::Models::RunDataPatchDetails) —

    Request to run a database datapatch.

  • :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 may be rejected).

  • :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) —

    Unique identifier for the request.

Returns:



27259
27260
27261
27262
27263
27264
27265
27266
27267
27268
27269
27270
27271
27272
27273
27274
27275
27276
27277
27278
27279
27280
27281
27282
27283
27284
27285
27286
27287
27288
27289
27290
27291
27292
27293
27294
27295
27296
27297
27298
 
# File 'lib/oci/database/database_client.rb', line 27259

def run_data_patch(database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#run_data_patch.' if logger

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

  path = '/databases/{databaseId}/actions/runDatapatch'.sub('{databaseId}', database_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:run_data_patch_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#run_data_patch') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#saas_admin_user_status(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

This operation gets SaaS administrative user status of the Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

Returns:



27317
27318
27319
27320
27321
27322
27323
27324
27325
27326
27327
27328
27329
27330
27331
27332
27333
27334
27335
27336
27337
27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
 
# File 'lib/oci/database/database_client.rb', line 27317

def saas_admin_user_status(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#saas_admin_user_status.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/getSaasAdminUserStatus'.sub('{autonomousDatabaseId}', autonomous_database_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: 'DatabaseClient#saas_admin_user_status') 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::Database::Models::SaasAdminUserStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#scan_external_container_database_pluggable_databases(external_container_database_id, external_database_connector_id, opts = {}) ⇒ Response

Note:

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

Scans for pluggable databases in the specified external container database. This operation will return un-registered pluggable databases in the get_work_request operation.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase OCID.

  • external_database_connector_id (String) —

    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

  • 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.

  • :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 may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



27383
27384
27385
27386
27387
27388
27389
27390
27391
27392
27393
27394
27395
27396
27397
27398
27399
27400
27401
27402
27403
27404
27405
27406
27407
27408
27409
27410
27411
27412
27413
27414
27415
27416
27417
27418
27419
27420
27421
27422
 
# File 'lib/oci/database/database_client.rb', line 27383

def scan_external_container_database_pluggable_databases(external_container_database_id, external_database_connector_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#scan_external_container_database_pluggable_databases.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}/actions/scanPluggableDatabases'.sub('{externalContainerDatabaseId}', external_container_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:externalDatabaseConnectorId] = external_database_connector_id

  # 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: 'DatabaseClient#scan_external_container_database_pluggable_databases') 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

#set_db_key_version(database_id, set_key_version_details, opts = {}) ⇒ Response

Note:

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

Sets a new version of an existing Vault service key.

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



27452
27453
27454
27455
27456
27457
27458
27459
27460
27461
27462
27463
27464
27465
27466
27467
27468
27469
27470
27471
27472
27473
27474
27475
27476
27477
27478
27479
27480
27481
27482
27483
27484
27485
27486
27487
27488
27489
27490
27491
27492
 
# File 'lib/oci/database/database_client.rb', line 27452

def set_db_key_version(database_id, set_key_version_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#set_db_key_version.' if logger

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

  path = '/databases/{databaseId}/actions/setKeyVersion'.sub('{databaseId}', database_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-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(set_key_version_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#set_db_key_version') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_pdb_key_version(pluggable_database_id, set_key_version_details, opts = {}) ⇒ Response

Note:

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

Sets a new version of an existing Vault service key.

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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



27522
27523
27524
27525
27526
27527
27528
27529
27530
27531
27532
27533
27534
27535
27536
27537
27538
27539
27540
27541
27542
27543
27544
27545
27546
27547
27548
27549
27550
27551
27552
27553
27554
27555
27556
27557
27558
27559
27560
27561
27562
 
# File 'lib/oci/database/database_client.rb', line 27522

def set_pdb_key_version(pluggable_database_id, set_key_version_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#set_pdb_key_version.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/setKeyVersion'.sub('{pluggableDatabaseId}', pluggable_database_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-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(set_key_version_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#set_pdb_key_version') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#shrink_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.

Parameters:

  • autonomous_database_id (String) —

    The database 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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



27587
27588
27589
27590
27591
27592
27593
27594
27595
27596
27597
27598
27599
27600
27601
27602
27603
27604
27605
27606
27607
27608
27609
27610
27611
27612
27613
27614
27615
27616
27617
27618
27619
27620
27621
27622
27623
27624
 
# File 'lib/oci/database/database_client.rb', line 27587

def shrink_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#shrink_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/shrink'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#shrink_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Starts the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



27649
27650
27651
27652
27653
27654
27655
27656
27657
27658
27659
27660
27661
27662
27663
27664
27665
27666
27667
27668
27669
27670
27671
27672
27673
27674
27675
27676
27677
27678
27679
27680
27681
27682
27683
27684
27685
27686
 
# File 'lib/oci/database/database_client.rb', line 27649

def start_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#start_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/start'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#start_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_pluggable_database(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Starts a stopped pluggable database. The openMode value of the pluggable database will be READ_WRITE upon completion.

Parameters:

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



27715
27716
27717
27718
27719
27720
27721
27722
27723
27724
27725
27726
27727
27728
27729
27730
27731
27732
27733
27734
27735
27736
27737
27738
27739
27740
27741
27742
27743
27744
27745
27746
27747
27748
27749
27750
27751
27752
27753
27754
 
# File 'lib/oci/database/database_client.rb', line 27715

def start_pluggable_database(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#start_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/start'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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: 'DatabaseClient#start_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Stops the specified Autonomous AI Database.

Parameters:

  • autonomous_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :stop_autonomous_database_details (OCI::Database::Models::StopAutonomousDatabaseDetails) —

    Request details to stop the Autonomous Database with force option.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



27782
27783
27784
27785
27786
27787
27788
27789
27790
27791
27792
27793
27794
27795
27796
27797
27798
27799
27800
27801
27802
27803
27804
27805
27806
27807
27808
27809
27810
27811
27812
27813
27814
27815
27816
27817
27818
27819
27820
 
# File 'lib/oci/database/database_client.rb', line 27782

def stop_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#stop_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/stop'.sub('{autonomousDatabaseId}', autonomous_database_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(opts[:stop_autonomous_database_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#stop_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_pluggable_database(pluggable_database_id, opts = {}) ⇒ Response

Note:

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

Stops a pluggable database. The openMode value of the pluggable database will be MOUNTED upon completion.

Parameters:

  • pluggable_database_id (String) —

    The database 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



27849
27850
27851
27852
27853
27854
27855
27856
27857
27858
27859
27860
27861
27862
27863
27864
27865
27866
27867
27868
27869
27870
27871
27872
27873
27874
27875
27876
27877
27878
27879
27880
27881
27882
27883
27884
27885
27886
27887
27888
 
# File 'lib/oci/database/database_client.rb', line 27849

def stop_pluggable_database(pluggable_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#stop_pluggable_database.' if logger

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

  path = '/pluggableDatabases/{pluggableDatabaseId}/actions/stop'.sub('{pluggableDatabaseId}', pluggable_database_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]
  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: 'DatabaseClient#stop_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#switch_over_data_guard(database_id, switch_over_data_guard_details, opts = {}) ⇒ Response

Note:

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

Performs a switchover to transition primary database of this Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role.

A switchover guarantees no data loss.

This operation should be performed on respective standby database.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
27939
27940
27941
27942
27943
27944
27945
27946
27947
27948
27949
27950
27951
27952
27953
27954
27955
27956
27957
27958
27959
27960
27961
27962
27963
27964
 
# File 'lib/oci/database/database_client.rb', line 27924

def switch_over_data_guard(database_id, switch_over_data_guard_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#switch_over_data_guard.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/switchover'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(switch_over_data_guard_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#switch_over_data_guard') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#switchover_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see Switch Roles in an Autonomous Data Guard Configuration.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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) —

    Unique identifier for the request.

Returns:



27989
27990
27991
27992
27993
27994
27995
27996
27997
27998
27999
28000
28001
28002
28003
28004
28005
28006
28007
28008
28009
28010
28011
28012
28013
28014
28015
28016
28017
28018
28019
28020
28021
28022
28023
28024
28025
28026
 
# File 'lib/oci/database/database_client.rb', line 27989

def switchover_autonomous_container_database_dataguard(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#switchover_autonomous_container_database_dataguard.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/switchover'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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: 'DatabaseClient#switchover_autonomous_container_database_dataguard') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#switchover_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the switchover_autonomous_container_database_dataguard operation to switches over the primary Autonomous Container Database (ACD) of an Autonomous Data Guard peer association to standby role. The standby ACD associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary ACD role.

A switchover incurs no data loss.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association 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.

Returns:



28051
28052
28053
28054
28055
28056
28057
28058
28059
28060
28061
28062
28063
28064
28065
28066
28067
28068
28069
28070
28071
28072
28073
28074
28075
28076
28077
28078
28079
28080
28081
28082
28083
28084
28085
28086
28087
28088
28089
 
# File 'lib/oci/database/database_client.rb', line 28051

def switchover_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#switchover_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/switchover'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#switchover_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#switchover_autonomous_database(autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional: - peerDbId Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the switchover will happen in the same region.

Parameters:

  • autonomous_database_id (String) —

    The database 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :peer_db_id (String) —

    The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



28128
28129
28130
28131
28132
28133
28134
28135
28136
28137
28138
28139
28140
28141
28142
28143
28144
28145
28146
28147
28148
28149
28150
28151
28152
28153
28154
28155
28156
28157
28158
28159
28160
28161
28162
28163
28164
28165
28166
28167
28168
28169
 
# File 'lib/oci/database/database_client.rb', line 28128

def switchover_autonomous_database(autonomous_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#switchover_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/actions/switchover'.sub('{autonomousDatabaseId}', autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:peerDbId] = opts[:peer_db_id] if opts[:peer_db_id]

  # 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-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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # 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: 'DatabaseClient#switchover_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#switchover_data_guard_association(database_id, data_guard_association_id, switchover_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role.

A switchover guarantees no data loss.

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.

Returns:



28196
28197
28198
28199
28200
28201
28202
28203
28204
28205
28206
28207
28208
28209
28210
28211
28212
28213
28214
28215
28216
28217
28218
28219
28220
28221
28222
28223
28224
28225
28226
28227
28228
28229
28230
28231
28232
28233
28234
28235
 
# File 'lib/oci/database/database_client.rb', line 28196

def switchover_data_guard_association(database_id, data_guard_association_id, switchover_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#switchover_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/switchover'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(switchover_data_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#switchover_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#terminate_autonomous_container_database(autonomous_container_database_id, opts = {}) ⇒ Response

Note:

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

Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database 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.

Returns:

  • (Response) —

    A Response object with data of type nil



28256
28257
28258
28259
28260
28261
28262
28263
28264
28265
28266
28267
28268
28269
28270
28271
28272
28273
28274
28275
28276
28277
28278
28279
28280
28281
28282
28283
28284
28285
28286
28287
28288
28289
28290
28291
 
# File 'lib/oci/database/database_client.rb', line 28256

def terminate_autonomous_container_database(autonomous_container_database_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#terminate_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#terminate_autonomous_container_database') 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

#terminate_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deprecated. To terminate an Exadata Infrastructure resource in the Oracle cloud, use the delete_cloud_exadata_infrastructure operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the delete_cloud_autonomous_vm_cluster operation.

Parameters:

  • autonomous_exadata_infrastructure_id (String) —

    The Autonomous Exadata Infrastructure 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.

Returns:

  • (Response) —

    A Response object with data of type nil



28313
28314
28315
28316
28317
28318
28319
28320
28321
28322
28323
28324
28325
28326
28327
28328
28329
28330
28331
28332
28333
28334
28335
28336
28337
28338
28339
28340
28341
28342
28343
28344
28345
28346
28347
28348
 
# File 'lib/oci/database/database_client.rb', line 28313

def terminate_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#terminate_autonomous_exadata_infrastructure.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#terminate_autonomous_exadata_infrastructure') 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

#terminate_db_system(db_system_id, opts = {}) ⇒ Response

Note:

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

Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Parameters:

  • db_system_id (String) —

    The DB system 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.

Returns:

  • (Response) —

    A Response object with data of type nil



28374
28375
28376
28377
28378
28379
28380
28381
28382
28383
28384
28385
28386
28387
28388
28389
28390
28391
28392
28393
28394
28395
28396
28397
28398
28399
28400
28401
28402
28403
28404
28405
28406
28407
28408
28409
 
# File 'lib/oci/database/database_client.rb', line 28374

def terminate_db_system(db_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#terminate_db_system.' if logger

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

  path = '/dbSystems/{dbSystemId}'.sub('{dbSystemId}', db_system_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#terminate_db_system') 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

#unmount_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {}) ⇒ Response

Note:

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

Unmounts the advanced cluster file system from all the virtual machines within a vmcluster.

Parameters:

  • advanced_cluster_file_system_id (String) —

    The advanced cluster file system Id 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



28439
28440
28441
28442
28443
28444
28445
28446
28447
28448
28449
28450
28451
28452
28453
28454
28455
28456
28457
28458
28459
28460
28461
28462
28463
28464
28465
28466
28467
28468
28469
28470
28471
28472
28473
28474
28475
28476
28477
28478
 
# File 'lib/oci/database/database_client.rb', line 28439

def unmount_advanced_cluster_file_system(advanced_cluster_file_system_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#unmount_advanced_cluster_file_system.' if logger

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

  path = '/advancedClusterFileSystems/{advancedClusterFileSystemId}/actions/unmount'.sub('{advancedClusterFileSystemId}', advanced_cluster_file_system_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DatabaseClient#unmount_advanced_cluster_file_system') 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::Database::Models::AdvancedClusterFileSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unmount_dbnode_snapshot(unmount_dbnode_snapshot_details, dbnode_snapshot_id, opts = {}) ⇒ Response

Note:

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

Unmounts the snapshot for the provided dbNode.

Parameters:

  • unmount_dbnode_snapshot_details (OCI::Database::Models::UnmountDbnodeSnapshotDetails) —

    Request to unmount the snapshot for the provided Exadata Database Node.

  • dbnode_snapshot_id (String) —

    The Exadata Database Node Snapshot 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_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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



28509
28510
28511
28512
28513
28514
28515
28516
28517
28518
28519
28520
28521
28522
28523
28524
28525
28526
28527
28528
28529
28530
28531
28532
28533
28534
28535
28536
28537
28538
28539
28540
28541
28542
28543
28544
28545
28546
28547
28548
28549
 
# File 'lib/oci/database/database_client.rb', line 28509

def unmount_dbnode_snapshot(unmount_dbnode_snapshot_details, dbnode_snapshot_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#unmount_dbnode_snapshot.' if logger

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

  path = '/dbnodeSnapshots/{dbnodeSnapshotId}/actions/unmount'.sub('{dbnodeSnapshotId}', dbnode_snapshot_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(unmount_dbnode_snapshot_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#unmount_dbnode_snapshot') 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::Database::Models::DbnodeSnapshot'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unregister_cloud_autonomous_vm_cluster_pkcs(cloud_autonomous_vm_cluster_id, unregister_cloud_autonomous_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Uninstall the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



28580
28581
28582
28583
28584
28585
28586
28587
28588
28589
28590
28591
28592
28593
28594
28595
28596
28597
28598
28599
28600
28601
28602
28603
28604
28605
28606
28607
28608
28609
28610
28611
28612
28613
28614
28615
28616
28617
28618
28619
 
# File 'lib/oci/database/database_client.rb', line 28580

def unregister_cloud_autonomous_vm_cluster_pkcs(cloud_autonomous_vm_cluster_id, unregister_cloud_autonomous_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#unregister_cloud_autonomous_vm_cluster_pkcs.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/unregisterPkcs'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(unregister_cloud_autonomous_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#unregister_cloud_autonomous_vm_cluster_pkcs') 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

#unregister_cloud_vm_cluster_pkcs(cloud_vm_cluster_id, unregister_cloud_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Uninstall the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



28650
28651
28652
28653
28654
28655
28656
28657
28658
28659
28660
28661
28662
28663
28664
28665
28666
28667
28668
28669
28670
28671
28672
28673
28674
28675
28676
28677
28678
28679
28680
28681
28682
28683
28684
28685
28686
28687
28688
28689
 
# File 'lib/oci/database/database_client.rb', line 28650

def unregister_cloud_vm_cluster_pkcs(cloud_vm_cluster_id, unregister_cloud_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#unregister_cloud_vm_cluster_pkcs.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/actions/unregisterPkcs'.sub('{cloudVmClusterId}', cloud_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(unregister_cloud_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#unregister_cloud_vm_cluster_pkcs') 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

#unregister_exadb_vm_cluster_pkcs(exadb_vm_cluster_id, unregister_exadb_vm_cluster_pkcs_details, opts = {}) ⇒ Response

Note:

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

Uninstall the PKCS11 driver for given keystore type

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:

  • (Response) —

    A Response object with data of type nil



28720
28721
28722
28723
28724
28725
28726
28727
28728
28729
28730
28731
28732
28733
28734
28735
28736
28737
28738
28739
28740
28741
28742
28743
28744
28745
28746
28747
28748
28749
28750
28751
28752
28753
28754
28755
28756
28757
28758
28759
 
# File 'lib/oci/database/database_client.rb', line 28720

def unregister_exadb_vm_cluster_pkcs(exadb_vm_cluster_id, unregister_exadb_vm_cluster_pkcs_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#unregister_exadb_vm_cluster_pkcs.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}/actions/unregisterPkcs'.sub('{exadbVmClusterId}', exadb_vm_cluster_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(unregister_exadb_vm_cluster_pkcs_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#unregister_exadb_vm_cluster_pkcs') 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

#update_advanced_cluster_file_system(advanced_cluster_file_system_id, update_advanced_cluster_file_system_details, opts = {}) ⇒ Response

Note:

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

Updates the advanced cluster file system resource.

Parameters:

  • advanced_cluster_file_system_id (String) —

    The advanced cluster file system Id OCID.

  • update_advanced_cluster_file_system_details (OCI::Database::Models::UpdateAdvancedClusterFileSystemDetails) —

    Request to update the properties of an advanced cluster file system.

  • 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) —

    Unique identifier for the request.

Returns:



28784
28785
28786
28787
28788
28789
28790
28791
28792
28793
28794
28795
28796
28797
28798
28799
28800
28801
28802
28803
28804
28805
28806
28807
28808
28809
28810
28811
28812
28813
28814
28815
28816
28817
28818
28819
28820
28821
28822
 
# File 'lib/oci/database/database_client.rb', line 28784

def update_advanced_cluster_file_system(advanced_cluster_file_system_id, update_advanced_cluster_file_system_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_advanced_cluster_file_system.' if logger

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

  path = '/advancedClusterFileSystems/{advancedClusterFileSystemId}'.sub('{advancedClusterFileSystemId}', advanced_cluster_file_system_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_advanced_cluster_file_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_advanced_cluster_file_system') 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::Database::Models::AdvancedClusterFileSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_container_database(autonomous_container_database_id, update_autonomous_container_database_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags.

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.

Returns:



28844
28845
28846
28847
28848
28849
28850
28851
28852
28853
28854
28855
28856
28857
28858
28859
28860
28861
28862
28863
28864
28865
28866
28867
28868
28869
28870
28871
28872
28873
28874
28875
28876
28877
28878
28879
28880
28881
 
# File 'lib/oci/database/database_client.rb', line 28844

def update_autonomous_container_database(autonomous_container_database_id, update_autonomous_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_container_database.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_container_database') 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::Database::Models::AutonomousContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, update_autonomous_container_database_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the edit_autonomous_container_database_dataguard operation to update an Autonomous Data Guard association.

Parameters:

  • autonomous_container_database_id (String) —

    The Autonomous Container Database OCID.

  • autonomous_container_database_dataguard_association_id (String) —

    The Autonomous Container Database-Autonomous Data Guard association OCID.

  • update_autonomous_container_database_data_guard_association_details (OCI::Database::Models::UpdateAutonomousContainerDatabaseDataGuardAssociationDetails) —

    A request to update Data Guard association of a database.

  • 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) —

    Unique identifier for the request.

Returns:



28907
28908
28909
28910
28911
28912
28913
28914
28915
28916
28917
28918
28919
28920
28921
28922
28923
28924
28925
28926
28927
28928
28929
28930
28931
28932
28933
28934
28935
28936
28937
28938
28939
28940
28941
28942
28943
28944
28945
28946
28947
 
# File 'lib/oci/database/database_client.rb', line 28907

def update_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, update_autonomous_container_database_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_container_database_dataguard_association.' if logger

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

  path = '/autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}'.sub('{autonomousContainerDatabaseId}', autonomous_container_database_id.to_s).sub('{autonomousContainerDatabaseDataguardAssociationId}', autonomous_container_database_dataguard_association_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_autonomous_container_database_data_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_container_database_dataguard_association') 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::Database::Models::AutonomousContainerDatabaseDataguardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_database(autonomous_database_id, update_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.

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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



28975
28976
28977
28978
28979
28980
28981
28982
28983
28984
28985
28986
28987
28988
28989
28990
28991
28992
28993
28994
28995
28996
28997
28998
28999
29000
29001
29002
29003
29004
29005
29006
29007
29008
29009
29010
29011
29012
29013
29014
 
# File 'lib/oci/database/database_client.rb', line 28975

def update_autonomous_database(autonomous_database_id, update_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_database.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}'.sub('{autonomousDatabaseId}', autonomous_database_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_database') 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::Database::Models::AutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_database_backup(autonomous_database_backup_id, update_autonomous_database_backup_details, opts = {}) ⇒ Response

Note:

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

Updates the Autonomous AI Database backup of the specified database based on the request parameters.

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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



29042
29043
29044
29045
29046
29047
29048
29049
29050
29051
29052
29053
29054
29055
29056
29057
29058
29059
29060
29061
29062
29063
29064
29065
29066
29067
29068
29069
29070
29071
29072
29073
29074
29075
29076
29077
29078
29079
29080
29081
 
# File 'lib/oci/database/database_client.rb', line 29042

def update_autonomous_database_backup(autonomous_database_backup_id, update_autonomous_database_backup_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_database_backup.' if logger

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

  path = '/autonomousDatabaseBackups/{autonomousDatabaseBackupId}'.sub('{autonomousDatabaseBackupId}', autonomous_database_backup_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_database_backup_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_database_backup') 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::Database::Models::AutonomousDatabaseBackup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_database_regional_wallet(update_autonomous_database_wallet_details, opts = {}) ⇒ Response

Note:

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

Updates the Autonomous AI Database regional wallet.

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.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



29104
29105
29106
29107
29108
29109
29110
29111
29112
29113
29114
29115
29116
29117
29118
29119
29120
29121
29122
29123
29124
29125
29126
29127
29128
29129
29130
29131
29132
29133
29134
29135
29136
29137
29138
29139
 
# File 'lib/oci/database/database_client.rb', line 29104

def update_autonomous_database_regional_wallet(update_autonomous_database_wallet_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_database_regional_wallet.' if logger

  raise "Missing the required parameter 'update_autonomous_database_wallet_details' when calling update_autonomous_database_regional_wallet." if update_autonomous_database_wallet_details.nil?

  path = '/autonomousDatabases/wallet'
  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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_database_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_database_regional_wallet') 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_autonomous_database_software_image(autonomous_database_software_image_id, update_autonomous_database_software_image_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an Autonomous AI Database Software Image, like add tags

Parameters:

  • autonomous_database_software_image_id (String) —

    The Autonomous AI Database Software Image OCID.

  • update_autonomous_database_software_image_details (OCI::Database::Models::UpdateAutonomousDatabaseSoftwareImageDetails) —

    Request to update the properties of an Autonomous AI Database Software Image.

  • 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) —

    Unique identifier for the request.

Returns:



29163
29164
29165
29166
29167
29168
29169
29170
29171
29172
29173
29174
29175
29176
29177
29178
29179
29180
29181
29182
29183
29184
29185
29186
29187
29188
29189
29190
29191
29192
29193
29194
29195
29196
29197
29198
29199
29200
29201
 
# File 'lib/oci/database/database_client.rb', line 29163

def update_autonomous_database_software_image(autonomous_database_software_image_id, update_autonomous_database_software_image_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_database_software_image.' if logger

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

  path = '/autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}'.sub('{autonomousDatabaseSoftwareImageId}', autonomous_database_software_image_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_autonomous_database_software_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_database_software_image') 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::Database::Models::AutonomousDatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_database_wallet(autonomous_database_id, update_autonomous_database_wallet_details, opts = {}) ⇒ Response

Note:

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

Updates the wallet for the specified Autonomous AI Database.

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.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



29225
29226
29227
29228
29229
29230
29231
29232
29233
29234
29235
29236
29237
29238
29239
29240
29241
29242
29243
29244
29245
29246
29247
29248
29249
29250
29251
29252
29253
29254
29255
29256
29257
29258
29259
29260
29261
29262
 
# File 'lib/oci/database/database_client.rb', line 29225

def update_autonomous_database_wallet(autonomous_database_id, update_autonomous_database_wallet_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_database_wallet.' if logger

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

  path = '/autonomousDatabases/{autonomousDatabaseId}/wallet'.sub('{autonomousDatabaseId}', autonomous_database_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_database_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_database_wallet') 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_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, update_autonomous_exadata_infrastructures_details, opts = {}) ⇒ Response

Note:

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

Deprecated. Use the update_cloud_exadata_infrastructure operation to update an Exadata Infrastructure resource and update_cloud_autonomous_vm_cluster operation to update an Autonomous Exadata VM cluster.

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.

Returns:



29285
29286
29287
29288
29289
29290
29291
29292
29293
29294
29295
29296
29297
29298
29299
29300
29301
29302
29303
29304
29305
29306
29307
29308
29309
29310
29311
29312
29313
29314
29315
29316
29317
29318
29319
29320
29321
29322
 
# File 'lib/oci/database/database_client.rb', line 29285

def update_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, update_autonomous_exadata_infrastructures_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_exadata_infrastructure.' if logger

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

  path = '/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}'.sub('{autonomousExadataInfrastructureId}', autonomous_exadata_infrastructure_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_autonomous_exadata_infrastructures_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_exadata_infrastructure') 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::Database::Models::AutonomousExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_autonomous_vm_cluster(autonomous_vm_cluster_id, update_autonomous_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see update_cloud_autonomous_vm_cluster.

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) —

    Unique identifier for the request.

Returns:



29347
29348
29349
29350
29351
29352
29353
29354
29355
29356
29357
29358
29359
29360
29361
29362
29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
29373
29374
29375
29376
29377
29378
29379
29380
29381
29382
29383
29384
29385
 
# File 'lib/oci/database/database_client.rb', line 29347

def update_autonomous_vm_cluster(autonomous_vm_cluster_id, update_autonomous_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_autonomous_vm_cluster.' if logger

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

  path = '/autonomousVmClusters/{autonomousVmClusterId}'.sub('{autonomousVmClusterId}', autonomous_vm_cluster_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_autonomous_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_autonomous_vm_cluster') 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::Database::Models::AutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_backup(backup_id, update_backup_details, opts = {}) ⇒ Response

Note:

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

Updates database backup details.

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) —

    Unique identifier for the request.

Returns:



29409
29410
29411
29412
29413
29414
29415
29416
29417
29418
29419
29420
29421
29422
29423
29424
29425
29426
29427
29428
29429
29430
29431
29432
29433
29434
29435
29436
29437
29438
29439
29440
29441
29442
29443
29444
29445
29446
29447
 
# File 'lib/oci/database/database_client.rb', line 29409

def update_backup(backup_id, update_backup_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_backup.' if logger

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

  path = '/backups/{backupId}'.sub('{backupId}', backup_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_backup_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_backup') 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::Database::Models::Backup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_backup_destination(backup_destination_id, update_backup_destination_details, opts = {}) ⇒ Response

Note:

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

If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. - For an NFS backup destination, updates the NFS location.

Parameters:

  • backup_destination_id (String) —

    The OCID of the backup destination.

  • update_backup_destination_details (OCI::Database::Models::UpdateBackupDestinationDetails) —

    For a RECOVERY_APPLIANCE backup destination, request to update the connection string and/or the list of VPC users. For an NFS backup destination, request to update the NFS location.

  • 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) —

    Unique identifier for the request.

Returns:



29476
29477
29478
29479
29480
29481
29482
29483
29484
29485
29486
29487
29488
29489
29490
29491
29492
29493
29494
29495
29496
29497
29498
29499
29500
29501
29502
29503
29504
29505
29506
29507
29508
29509
29510
29511
29512
29513
29514
 
# File 'lib/oci/database/database_client.rb', line 29476

def update_backup_destination(backup_destination_id, update_backup_destination_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_backup_destination.' if logger

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

  path = '/backupDestinations/{backupDestinationId}'.sub('{backupDestinationId}', backup_destination_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_backup_destination_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_backup_destination') 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::Database::Models::BackupDestination'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_basecc_vm_cluster(basecc_vm_cluster_id, update_basecc_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified BaseDB-C@C VM cluster. Applies to Base Database Service on Cloud@Customer instances only.

Parameters:

  • basecc_vm_cluster_id (String) —

    The BaseDB-C@C VM cluster OCID.

  • update_basecc_vm_cluster_details (OCI::Database::Models::UpdateBaseccVmClusterDetails) —

    Request to update the attributes of a BaseDB-C@C VM cluster.

  • 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) —

    Unique identifier for the request.

Returns:



29539
29540
29541
29542
29543
29544
29545
29546
29547
29548
29549
29550
29551
29552
29553
29554
29555
29556
29557
29558
29559
29560
29561
29562
29563
29564
29565
29566
29567
29568
29569
29570
29571
29572
29573
29574
29575
29576
29577
 
# File 'lib/oci/database/database_client.rb', line 29539

def update_basecc_vm_cluster(basecc_vm_cluster_id, update_basecc_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_basecc_vm_cluster.' if logger

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

  path = '/baseccVmClusters/{baseccVmClusterId}'.sub('{baseccVmClusterId}', basecc_vm_cluster_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_basecc_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_basecc_vm_cluster') 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::Database::Models::BaseccVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, update_cloud_autonomous_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see update_autonomous_vm_cluster.

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) —

    Unique identifier for the request.

  • :opc_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



29605
29606
29607
29608
29609
29610
29611
29612
29613
29614
29615
29616
29617
29618
29619
29620
29621
29622
29623
29624
29625
29626
29627
29628
29629
29630
29631
29632
29633
29634
29635
29636
29637
29638
29639
29640
29641
29642
29643
29644
 
# File 'lib/oci/database/database_client.rb', line 29605

def update_cloud_autonomous_vm_cluster(cloud_autonomous_vm_cluster_id, update_cloud_autonomous_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_cloud_autonomous_vm_cluster.' if logger

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

  path = '/cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}'.sub('{cloudAutonomousVmClusterId}', cloud_autonomous_vm_cluster_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]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_cloud_autonomous_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_cloud_autonomous_vm_cluster') 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::Database::Models::CloudAutonomousVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, update_cloud_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.

Parameters:

  • cloud_exadata_infrastructure_id (String) —

    The cloud Exadata infrastructure OCID.

  • update_cloud_exadata_infrastructure_details (OCI::Database::Models::UpdateCloudExadataInfrastructureDetails) —

    Request to update the properties of an cloud Exadata infrastructure resource.

  • 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) —

    Unique identifier for the request.

Returns:



29669
29670
29671
29672
29673
29674
29675
29676
29677
29678
29679
29680
29681
29682
29683
29684
29685
29686
29687
29688
29689
29690
29691
29692
29693
29694
29695
29696
29697
29698
29699
29700
29701
29702
29703
29704
29705
29706
29707
 
# File 'lib/oci/database/database_client.rb', line 29669

def update_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, update_cloud_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_cloud_exadata_infrastructure.' if logger

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

  path = '/cloudExadataInfrastructures/{cloudExadataInfrastructureId}'.sub('{cloudExadataInfrastructureId}', cloud_exadata_infrastructure_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_cloud_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_cloud_exadata_infrastructure') 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::Database::Models::CloudExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cloud_vm_cluster(cloud_vm_cluster_id, update_cloud_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

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) —

    Unique identifier for the request.

Returns:



29732
29733
29734
29735
29736
29737
29738
29739
29740
29741
29742
29743
29744
29745
29746
29747
29748
29749
29750
29751
29752
29753
29754
29755
29756
29757
29758
29759
29760
29761
29762
29763
29764
29765
29766
29767
29768
29769
29770
 
# File 'lib/oci/database/database_client.rb', line 29732

def update_cloud_vm_cluster(cloud_vm_cluster_id, update_cloud_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_cloud_vm_cluster.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}'.sub('{cloudVmClusterId}', cloud_vm_cluster_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_cloud_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_cloud_vm_cluster') 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::Database::Models::CloudVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cloud_vm_cluster_iorm_config(cloud_vm_cluster_id, cloud_vm_cluster_iorm_config_update_details, opts = {}) ⇒ Response

Note:

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

Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance.

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_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:



29795
29796
29797
29798
29799
29800
29801
29802
29803
29804
29805
29806
29807
29808
29809
29810
29811
29812
29813
29814
29815
29816
29817
29818
29819
29820
29821
29822
29823
29824
29825
29826
29827
29828
29829
29830
29831
29832
29833
 
# File 'lib/oci/database/database_client.rb', line 29795

def update_cloud_vm_cluster_iorm_config(cloud_vm_cluster_id, cloud_vm_cluster_iorm_config_update_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_cloud_vm_cluster_iorm_config.' if logger

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

  path = '/cloudVmClusters/{cloudVmClusterId}/CloudVmClusterIormConfig'.sub('{cloudVmClusterId}', cloud_vm_cluster_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(cloud_vm_cluster_iorm_config_update_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_cloud_vm_cluster_iorm_config') 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::Database::Models::ExadataIormConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_console_connection(db_node_id, console_connection_id, update_console_connection_details, opts = {}) ⇒ Response

Note:

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

Updates the specified database node console connection.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_connection_id (String) —

    The OCID of the console connection.

  • update_console_connection_details (OCI::Database::Models::UpdateConsoleConnectionDetails) —

    Request to update the specified database node console 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) —

    Unique identifier for the request.

Returns:



29858
29859
29860
29861
29862
29863
29864
29865
29866
29867
29868
29869
29870
29871
29872
29873
29874
29875
29876
29877
29878
29879
29880
29881
29882
29883
29884
29885
29886
29887
29888
29889
29890
29891
29892
29893
29894
29895
29896
29897
29898
 
# File 'lib/oci/database/database_client.rb', line 29858

def update_console_connection(db_node_id, console_connection_id, update_console_connection_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_console_connection.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleConnectionId}', console_connection_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_console_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_console_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::Database::Models::ConsoleConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_console_history(db_node_id, console_history_id, update_console_history_details, opts = {}) ⇒ Response

Note:

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

Updates the specified database node console history.

Parameters:

  • db_node_id (String) —

    The database node OCID.

  • console_history_id (String) —

    The OCID of the console history.

  • update_console_history_details (OCI::Database::Models::UpdateConsoleHistoryDetails) —

    Request to update the specified database node console history.

  • 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) —

    Unique identifier for the request.

Returns:



29924
29925
29926
29927
29928
29929
29930
29931
29932
29933
29934
29935
29936
29937
29938
29939
29940
29941
29942
29943
29944
29945
29946
29947
29948
29949
29950
29951
29952
29953
29954
29955
29956
29957
29958
29959
29960
29961
29962
29963
29964
 
# File 'lib/oci/database/database_client.rb', line 29924

def update_console_history(db_node_id, console_history_id, update_console_history_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_console_history.' if logger

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

  path = '/dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}'.sub('{dbNodeId}', db_node_id.to_s).sub('{consoleHistoryId}', console_history_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_console_history_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_console_history') 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::Database::Models::ConsoleHistory'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_guard(database_id, update_data_guard_details, opts = {}) ⇒ Response

Note:

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

Update an existing Data Guard member. A Data Guard member represents the replication relationship between the specified database and a standby database. For more information, see Using Oracle Data Guard.

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 may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :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:



29996
29997
29998
29999
30000
30001
30002
30003
30004
30005
30006
30007
30008
30009
30010
30011
30012
30013
30014
30015
30016
30017
30018
30019
30020
30021
30022
30023
30024
30025
30026
30027
30028
30029
30030
30031
30032
30033
30034
30035
30036
 
# File 'lib/oci/database/database_client.rb', line 29996

def update_data_guard(database_id, update_data_guard_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_data_guard.' if logger

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

  path = '/databases/{databaseId}/dataGuard/actions/updateDataGuard'.sub('{databaseId}', database_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-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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_data_guard_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_data_guard') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_guard_association(database_id, data_guard_association_id, update_data_guard_association_details, opts = {}) ⇒ Response

Note:

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

Updates the Data Guard association the specified database. This API can be used to change the protectionMode and transportType of the Data Guard association.

Parameters:

  • database_id (String) —

    The database OCID.

  • data_guard_association_id (String) —

    The Data Guard association's OCID.

  • update_data_guard_association_details (OCI::Database::Models::UpdateDataGuardAssociationDetails) —

    A request to update Data Guard association of a database.

  • 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) —

    Unique identifier for the request.

Returns:



30062
30063
30064
30065
30066
30067
30068
30069
30070
30071
30072
30073
30074
30075
30076
30077
30078
30079
30080
30081
30082
30083
30084
30085
30086
30087
30088
30089
30090
30091
30092
30093
30094
30095
30096
30097
30098
30099
30100
30101
30102
 
# File 'lib/oci/database/database_client.rb', line 30062

def update_data_guard_association(database_id, data_guard_association_id, update_data_guard_association_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_data_guard_association.' if logger

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

  path = '/databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}'.sub('{databaseId}', database_id.to_s).sub('{dataGuardAssociationId}', data_guard_association_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_data_guard_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_data_guard_association') 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::Database::Models::DataGuardAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database(database_id, update_database_details, opts = {}) ⇒ Response

Note:

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

Update the specified database based on the request parameters provided.

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.

Returns:



30125
30126
30127
30128
30129
30130
30131
30132
30133
30134
30135
30136
30137
30138
30139
30140
30141
30142
30143
30144
30145
30146
30147
30148
30149
30150
30151
30152
30153
30154
30155
30156
30157
30158
30159
30160
30161
30162
 
# File 'lib/oci/database/database_client.rb', line 30125

def update_database(database_id, update_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_database.' if logger

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

  path = '/databases/{databaseId}'.sub('{databaseId}', database_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_database') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_software_image(database_software_image_id, update_database_software_image_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a Database Software Image, like Display Nmae

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.

Returns:



30184
30185
30186
30187
30188
30189
30190
30191
30192
30193
30194
30195
30196
30197
30198
30199
30200
30201
30202
30203
30204
30205
30206
30207
30208
30209
30210
30211
30212
30213
30214
30215
30216
30217
30218
30219
30220
30221
 
# File 'lib/oci/database/database_client.rb', line 30184

def update_database_software_image(database_software_image_id, update_database_software_image_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_database_software_image.' if logger

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

  path = '/databaseSoftwareImages/{databaseSoftwareImageId}'.sub('{databaseSoftwareImageId}', database_software_image_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_database_software_image_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_database_software_image') 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::Database::Models::DatabaseSoftwareImage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_db_home(db_home_id, update_db_home_details, opts = {}) ⇒ Response

Note:

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

Patches the specified Database Home.

Parameters:

  • db_home_id (String) —

    The Database Home OCID.

  • update_db_home_details (OCI::Database::Models::UpdateDbHomeDetails) —

    Request to update the properties of a Database Home.

  • 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.

Returns:



30243
30244
30245
30246
30247
30248
30249
30250
30251
30252
30253
30254
30255
30256
30257
30258
30259
30260
30261
30262
30263
30264
30265
30266
30267
30268
30269
30270
30271
30272
30273
30274
30275
30276
30277
30278
30279
30280
 
# File 'lib/oci/database/database_client.rb', line 30243

def update_db_home(db_home_id, update_db_home_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_db_home.' if logger

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

  path = '/dbHomes/{dbHomeId}'.sub('{dbHomeId}', db_home_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_db_home_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_db_home') 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::Database::Models::DbHome'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_db_node(db_node_id, update_db_node_details, opts = {}) ⇒ Response

Note:

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

Updates the specified database node.

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) —

    Unique identifier for the request.

Returns:



30304
30305
30306
30307
30308
30309
30310
30311
30312
30313
30314
30315
30316
30317
30318
30319
30320
30321
30322
30323
30324
30325
30326
30327
30328
30329
30330
30331
30332
30333
30334
30335
30336
30337
30338
30339
30340
30341
30342
 
# File 'lib/oci/database/database_client.rb', line 30304

def update_db_node(db_node_id, update_db_node_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_db_node.' if logger

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

  path = '/dbNodes/{dbNodeId}'.sub('{dbNodeId}', db_node_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_db_node_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_db_node') 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::Database::Models::DbNode'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_db_system(db_system_id, update_db_system_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of the specified DB system.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

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_dry_run (BOOLEAN) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not actually creating or updating a resource and is used only to perform validation on the submitted data. (default to false)

Returns:



30372
30373
30374
30375
30376
30377
30378
30379
30380
30381
30382
30383
30384
30385
30386
30387
30388
30389
30390
30391
30392
30393
30394
30395
30396
30397
30398
30399
30400
30401
30402
30403
30404
30405
30406
30407
30408
30409
30410
 
# File 'lib/oci/database/database_client.rb', line 30372

def update_db_system(db_system_id, update_db_system_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_db_system.' if logger

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

  path = '/dbSystems/{dbSystemId}'.sub('{dbSystemId}', db_system_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-dry-run'] = opts[:opc_dry_run] if !opts[:opc_dry_run].nil?
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_db_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_db_system') 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::Database::Models::DbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_exadata_infrastructure(exadata_infrastructure_id, update_exadata_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To update an Exadata Cloud Service infrastructure resource, use the update_cloud_exadata_infrastructure operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • update_exadata_infrastructure_details (OCI::Database::Models::UpdateExadataInfrastructureDetails) —

    Request to update the properties of an Exadata Cloud@Customer infrastructure.

  • 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) —

    Unique identifier for the request.

Returns:



30436
30437
30438
30439
30440
30441
30442
30443
30444
30445
30446
30447
30448
30449
30450
30451
30452
30453
30454
30455
30456
30457
30458
30459
30460
30461
30462
30463
30464
30465
30466
30467
30468
30469
30470
30471
30472
30473
30474
 
# File 'lib/oci/database/database_client.rb', line 30436

def update_exadata_infrastructure(exadata_infrastructure_id, update_exadata_infrastructure_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_exadata_infrastructure.' if logger

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

  path = '/exadataInfrastructures/{exadataInfrastructureId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_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_exadata_infrastructure_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_exadata_infrastructure') 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::Database::Models::ExadataInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_exadata_iorm_config(db_system_id, exadata_iorm_config_update_details, opts = {}) ⇒ Response

Note:

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

Updates IORM settings for the specified Exadata DB system.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

The update_cloud_vm_cluster_iorm_config API is used for Exadata systems using the new resource model.

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_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:



30506
30507
30508
30509
30510
30511
30512
30513
30514
30515
30516
30517
30518
30519
30520
30521
30522
30523
30524
30525
30526
30527
30528
30529
30530
30531
30532
30533
30534
30535
30536
30537
30538
30539
30540
30541
30542
30543
30544
 
# File 'lib/oci/database/database_client.rb', line 30506

def update_exadata_iorm_config(db_system_id, exadata_iorm_config_update_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_exadata_iorm_config.' if logger

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

  path = '/dbSystems/{dbSystemId}/ExadataIormConfig'.sub('{dbSystemId}', db_system_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(exadata_iorm_config_update_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_exadata_iorm_config') 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::Database::Models::ExadataIormConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_exadb_vm_cluster(exadb_vm_cluster_id, update_exadb_vm_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.

Parameters:

  • exadb_vm_cluster_id (String) —

    The Exadata VM cluster OCID on Exascale Infrastructure.

  • update_exadb_vm_cluster_details (OCI::Database::Models::UpdateExadbVmClusterDetails) —

    Request to update the attributes of a Exadata VM cluster on Exascale Infrastructure.

  • 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) —

    Unique identifier for the request.

Returns:



30569
30570
30571
30572
30573
30574
30575
30576
30577
30578
30579
30580
30581
30582
30583
30584
30585
30586
30587
30588
30589
30590
30591
30592
30593
30594
30595
30596
30597
30598
30599
30600
30601
30602
30603
30604
30605
30606
30607
 
# File 'lib/oci/database/database_client.rb', line 30569

def update_exadb_vm_cluster(exadb_vm_cluster_id, update_exadb_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_exadb_vm_cluster.' if logger

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

  path = '/exadbVmClusters/{exadbVmClusterId}'.sub('{exadbVmClusterId}', exadb_vm_cluster_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_exadb_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_exadb_vm_cluster') 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::Database::Models::ExadbVmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_exascale_db_storage_vault(exascale_db_storage_vault_id, update_exascale_db_storage_vault_details, opts = {}) ⇒ Response

Note:

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

Updates the specified Exadata Database Storage Vault.

Parameters:

  • exascale_db_storage_vault_id (String) —

    The Exadata Database Storage Vault OCID.

  • update_exascale_db_storage_vault_details (OCI::Database::Models::UpdateExascaleDbStorageVaultDetails) —

    Request to update the attributes of a Exadata Database Storage Vault.

  • 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) —

    Unique identifier for the request.

Returns:



30632
30633
30634
30635
30636
30637
30638
30639
30640
30641
30642
30643
30644
30645
30646
30647
30648
30649
30650
30651
30652
30653
30654
30655
30656
30657
30658
30659
30660
30661
30662
30663
30664
30665
30666
30667
30668
30669
30670
 
# File 'lib/oci/database/database_client.rb', line 30632

def update_exascale_db_storage_vault(exascale_db_storage_vault_id, update_exascale_db_storage_vault_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_exascale_db_storage_vault.' if logger

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

  path = '/exascaleDbStorageVaults/{exascaleDbStorageVaultId}'.sub('{exascaleDbStorageVaultId}', exascale_db_storage_vault_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_exascale_db_storage_vault_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_exascale_db_storage_vault') 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::Database::Models::ExascaleDbStorageVault'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_execution_action(execution_action_id, update_execution_action_details, opts = {}) ⇒ Response

Note:

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

Updates the execution action 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) —

    Unique identifier for the request.

Returns:



30695
30696
30697
30698
30699
30700
30701
30702
30703
30704
30705
30706
30707
30708
30709
30710
30711
30712
30713
30714
30715
30716
30717
30718
30719
30720
30721
30722
30723
30724
30725
30726
30727
30728
30729
30730
30731
30732
30733
 
# File 'lib/oci/database/database_client.rb', line 30695

def update_execution_action(execution_action_id, update_execution_action_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_execution_action.' if logger

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

  path = '/executionActions/{executionActionId}'.sub('{executionActionId}', execution_action_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_execution_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_execution_action') 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::Database::Models::ExecutionAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_execution_window(execution_window_id, update_execution_window_details, opts = {}) ⇒ Response

Note:

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

Updates the execution window 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) —

    Unique identifier for the request.

Returns:



30758
30759
30760
30761
30762
30763
30764
30765
30766
30767
30768
30769
30770
30771
30772
30773
30774
30775
30776
30777
30778
30779
30780
30781
30782
30783
30784
30785
30786
30787
30788
30789
30790
30791
30792
30793
30794
30795
30796
 
# File 'lib/oci/database/database_client.rb', line 30758

def update_execution_window(execution_window_id, update_execution_window_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_execution_window.' if logger

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

  path = '/executionWindows/{executionWindowId}'.sub('{executionWindowId}', execution_window_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_execution_window_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_execution_window') 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::Database::Models::ExecutionWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_container_database(external_container_database_id, update_external_container_database_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an create_external_container_database_details resource, such as the display name.

Parameters:

  • external_container_database_id (String) —

    The ExternalContainerDatabase OCID.

  • update_external_container_database_details (OCI::Database::Models::UpdateExternalContainerDatabaseDetails) —

    Request to update the properties of an create_external_container_database_details resource.

  • 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) —

    Unique identifier for the request.

Returns:



30825
30826
30827
30828
30829
30830
30831
30832
30833
30834
30835
30836
30837
30838
30839
30840
30841
30842
30843
30844
30845
30846
30847
30848
30849
30850
30851
30852
30853
30854
30855
30856
30857
30858
30859
30860
30861
30862
30863
 
# File 'lib/oci/database/database_client.rb', line 30825

def update_external_container_database(external_container_database_id, update_external_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_external_container_database.' if logger

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

  path = '/externalcontainerdatabases/{externalContainerDatabaseId}'.sub('{externalContainerDatabaseId}', external_container_database_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_external_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_external_container_database') 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::Database::Models::ExternalContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_database_connector(external_database_connector_id, update_external_database_connector_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an external database connector, such as the display name.

Parameters:

  • external_database_connector_id (String) —

    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

  • update_external_database_connector_details (OCI::Database::Models::UpdateExternalDatabaseConnectorDetails) —

    Request to update the properties of an external database connector.

  • 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) —

    Unique identifier for the request.

Returns:



30889
30890
30891
30892
30893
30894
30895
30896
30897
30898
30899
30900
30901
30902
30903
30904
30905
30906
30907
30908
30909
30910
30911
30912
30913
30914
30915
30916
30917
30918
30919
30920
30921
30922
30923
30924
30925
30926
30927
 
# File 'lib/oci/database/database_client.rb', line 30889

def update_external_database_connector(external_database_connector_id, update_external_database_connector_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_external_database_connector.' if logger

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

  path = '/externaldatabaseconnectors/{externalDatabaseConnectorId}'.sub('{externalDatabaseConnectorId}', external_database_connector_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_external_database_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_external_database_connector') 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::Database::Models::ExternalDatabaseConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_non_container_database(external_non_container_database_id, update_external_non_container_database_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an external non-container database, such as the display name.

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) —

    Unique identifier for the request.

Returns:



30951
30952
30953
30954
30955
30956
30957
30958
30959
30960
30961
30962
30963
30964
30965
30966
30967
30968
30969
30970
30971
30972
30973
30974
30975
30976
30977
30978
30979
30980
30981
30982
30983
30984
30985
30986
30987
30988
30989
 
# File 'lib/oci/database/database_client.rb', line 30951

def update_external_non_container_database(external_non_container_database_id, update_external_non_container_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_external_non_container_database.' if logger

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

  path = '/externalnoncontainerdatabases/{externalNonContainerDatabaseId}'.sub('{externalNonContainerDatabaseId}', external_non_container_database_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_external_non_container_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_external_non_container_database') 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::Database::Models::ExternalNonContainerDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_external_pluggable_database(external_pluggable_database_id, update_external_pluggable_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_external_pluggable_database API.

Updates the properties of an create_external_pluggable_database_details resource, such as the display name.

Parameters:

  • external_pluggable_database_id (String) —

    The ExternalPluggableDatabaseId OCID.

  • update_external_pluggable_database_details (OCI::Database::Models::UpdateExternalPluggableDatabaseDetails) —

    Request to update the properties of an external pluggable database resource.

  • 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) —

    Unique identifier for the request.

Returns:



31016
31017
31018
31019
31020
31021
31022
31023
31024
31025
31026
31027
31028
31029
31030
31031
31032
31033
31034
31035
31036
31037
31038
31039
31040
31041
31042
31043
31044
31045
31046
31047
31048
31049
31050
31051
31052
31053
31054
 
# File 'lib/oci/database/database_client.rb', line 31016

def update_external_pluggable_database(external_pluggable_database_id, update_external_pluggable_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_external_pluggable_database.' if logger

  raise "Missing the required parameter 'external_pluggable_database_id' when calling update_external_pluggable_database." if external_pluggable_database_id.nil?
  raise "Missing the required parameter 'update_external_pluggable_database_details' when calling update_external_pluggable_database." if update_external_pluggable_database_details.nil?
  raise "Parameter value for 'external_pluggable_database_id' must not be blank" if OCI::Internal::Util.blank_string?(external_pluggable_database_id)

  path = '/externalpluggabledatabases/{externalPluggableDatabaseId}'.sub('{externalPluggableDatabaseId}', external_pluggable_database_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_external_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_external_pluggable_database') 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::Database::Models::ExternalPluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_key_store(key_store_id, update_key_store_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_key_store API.

Edit the key store.

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) —

    Unique identifier for the request.

Returns:



31080
31081
31082
31083
31084
31085
31086
31087
31088
31089
31090
31091
31092
31093
31094
31095
31096
31097
31098
31099
31100
31101
31102
31103
31104
31105
31106
31107
31108
31109
31110
31111
31112
31113
31114
31115
31116
31117
31118
 
# File 'lib/oci/database/database_client.rb', line 31080

def update_key_store(key_store_id, update_key_store_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_key_store.' if logger

  raise "Missing the required parameter 'key_store_id' when calling update_key_store." if key_store_id.nil?
  raise "Missing the required parameter 'update_key_store_details' when calling update_key_store." if update_key_store_details.nil?
  raise "Parameter value for 'key_store_id' must not be blank" if OCI::Internal::Util.blank_string?(key_store_id)

  path = '/keyStores/{keyStoreId}'.sub('{keyStoreId}', key_store_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_key_store_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_key_store') 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::Database::Models::KeyStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_maintenance_run(maintenance_run_id, update_maintenance_run_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_maintenance_run API.

Updates the properties of a maintenance run, such as the state of a maintenance run.

Parameters:

  • maintenance_run_id (String) —

    The maintenance run OCID.

  • update_maintenance_run_details (OCI::Database::Models::UpdateMaintenanceRunDetails) —

    Request to update the properties of a maintenance run.

  • 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.

Returns:



31140
31141
31142
31143
31144
31145
31146
31147
31148
31149
31150
31151
31152
31153
31154
31155
31156
31157
31158
31159
31160
31161
31162
31163
31164
31165
31166
31167
31168
31169
31170
31171
31172
31173
31174
31175
31176
31177
 
# File 'lib/oci/database/database_client.rb', line 31140

def update_maintenance_run(maintenance_run_id, update_maintenance_run_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_maintenance_run.' if logger

  raise "Missing the required parameter 'maintenance_run_id' when calling update_maintenance_run." if maintenance_run_id.nil?
  raise "Missing the required parameter 'update_maintenance_run_details' when calling update_maintenance_run." if update_maintenance_run_details.nil?
  raise "Parameter value for 'maintenance_run_id' must not be blank" if OCI::Internal::Util.blank_string?(maintenance_run_id)

  path = '/maintenanceRuns/{maintenanceRunId}'.sub('{maintenanceRunId}', maintenance_run_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_maintenance_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_maintenance_run') 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::Database::Models::MaintenanceRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_oneoff_patch(oneoff_patch_id, update_oneoff_patch_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_oneoff_patch API.

Updates the properties of the specified one-off patch.

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) —

    Unique identifier for the request.

Returns:



31202
31203
31204
31205
31206
31207
31208
31209
31210
31211
31212
31213
31214
31215
31216
31217
31218
31219
31220
31221
31222
31223
31224
31225
31226
31227
31228
31229
31230
31231
31232
31233
31234
31235
31236
31237
31238
31239
31240
 
# File 'lib/oci/database/database_client.rb', line 31202

def update_oneoff_patch(oneoff_patch_id, update_oneoff_patch_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_oneoff_patch.' if logger

  raise "Missing the required parameter 'oneoff_patch_id' when calling update_oneoff_patch." if oneoff_patch_id.nil?
  raise "Missing the required parameter 'update_oneoff_patch_details' when calling update_oneoff_patch." if update_oneoff_patch_details.nil?
  raise "Parameter value for 'oneoff_patch_id' must not be blank" if OCI::Internal::Util.blank_string?(oneoff_patch_id)

  path = '/oneoffPatches/{oneoffPatchId}'.sub('{oneoffPatchId}', oneoff_patch_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_oneoff_patch_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_oneoff_patch') 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::Database::Models::OneoffPatch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_pluggable_database(pluggable_database_id, update_pluggable_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_pluggable_database API.

Updates the specified pluggable database.

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.

Returns:



31262
31263
31264
31265
31266
31267
31268
31269
31270
31271
31272
31273
31274
31275
31276
31277
31278
31279
31280
31281
31282
31283
31284
31285
31286
31287
31288
31289
31290
31291
31292
31293
31294
31295
31296
31297
31298
31299
 
# File 'lib/oci/database/database_client.rb', line 31262

def update_pluggable_database(pluggable_database_id, update_pluggable_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_pluggable_database.' if logger

  raise "Missing the required parameter 'pluggable_database_id' when calling update_pluggable_database." if pluggable_database_id.nil?
  raise "Missing the required parameter 'update_pluggable_database_details' when calling update_pluggable_database." if update_pluggable_database_details.nil?
  raise "Parameter value for 'pluggable_database_id' must not be blank" if OCI::Internal::Util.blank_string?(pluggable_database_id)

  path = '/pluggableDatabases/{pluggableDatabaseId}'.sub('{pluggableDatabaseId}', pluggable_database_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_pluggable_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_pluggable_database') 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::Database::Models::PluggableDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_scheduled_action(scheduled_action_id, update_scheduled_action_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_scheduled_action API.

Updates the Scheduled Action 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) —

    Unique identifier for the request.

Returns:



31324
31325
31326
31327
31328
31329
31330
31331
31332
31333
31334
31335
31336
31337
31338
31339
31340
31341
31342
31343
31344
31345
31346
31347
31348
31349
31350
31351
31352
31353
31354
31355
31356
31357
31358
31359
31360
31361
31362
 
# File 'lib/oci/database/database_client.rb', line 31324

def update_scheduled_action(scheduled_action_id, update_scheduled_action_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_scheduled_action.' if logger

  raise "Missing the required parameter 'scheduled_action_id' when calling update_scheduled_action." if scheduled_action_id.nil?
  raise "Missing the required parameter 'update_scheduled_action_details' when calling update_scheduled_action." if update_scheduled_action_details.nil?
  raise "Parameter value for 'scheduled_action_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_action_id)

  path = '/scheduledActions/{scheduledActionId}'.sub('{scheduledActionId}', scheduled_action_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_scheduled_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_scheduled_action') 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::Database::Models::ScheduledAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_scheduling_policy(scheduling_policy_id, update_scheduling_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_scheduling_policy API.

Updates the Scheduling Policy 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) —

    Unique identifier for the request.

Returns:



31387
31388
31389
31390
31391
31392
31393
31394
31395
31396
31397
31398
31399
31400
31401
31402
31403
31404
31405
31406
31407
31408
31409
31410
31411
31412
31413
31414
31415
31416
31417
31418
31419
31420
31421
31422
31423
31424
31425
 
# File 'lib/oci/database/database_client.rb', line 31387

def update_scheduling_policy(scheduling_policy_id, update_scheduling_policy_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_scheduling_policy.' if logger

  raise "Missing the required parameter 'scheduling_policy_id' when calling update_scheduling_policy." if scheduling_policy_id.nil?
  raise "Missing the required parameter 'update_scheduling_policy_details' when calling update_scheduling_policy." if update_scheduling_policy_details.nil?
  raise "Parameter value for 'scheduling_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduling_policy_id)

  path = '/schedulingPolicies/{schedulingPolicyId}'.sub('{schedulingPolicyId}', scheduling_policy_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_scheduling_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_scheduling_policy') 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::Database::Models::SchedulingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_scheduling_window(scheduling_policy_id, scheduling_window_id, update_scheduling_window_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_scheduling_window API.

Updates the Scheduling Window resource.

Parameters:

  • scheduling_policy_id (String) —

    The Scheduling Policy OCID.

  • scheduling_window_id (String) —

    The Scheduling Window OCID.

  • update_scheduling_window_details (OCI::Database::Models::UpdateSchedulingWindowDetails) —

    Request to update the properties of a Scheduling Window.

  • 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) —

    Unique identifier for the request.

Returns:



31451
31452
31453
31454
31455
31456
31457
31458
31459
31460
31461
31462
31463
31464
31465
31466
31467
31468
31469
31470
31471
31472
31473
31474
31475
31476
31477
31478
31479
31480
31481
31482
31483
31484
31485
31486
31487
31488
31489
31490
31491
 
# File 'lib/oci/database/database_client.rb', line 31451

def update_scheduling_window(scheduling_policy_id, scheduling_window_id, update_scheduling_window_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_scheduling_window.' if logger

  raise "Missing the required parameter 'scheduling_policy_id' when calling update_scheduling_window." if scheduling_policy_id.nil?
  raise "Missing the required parameter 'scheduling_window_id' when calling update_scheduling_window." if scheduling_window_id.nil?
  raise "Missing the required parameter 'update_scheduling_window_details' when calling update_scheduling_window." if update_scheduling_window_details.nil?
  raise "Parameter value for 'scheduling_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduling_policy_id)
  raise "Parameter value for 'scheduling_window_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduling_window_id)

  path = '/schedulingPolicies/{schedulingPolicyId}/schedulingWindows/{schedulingWindowId}'.sub('{schedulingPolicyId}', scheduling_policy_id.to_s).sub('{schedulingWindowId}', scheduling_window_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_scheduling_window_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_scheduling_window') 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::Database::Models::SchedulingWindow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vm_cluster(vm_cluster_id, update_vm_cluster_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vm_cluster API.

Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

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) —

    Unique identifier for the request.

Returns:



31516
31517
31518
31519
31520
31521
31522
31523
31524
31525
31526
31527
31528
31529
31530
31531
31532
31533
31534
31535
31536
31537
31538
31539
31540
31541
31542
31543
31544
31545
31546
31547
31548
31549
31550
31551
31552
31553
31554
 
# File 'lib/oci/database/database_client.rb', line 31516

def update_vm_cluster(vm_cluster_id, update_vm_cluster_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_vm_cluster.' if logger

  raise "Missing the required parameter 'vm_cluster_id' when calling update_vm_cluster." if vm_cluster_id.nil?
  raise "Missing the required parameter 'update_vm_cluster_details' when calling update_vm_cluster." if update_vm_cluster_details.nil?
  raise "Parameter value for 'vm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(vm_cluster_id)

  path = '/vmClusters/{vmClusterId}'.sub('{vmClusterId}', vm_cluster_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_vm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_vm_cluster') 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::Database::Models::VmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, update_vm_cluster_network_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vm_cluster_network API.

Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To update a cloud VM cluster in an Exadata Cloud Service instance, use the update_cloud_vm_cluster operation.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network OCID.

  • update_vm_cluster_network_details (OCI::Database::Models::UpdateVmClusterNetworkDetails) —

    Request to update the properties of a VM cluster network.

  • 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) —

    Unique identifier for the request.

Returns:



31581
31582
31583
31584
31585
31586
31587
31588
31589
31590
31591
31592
31593
31594
31595
31596
31597
31598
31599
31600
31601
31602
31603
31604
31605
31606
31607
31608
31609
31610
31611
31612
31613
31614
31615
31616
31617
31618
31619
31620
31621
 
# File 'lib/oci/database/database_client.rb', line 31581

def update_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, update_vm_cluster_network_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#update_vm_cluster_network.' if logger

  raise "Missing the required parameter 'exadata_infrastructure_id' when calling update_vm_cluster_network." if exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'vm_cluster_network_id' when calling update_vm_cluster_network." if vm_cluster_network_id.nil?
  raise "Missing the required parameter 'update_vm_cluster_network_details' when calling update_vm_cluster_network." if update_vm_cluster_network_details.nil?
  raise "Parameter value for 'exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(exadata_infrastructure_id)
  raise "Parameter value for 'vm_cluster_network_id' must not be blank" if OCI::Internal::Util.blank_string?(vm_cluster_network_id)

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_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_vm_cluster_network_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#update_vm_cluster_network') 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::Database::Models::VmClusterNetwork'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upgrade_database(database_id, upgrade_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upgrade_database API.

Upgrades the specified Oracle Database instance.

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) —

    Unique identifier for the request.

Returns:



31646
31647
31648
31649
31650
31651
31652
31653
31654
31655
31656
31657
31658
31659
31660
31661
31662
31663
31664
31665
31666
31667
31668
31669
31670
31671
31672
31673
31674
31675
31676
31677
31678
31679
31680
31681
31682
31683
31684
 
# File 'lib/oci/database/database_client.rb', line 31646

def upgrade_database(database_id, upgrade_database_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#upgrade_database.' if logger

  raise "Missing the required parameter 'database_id' when calling upgrade_database." if database_id.nil?
  raise "Missing the required parameter 'upgrade_database_details' when calling upgrade_database." if upgrade_database_details.nil?
  raise "Parameter value for 'database_id' must not be blank" if OCI::Internal::Util.blank_string?(database_id)

  path = '/databases/{databaseId}/actions/upgrade'.sub('{databaseId}', database_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(upgrade_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#upgrade_database') 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::Database::Models::Database'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upgrade_db_system(db_system_id, upgrade_db_system_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upgrade_db_system API.

Upgrades the operating system and grid infrastructure of the DB system.

Parameters:

  • db_system_id (String) —

    The DB system OCID.

  • upgrade_db_system_details (OCI::Database::Models::UpgradeDbSystemDetails) —

    Request to perform an upgrade of the operating system and the Oracle Grid Infrastructure (GI) of the DB system.

  • 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



31715
31716
31717
31718
31719
31720
31721
31722
31723
31724
31725
31726
31727
31728
31729
31730
31731
31732
31733
31734
31735
31736
31737
31738
31739
31740
31741
31742
31743
31744
31745
31746
31747
31748
31749
31750
31751
31752
31753
31754
31755
 
# File 'lib/oci/database/database_client.rb', line 31715

def upgrade_db_system(db_system_id, upgrade_db_system_details, opts = {})
  logger.debug 'Calling operation DatabaseClient#upgrade_db_system.' if logger

  raise "Missing the required parameter 'db_system_id' when calling upgrade_db_system." if db_system_id.nil?
  raise "Missing the required parameter 'upgrade_db_system_details' when calling upgrade_db_system." if upgrade_db_system_details.nil?
  raise "Parameter value for 'db_system_id' must not be blank" if OCI::Internal::Util.blank_string?(db_system_id)

  path = '/dbSystems/{dbSystemId}/actions/upgrade'.sub('{dbSystemId}', db_system_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]
  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(upgrade_db_system_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#upgrade_db_system') 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::Database::Models::DbSystem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_vm_cluster_network API.

Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Parameters:

  • exadata_infrastructure_id (String) —

    The Exadata infrastructure OCID.

  • vm_cluster_network_id (String) —

    The VM cluster network 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) —

    Unique identifier for the request.

  • :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 may be rejected).

Returns:



31782
31783
31784
31785
31786
31787
31788
31789
31790
31791
31792
31793
31794
31795
31796
31797
31798
31799
31800
31801
31802
31803
31804
31805
31806
31807
31808
31809
31810
31811
31812
31813
31814
31815
31816
31817
31818
31819
31820
31821
31822
 
# File 'lib/oci/database/database_client.rb', line 31782

def validate_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, opts = {})
  logger.debug 'Calling operation DatabaseClient#validate_vm_cluster_network.' if logger

  raise "Missing the required parameter 'exadata_infrastructure_id' when calling validate_vm_cluster_network." if exadata_infrastructure_id.nil?
  raise "Missing the required parameter 'vm_cluster_network_id' when calling validate_vm_cluster_network." if vm_cluster_network_id.nil?
  raise "Parameter value for 'exadata_infrastructure_id' must not be blank" if OCI::Internal::Util.blank_string?(exadata_infrastructure_id)
  raise "Parameter value for 'vm_cluster_network_id' must not be blank" if OCI::Internal::Util.blank_string?(vm_cluster_network_id)

  path = '/exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/validate'.sub('{exadataInfrastructureId}', exadata_infrastructure_id.to_s).sub('{vmClusterNetworkId}', vm_cluster_network_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatabaseClient#validate_vm_cluster_network') 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::Database::Models::VmClusterNetwork'
    )
  end
  # rubocop:enable Metrics/BlockLength
end