Class: OCI::DistributedDatabase::DistributedAutonomousDbServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/distributed_autonomous_db_service_client.rb

Overview

Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases.

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

Creates a new DistributedAutonomousDbServiceClient. 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/distributed_database/distributed_autonomous_db_service_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 + '/20250101'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DistributedAutonomousDbServiceClient 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/distributed_database/distributed_autonomous_db_service_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/distributed_database/distributed_autonomous_db_service_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/distributed_database/distributed_autonomous_db_service_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/distributed_database/distributed_autonomous_db_service_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#add_distributed_autonomous_database_gds_control_node(distributed_autonomous_database_id, add_distributed_autonomous_database_gds_control_node_details, opts = {}) ⇒ Response

Note:

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

Add new Global database services control(GDS CTL) node for the Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

  • add_distributed_autonomous_database_gds_control_node_details (OCI::DistributedDatabase::Models::AddDistributedAutonomousDatabaseGdsControlNodeDetails) —

    Details required to provision the new Global database services control(GDS CTL) node for the Distributed autonomous 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_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
160
161
162
163
164
165
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 126

def add_distributed_autonomous_database_gds_control_node(distributed_autonomous_database_id, add_distributed_autonomous_database_gds_control_node_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#add_distributed_autonomous_database_gds_control_node.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/addGdsControlNode'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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(add_distributed_autonomous_database_gds_control_node_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#add_distributed_autonomous_database_gds_control_node') do
    @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_distributed_autonomous_database_compartment(change_distributed_autonomous_database_compartment_details, distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Move the Globally distributed autonomous database 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_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
232
233
234
235
236
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 197

def change_distributed_autonomous_database_compartment(change_distributed_autonomous_database_compartment_details, distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#change_distributed_autonomous_database_compartment.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeCompartment'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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(change_distributed_autonomous_database_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#change_distributed_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_distributed_autonomous_db_backup_config(distributed_autonomous_database_id, change_distributed_autonomous_db_backup_config_details, opts = {}) ⇒ Response

Note:

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

Change the DbBackupConfig for the Globally distributed autonomous 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) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
304
305
306
307
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 268

def change_distributed_autonomous_db_backup_config(distributed_autonomous_database_id, change_distributed_autonomous_db_backup_config_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#change_distributed_autonomous_db_backup_config.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeDbBackupConfig'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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(change_distributed_autonomous_db_backup_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#change_distributed_autonomous_db_backup_config') do
    @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_distributed_autonomous_database_gsm_wallet(configure_distributed_autonomous_database_gsm_wallet_details, distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Configure wallets on Global Service Manager(GSM) instances for a Globally distributed autonomous 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 might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
373
374
375
376
377
378
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 339

def configure_distributed_autonomous_database_gsm_wallet(configure_distributed_autonomous_database_gsm_wallet_details, distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_gsm_wallet.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsmWallet'.sub('{distributedAutonomousDatabaseId}', distributed_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(configure_distributed_autonomous_database_gsm_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_gsm_wallet') do
    @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_distributed_autonomous_database_gsms(configure_distributed_autonomous_database_gsms_details, distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed autonomous 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 might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
442
443
444
445
446
447
448
449
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 410

def configure_distributed_autonomous_database_gsms(configure_distributed_autonomous_database_gsms_details, distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_gsms.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsms'.sub('{distributedAutonomousDatabaseId}', distributed_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(configure_distributed_autonomous_database_gsms_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_gsms') do
    @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_distributed_autonomous_database_sharding(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Once all components of Globally distributed autonomous database are provisioned, this api shall be invoked to configure sharding on the Globally distributed autonomous database. Note that this 'ConfigureSharding' API also needs to be invoked after successfully adding a new shard to the Globally distributed autonomous database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :is_rebalance_required (BOOLEAN) —

    The flag to indicate whether chunks need to be re-balanced. This flag is not applicable for USER-defined sharding type. (default to true)

  • :certificate_id (String) —

    The ID of the cluster certificate.

  • :ca_bundle_id (String) —

    The ID of the Ca Bundle.

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST 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



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 489

def configure_distributed_autonomous_database_sharding(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_sharding.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureSharding'.sub('{distributedAutonomousDatabaseId}', distributed_autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isRebalanceRequired] = opts[:is_rebalance_required] if !opts[:is_rebalance_required].nil?
  query_params[:certificateId] = opts[:certificate_id] if opts[:certificate_id]
  query_params[:caBundleId] = opts[:ca_bundle_id] if opts[:ca_bundle_id]

  # 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: 'DistributedAutonomousDbServiceClient#configure_distributed_autonomous_database_sharding') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_distributed_autonomous_database(create_distributed_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Creates a Globally distributed autonomous 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 might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
584
585
586
587
588
589
590
591
592
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 555

def create_distributed_autonomous_database(create_distributed_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#create_distributed_autonomous_database.' if logger

  raise "Missing the required parameter 'create_distributed_autonomous_database_details' when calling create_distributed_autonomous_database." if create_distributed_autonomous_database_details.nil?

  path = '/distributedAutonomousDatabases'
  operation_signing_strategy = :standard

  # rubocop: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_distributed_autonomous_database_details)

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

#delete_distributed_autonomous_database(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Terminate the given Globally distributed autonomous databases.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST 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



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
659
660
661
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 623

def delete_distributed_autonomous_database(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#delete_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}'.sub('{distributedAutonomousDatabaseId}', distributed_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-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: 'DistributedAutonomousDbServiceClient#delete_distributed_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

#download_distributed_autonomous_database_gsm_certificate_signing_request(distributed_autonomous_database_id, opts = {}, &block) ⇒ Response

Note:

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

Generate the common certificate signing request for GSMs. Download the <globalautonomousdb-prefix>.csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use 'uploadSignedCertificateAndGenerateWallet' API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

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



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
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 697

def download_distributed_autonomous_database_gsm_certificate_signing_request(distributed_autonomous_database_id, opts = {}, &block)
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#download_distributed_autonomous_database_gsm_certificate_signing_request.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/downloadGsmCertificateSigningRequest'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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: 'DistributedAutonomousDbServiceClient#download_distributed_autonomous_database_gsm_certificate_signing_request') 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_distributed_autonomous_database_gsm_certificate_signing_request(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Generate the certificate signing request for GSM instances of the Globally distributed autonomous database. Once certificate signing request is generated, then customers can download the certificate signing request using 'downloadGsmCertificateSigningRequest' api call.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :ca_bundle_id (String) —

    The ID of the Ca Bundle.

Returns:

  • (Response) —

    A Response object with data of type nil



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 814

def generate_distributed_autonomous_database_gsm_certificate_signing_request(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#generate_distributed_autonomous_database_gsm_certificate_signing_request.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateGsmCertificateSigningRequest'.sub('{distributedAutonomousDatabaseId}', distributed_autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:caBundleId] = opts[:ca_bundle_id] if opts[:ca_bundle_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[:'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: 'DistributedAutonomousDbServiceClient#generate_distributed_autonomous_database_gsm_certificate_signing_request') do
    @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

#generate_distributed_autonomous_database_wallet(distributed_autonomous_database_id, generate_distributed_autonomous_database_wallet_details, opts = {}, &block) ⇒ Response

Note:

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

Generate the wallet associated with Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

  • generate_distributed_autonomous_database_wallet_details (OCI::DistributedDatabase::Models::GenerateDistributedAutonomousDatabaseWalletDetails) —

    Details for generating Globally distributed autonomous 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) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

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



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 887

def generate_distributed_autonomous_database_wallet(distributed_autonomous_database_id, generate_distributed_autonomous_database_wallet_details, opts = {}, &block)
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#generate_distributed_autonomous_database_wallet.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateWallet'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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(generate_distributed_autonomous_database_wallet_details)

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

#get_distributed_autonomous_database(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the Globally distributed autonomous database identified by given id.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :metadata (String) —

    Comma separated names of argument corresponding to which metadata need to be retrived.

  • :if_none_match (String) —

    For conditional requests. In the GET call for a resource, set the If-None-Match header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 998

def get_distributed_autonomous_database(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#get_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}'.sub('{distributedAutonomousDatabaseId}', distributed_autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:metadata] = opts[:metadata] if opts[:metadata]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'DistributedAutonomousDbServiceClient#get_distributed_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::DistributedDatabase::Models::DistributedAutonomousDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_distributed_autonomous_database_raft_metric(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Operation to retrieve RAFT metrics for the Globally distributed autonomous database. If the Globally distributed autonomous database is not RAFT based then empty response is returned from the API.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1056

def get_distributed_autonomous_database_raft_metric(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#get_distributed_autonomous_database_raft_metric.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/raftMetrics'.sub('{distributedAutonomousDatabaseId}', distributed_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: 'DistributedAutonomousDbServiceClient#get_distributed_autonomous_database_raft_metric') 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::DistributedDatabase::Models::DistributedAutonomousDatabaseRaftMetric'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_distributed_autonomous_databases(compartment_id, opts = {}) ⇒ Response

Note:

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

List of Globally distributed autonomous databases.

Allowed values are: timeCreated, timeUpdated

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :private_endpoint_id (String) —

    A filter to return only resources that are associated with the given privateEndpointId.

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

    A filter to return only Globally distributed autonomous databases that match the entire name given. The match is not case sensitive.

  • :db_deployment_type (String) —

    A filter to return only resources their dbDeploymentType matches the given dbDeploymentType.

  • :metadata (String) —

    Comma separated names of argument corresponding to which metadata need to be retrived.

Returns:



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
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1123

def list_distributed_autonomous_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#list_distributed_autonomous_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_distributed_autonomous_databases." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DistributedDatabase::Models::DistributedAutonomousDatabase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DistributedDatabase::Models::DistributedAutonomousDatabase::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::DistributedDatabase::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::DistributedDatabase::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated.'
  end

  if opts[:db_deployment_type] && !OCI::DistributedDatabase::Models::DistributedAutonomousDatabase::DB_DEPLOYMENT_TYPE_ENUM.include?(opts[:db_deployment_type])
    raise 'Invalid value for "db_deployment_type", must be one of the values in OCI::DistributedDatabase::Models::DistributedAutonomousDatabase::DB_DEPLOYMENT_TYPE_ENUM.'
  end

  path = '/distributedAutonomousDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:privateEndpointId] = opts[:private_endpoint_id] if opts[:private_endpoint_id]
  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]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:dbDeploymentType] = opts[:db_deployment_type] if opts[:db_deployment_type]
  query_params[:metadata] = opts[:metadata] if opts[:metadata]

  # 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: 'DistributedAutonomousDbServiceClient#list_distributed_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: 'OCI::DistributedDatabase::Models::DistributedAutonomousDatabaseCollection'
    )
  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/distributed_database/distributed_autonomous_db_service_client.rb', line 94

def logger
  @api_client.config.logger
end

#move_distributed_autonomous_database_replication_unit(distributed_autonomous_database_id, move_distributed_autonomous_database_replication_unit_details, opts = {}) ⇒ Response

Note:

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

Move the replication units for RAFT based globally distributed autonomous database from source shard to destination shard.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1217

def move_distributed_autonomous_database_replication_unit(distributed_autonomous_database_id, move_distributed_autonomous_database_replication_unit_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#move_distributed_autonomous_database_replication_unit.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/moveReplicationUnit'.sub('{distributedAutonomousDatabaseId}', distributed_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(move_distributed_autonomous_database_replication_unit_details)

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

#patch_distributed_autonomous_database(distributed_autonomous_database_id, patch_distributed_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Patch operation to add, remove or update shards to the Globally distributed autonomous database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

  • patch_distributed_autonomous_database_details (OCI::DistributedDatabase::Models::PatchDistributedAutonomousDatabaseDetails) —

    The payload containing instructions to patch the Globally distributed autonomous 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 might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1290

def patch_distributed_autonomous_database(distributed_autonomous_database_id, patch_distributed_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#patch_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}'.sub('{distributedAutonomousDatabaseId}', distributed_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(patch_distributed_autonomous_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedAutonomousDbServiceClient#patch_distributed_autonomous_database') do
    @api_client.call_api(
      :PATCH,
      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

#recreate_failed_distributed_autonomous_database_resource(distributed_autonomous_database_id, resource_name, opts = {}) ⇒ Response

Note:

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

Recreate the failed resource for the Globally Distributed Autonomous Database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

  • resource_name (String) —

    Specify the name of Shard, Catalog or GSM.

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

    the optional parameters

Options Hash (opts):

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

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

  • :shard_group (String) —

    The shardGroup name example Shardgroupa, Shardgroupb.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1364

def recreate_failed_distributed_autonomous_database_resource(distributed_autonomous_database_id, resource_name, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#recreate_failed_distributed_autonomous_database_resource.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/recreateFailedResource'.sub('{distributedAutonomousDatabaseId}', distributed_autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceName] = resource_name
  query_params[:shardGroup] = opts[:shard_group] if opts[:shard_group]

  # 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: 'DistributedAutonomousDbServiceClient#recreate_failed_distributed_autonomous_database_resource') do
    @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_distributed_autonomous_database_passwords(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed autonomous database. This operation will also remove GdsCtlNodes if present.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1435

def rotate_distributed_autonomous_database_passwords(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#rotate_distributed_autonomous_database_passwords.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/rotateDbPasswords'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'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: 'DistributedAutonomousDbServiceClient#rotate_distributed_autonomous_database_passwords') do
    @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

#start_distributed_autonomous_database(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Start the shards, catalog and GSMs of Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST 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



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1503

def start_distributed_autonomous_database(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#start_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/startDatabase'.sub('{distributedAutonomousDatabaseId}', distributed_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]
  # 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: 'DistributedAutonomousDbServiceClient#start_distributed_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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_distributed_autonomous_database(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Stop the shards, catalog and GSM instances for the Globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST 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



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1571

def stop_distributed_autonomous_database(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#stop_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/stopDatabase'.sub('{distributedAutonomousDatabaseId}', distributed_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]
  # 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: 'DistributedAutonomousDbServiceClient#stop_distributed_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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_distributed_autonomous_database(distributed_autonomous_database_id, update_distributed_autonomous_database_details, opts = {}) ⇒ Response

Note:

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

Updates the configuration of the Globally distributed autonomous 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) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1635

def update_distributed_autonomous_database(distributed_autonomous_database_id, update_distributed_autonomous_database_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#update_distributed_autonomous_database.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}'.sub('{distributedAutonomousDatabaseId}', distributed_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_distributed_autonomous_database_details)

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

#upload_distributed_autonomous_database_signed_certificate_and_generate_wallet(distributed_autonomous_database_id, upload_distributed_autonomous_database_signed_certificate_and_generate_wallet_details, opts = {}) ⇒ Response

Note:

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

Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed autonomous database. Customer shall provide the CA signed certificate key details by adding the certificate in request body.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1709

def upload_distributed_autonomous_database_signed_certificate_and_generate_wallet(distributed_autonomous_database_id, upload_distributed_autonomous_database_signed_certificate_and_generate_wallet_details, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#upload_distributed_autonomous_database_signed_certificate_and_generate_wallet.' if logger

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

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

  post_body = @api_client.object_to_http_body(upload_distributed_autonomous_database_signed_certificate_and_generate_wallet_details)

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

#validate_distributed_autonomous_database_ca_bundle(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Validate the CA Bundles consistency of the globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1779

def validate_distributed_autonomous_database_ca_bundle(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#validate_distributed_autonomous_database_ca_bundle.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateCaBundle'.sub('{distributedAutonomousDatabaseId}', distributed_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 = nil

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

#validate_distributed_autonomous_database_network(distributed_autonomous_database_id, opts = {}) ⇒ Response

Note:

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

Validate the network connectivity between components of the globally distributed autonomous database.

Parameters:

  • distributed_autonomous_database_id (String) —

    Globally distributed autonomous database identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :is_surrogate (BOOLEAN) —

    Determines the surrogates check. Default is true. (default to true)

  • :resource_name (String) —

    Specify the name of shard or catalog.

  • :shard_group (String) —

    The shardGroup name example Shardgroupa, Shardgroupb.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/oci/distributed_database/distributed_autonomous_db_service_client.rb', line 1853

def validate_distributed_autonomous_database_network(distributed_autonomous_database_id, opts = {})
  logger.debug 'Calling operation DistributedAutonomousDbServiceClient#validate_distributed_autonomous_database_network.' if logger

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

  path = '/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateNetwork'.sub('{distributedAutonomousDatabaseId}', distributed_autonomous_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isSurrogate] = opts[:is_surrogate] if !opts[:is_surrogate].nil?
  query_params[:resourceName] = opts[:resource_name] if opts[:resource_name]
  query_params[:shardGroup] = opts[:shard_group] if opts[:shard_group]

  # 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: 'DistributedAutonomousDbServiceClient#validate_distributed_autonomous_database_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
    )
  end
  # rubocop:enable Metrics/BlockLength
end