Class: OCI::DistributedDatabase::DistributedDbPrivateEndpointServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/distributed_db_private_endpoint_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) ⇒ DistributedDbPrivateEndpointServiceClient

Creates a new DistributedDbPrivateEndpointServiceClient. 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_db_private_endpoint_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 "DistributedDbPrivateEndpointServiceClient 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_db_private_endpoint_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_db_private_endpoint_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_db_private_endpoint_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_db_private_endpoint_service_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_distributed_database_private_endpoint_compartment(change_distributed_database_private_endpoint_compartment_details, distributed_database_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Moves the DistributedDatabasePrivateEndpoint 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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/distributed_database/distributed_db_private_endpoint_service_client.rb', line 125

def change_distributed_database_private_endpoint_compartment(change_distributed_database_private_endpoint_compartment_details, distributed_database_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#change_distributed_database_private_endpoint_compartment.' if logger

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

  path = '/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/changeCompartment'.sub('{distributedDatabasePrivateEndpointId}', distributed_database_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  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_database_private_endpoint_compartment_details)

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

#create_distributed_database_private_endpoint(create_distributed_database_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Creates a DistributedDatabasePrivateEndpoint.

Parameters:

Options Hash (opts):

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

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/distributed_database/distributed_db_private_endpoint_service_client.rb', line 189

def create_distributed_database_private_endpoint(create_distributed_database_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#create_distributed_database_private_endpoint.' if logger

  raise "Missing the required parameter 'create_distributed_database_private_endpoint_details' when calling create_distributed_database_private_endpoint." if create_distributed_database_private_endpoint_details.nil?

  path = '/distributedDatabasePrivateEndpoints'
  operation_signing_strategy = :standard

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

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

#delete_distributed_database_private_endpoint(distributed_database_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Deletes the given DistributedDatabasePrivateEndpoint.

Parameters:

  • distributed_database_private_endpoint_id (String) —

    Distributed Database PrivateEndpoint 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



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

def delete_distributed_database_private_endpoint(distributed_database_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#delete_distributed_database_private_endpoint.' if logger

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

  path = '/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}'.sub('{distributedDatabasePrivateEndpointId}', distributed_database_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'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: 'DistributedDbPrivateEndpointServiceClient#delete_distributed_database_private_endpoint') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_distributed_database_private_endpoint(distributed_database_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Get the DistributedDatabasePrivateEndpoint resource.

Parameters:

  • distributed_database_private_endpoint_id (String) —

    Distributed Database PrivateEndpoint 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_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:



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

def get_distributed_database_private_endpoint(distributed_database_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#get_distributed_database_private_endpoint.' if logger

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

  path = '/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}'.sub('{distributedDatabasePrivateEndpointId}', distributed_database_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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: 'DistributedDbPrivateEndpointServiceClient#get_distributed_database_private_endpoint') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List of DistributedDatabasePrivateEndpoints.

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

  • :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 private endpoint that match the entire name given. The match is not case sensitive.

Returns:



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/distributed_database/distributed_db_private_endpoint_service_client.rb', line 384

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

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

  if opts[:lifecycle_state] && !OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpoint::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpoint::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

  path = '/distributedDatabasePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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]

  # Header Params
  header_params = {}
  header_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: 'DistributedDbPrivateEndpointServiceClient#list_distributed_database_private_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpointCollection'
    )
  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_db_private_endpoint_service_client.rb', line 94

def logger
  @api_client.config.logger
end

#reinstate_proxy_instance(distributed_database_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Reinstates the proxy instance associated with the DistributedDatabasePrivateEndpoint.

Parameters:

  • distributed_database_private_endpoint_id (String) —

    Distributed Database PrivateEndpoint 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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/oci/distributed_database/distributed_db_private_endpoint_service_client.rb', line 469

def reinstate_proxy_instance(distributed_database_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#reinstate_proxy_instance.' if logger

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

  path = '/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/reinstateProxyInstance'.sub('{distributedDatabasePrivateEndpointId}', distributed_database_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  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: 'DistributedDbPrivateEndpointServiceClient#reinstate_proxy_instance') do
    @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_database_private_endpoint(distributed_database_private_endpoint_id, update_distributed_database_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Updates the configuration of DistributedDatabasePrivateEndpoint.

Parameters:

Options Hash (opts):

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

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



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

def update_distributed_database_private_endpoint(distributed_database_private_endpoint_id, update_distributed_database_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DistributedDbPrivateEndpointServiceClient#update_distributed_database_private_endpoint.' if logger

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

  path = '/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}'.sub('{distributedDatabasePrivateEndpointId}', distributed_database_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_distributed_database_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DistributedDbPrivateEndpointServiceClient#update_distributed_database_private_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DistributedDatabase::Models::DistributedDatabasePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end