Class: OCI::GoldenGate::GoldenGateClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/golden_gate_client.rb

Overview

Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.

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

Creates a new GoldenGateClient. 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/golden_gate/golden_gate_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 + '/20200407'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GoldenGateClient 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/golden_gate/golden_gate_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/golden_gate/golden_gate_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/golden_gate/golden_gate_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/golden_gate/golden_gate_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#add_connection_lock(connection_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a Connection resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



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

def add_connection_lock(connection_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#add_connection_lock.' if logger

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

  path = '/connections/{connectionId}/actions/addLock'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

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

#add_deployment_backup_lock(deployment_backup_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a DeploymentBackup resource.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup identifier.

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

    AddResourceLockDetails body parameter

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



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

def add_deployment_backup_lock(deployment_backup_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#add_deployment_backup_lock.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/addLock'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

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

#add_deployment_local_peer(deployment_id, add_deployment_local_peer_details, opts = {}) ⇒ Response

Note:

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

Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def add_deployment_local_peer(deployment_id, add_deployment_local_peer_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#add_deployment_local_peer.' if logger

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

  path = '/deployments/{deploymentId}/actions/addLocalPeer'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(add_deployment_local_peer_details)

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

#add_deployment_lock(deployment_id, add_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Adds a lock to a Deployment resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

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

    AddResourceLockDetails body parameter

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



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

def add_deployment_lock(deployment_id, add_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#add_deployment_lock.' if logger

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

  path = '/deployments/{deploymentId}/actions/addLock'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

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

#cancel_deployment_backup(deployment_backup_id, cancel_deployment_backup_details, opts = {}) ⇒ Response

Note:

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

Cancels a Deployment Backup creation process.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup identifier.

  • cancel_deployment_backup_details (OCI::GoldenGate::Models::CancelDeploymentBackupDetails) —

    A placeholder for any additional metadata to describe the deployment backup cancel.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 390

def cancel_deployment_backup(deployment_backup_id, cancel_deployment_backup_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#cancel_deployment_backup.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/cancel'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(cancel_deployment_backup_details)

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

#cancel_deployment_upgrade(deployment_upgrade_id, cancel_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade identifier.

  • cancel_deployment_upgrade_details (OCI::GoldenGate::Models::CancelDeploymentUpgradeDetails) —

    A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 463

def cancel_deployment_upgrade(deployment_upgrade_id, cancel_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#cancel_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/cancel'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(cancel_deployment_upgrade_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#cancel_deployment_upgrade') do
    @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::GoldenGate::Models::DeploymentUpgrade'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cancel_snooze_deployment_upgrade(deployment_upgrade_id, cancel_snooze_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade identifier.

  • cancel_snooze_deployment_upgrade_details (OCI::GoldenGate::Models::CancelSnoozeDeploymentUpgradeDetails) —

    A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def cancel_snooze_deployment_upgrade(deployment_upgrade_id, cancel_snooze_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#cancel_snooze_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/cancelSnooze'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(cancel_snooze_deployment_upgrade_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#cancel_snooze_deployment_upgrade') do
    @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_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 607

def change_connection_compartment(connection_id, change_connection_compartment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_connection_compartment.' if logger

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

  path = '/connections/{connectionId}/actions/changeCompartment'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_connection_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#change_connection_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_connection_subscription(change_connection_subscription_details, connection_id, opts = {}) ⇒ Response

Note:

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

Associate a GoldanGate connection with a different subscription.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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



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

def change_connection_subscription(change_connection_subscription_details, connection_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_connection_subscription.' if logger

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

  path = '/connections/{connectionId}/actions/changeSubscription'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_connection_subscription_details)

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

#change_database_registration_compartment(database_registration_id, change_database_registration_compartment_details, opts = {}) ⇒ Response

Note:

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

Note: Deprecated. Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 754

def change_database_registration_compartment(database_registration_id, change_database_registration_compartment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_database_registration_compartment.' if logger

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

  path = '/databaseRegistrations/{databaseRegistrationId}/actions/changeCompartment'.sub('{databaseRegistrationId}', database_registration_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_database_registration_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#change_database_registration_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_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 830

def change_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_deployment_backup_compartment.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/changeCompartment'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_deployment_backup_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#change_deployment_backup_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_deployment_compartment(deployment_id, change_deployment_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 907

def change_deployment_compartment(deployment_id, change_deployment_compartment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_deployment_compartment.' if logger

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

  path = '/deployments/{deploymentId}/actions/changeCompartment'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_deployment_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#change_deployment_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_deployment_subscription(change_deployment_subscription_details, deployment_id, opts = {}) ⇒ Response

Note:

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

Associate a GoldanGate deployment with a different subscription.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 980

def change_deployment_subscription(change_deployment_subscription_details, deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_deployment_subscription.' if logger

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

  path = '/deployments/{deploymentId}/actions/changeSubscription'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_deployment_subscription_details)

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

#change_pipeline_compartment(pipeline_id, change_pipeline_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the Pipeline into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

  • :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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
1093
1094
1095
1096
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1056

def change_pipeline_compartment(pipeline_id, change_pipeline_compartment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#change_pipeline_compartment.' if logger

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

  path = '/pipelines/{pipelineId}/actions/changeCompartment'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_pipeline_compartment_details)

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

#clone_pipeline(clone_pipeline_details, opts = {}) ⇒ Response

Note:

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

Clones the pipeline.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:



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
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1128

def clone_pipeline(clone_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#clone_pipeline.' if logger

  raise "Missing the required parameter 'clone_pipeline_details' when calling clone_pipeline." if clone_pipeline_details.nil?

  path = '/pipelines/actions/clone'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(clone_pipeline_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#clone_pipeline') do
    @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::GoldenGate::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#collect_deployment_diagnostic(deployment_id, collect_deployment_diagnostic_details, opts = {}) ⇒ Response

Note:

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

Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • collect_deployment_diagnostic_details (OCI::GoldenGate::Models::CollectDeploymentDiagnosticDetails) —

    Metadata about the deployment diagnostic. This also includes the Object storage information where the diagnostic will be uploaded

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def collect_deployment_diagnostic(deployment_id, collect_deployment_diagnostic_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#collect_deployment_diagnostic.' if logger

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

  path = '/deployments/{deploymentId}/actions/collectDiagnostics'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(collect_deployment_diagnostic_details)

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

#collect_pipeline_diagnostic(pipeline_id, collect_pipeline_diagnostic_details, opts = {}) ⇒ Response

Note:

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

Collects diagnostics for the pipeline

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

  • collect_pipeline_diagnostic_details (OCI::GoldenGate::Models::CollectPipelineDiagnosticDetails) —

    Details for collecting the diagnostic. It includes the object storage information where the diagnostic will be uploaded.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1272

def collect_pipeline_diagnostic(pipeline_id, collect_pipeline_diagnostic_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#collect_pipeline_diagnostic.' if logger

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

  path = '/pipelines/{pipelineId}/actions/collectDiagnostics'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(collect_pipeline_diagnostic_details)

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

#copy_deployment_backup(deployment_backup_id, copy_deployment_backup_details, opts = {}) ⇒ Response

Note:

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

Creates a copy of a Deployment Backup.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup identifier.

  • copy_deployment_backup_details (OCI::GoldenGate::Models::CopyDeploymentBackupDetails) —

    A placeholder for any additional metadata to describe the copy of a Deployment Backup.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is 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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1343

def copy_deployment_backup(deployment_backup_id, copy_deployment_backup_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#copy_deployment_backup.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/copyToBucket'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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(copy_deployment_backup_details)

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

#create_certificate(create_certificate_details, deployment_id, opts = {}) ⇒ Response

Note:

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

Creates a new certificate to truststore.

Parameters:

  • create_certificate_details (OCI::GoldenGate::Models::CreateCertificateDetails) —

    Specifications to create the certificate to truststore.

  • deployment_id (String) —

    A unique Deployment 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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1412

def create_certificate(create_certificate_details, deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_certificate.' if logger

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

  path = '/deployments/{deploymentId}/certificates'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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_certificate_details)

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

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

Note:

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

Creates a new Connection.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1477

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

  raise "Missing the required parameter 'create_connection_details' when calling create_connection." if create_connection_details.nil?

  path = '/connections'
  operation_signing_strategy = :standard

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

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

#create_connection_assignment(create_connection_assignment_details, opts = {}) ⇒ Response

Note:

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

Creates a new Connection Assignment.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:



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

def create_connection_assignment(create_connection_assignment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_connection_assignment.' if logger

  raise "Missing the required parameter 'create_connection_assignment_details' when calling create_connection_assignment." if create_connection_assignment_details.nil?

  path = '/connectionAssignments'
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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_connection_assignment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#create_connection_assignment') do
    @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::GoldenGate::Models::ConnectionAssignment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_registration(create_database_registration_details, opts = {}) ⇒ Response

Note:

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

Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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

def create_database_registration(create_database_registration_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_database_registration.' if logger

  raise "Missing the required parameter 'create_database_registration_details' when calling create_database_registration." if create_database_registration_details.nil?

  path = '/databaseRegistrations'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#create_database_registration') do
    @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::GoldenGate::Models::DatabaseRegistration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_deployment(create_deployment_details, opts = {}) ⇒ Response

Note:

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

Creates a new Deployment.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1667

def create_deployment(create_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_deployment.' if logger

  raise "Missing the required parameter 'create_deployment_details' when calling create_deployment." if create_deployment_details.nil?

  path = '/deployments'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#create_deployment') do
    @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::GoldenGate::Models::Deployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_deployment_backup(create_deployment_backup_details, opts = {}) ⇒ Response

Note:

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

Creates a new DeploymentBackup.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1728

def create_deployment_backup(create_deployment_backup_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_deployment_backup.' if logger

  raise "Missing the required parameter 'create_deployment_backup_details' when calling create_deployment_backup." if create_deployment_backup_details.nil?

  path = '/deploymentBackups'
  operation_signing_strategy = :standard

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

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

#create_pipeline(create_pipeline_details, opts = {}) ⇒ Response

Note:

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

Creates a new Pipeline.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1791

def create_pipeline(create_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#create_pipeline.' if logger

  raise "Missing the required parameter 'create_pipeline_details' when calling create_pipeline." if create_pipeline_details.nil?

  path = '/pipelines'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#create_pipeline') do
    @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::GoldenGate::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_certificate(deployment_id, certificate_key, opts = {}) ⇒ Response

Note:

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

Deletes the certificate from truststore.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • certificate_key (String) —

    A unique certificate 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1895
1896
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1857

def delete_certificate(deployment_id, certificate_key, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_certificate.' if logger

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

  path = '/deployments/{deploymentId}/certificates/{certificateKey}'.sub('{deploymentId}', deployment_id.to_s).sub('{certificateKey}', certificate_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_connection(connection_id, opts = {}) ⇒ Response

Note:

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

Deletes a Connection.

Parameters:

  • connection_id (String) —

    The OCID of a Connection.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1923

def delete_connection(connection_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_connection.' if logger

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

  path = '/connections/{connectionId}'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_connection_assignment(connection_assignment_id, opts = {}) ⇒ Response

Note:

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

Deletes a Connection Assignment.

Parameters:

  • connection_assignment_id (String) —

    The OCID of the Connection Assignment.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1986

def delete_connection_assignment(connection_assignment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_connection_assignment.' if logger

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

  path = '/connectionAssignments/{connectionAssignmentId}'.sub('{connectionAssignmentId}', connection_assignment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_database_registration(database_registration_id, opts = {}) ⇒ Response

Note:

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

Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.

Parameters:

  • database_registration_id (String) —

    A unique DatabaseRegistration 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2050

def delete_database_registration(database_registration_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_database_registration.' if logger

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

  path = '/databaseRegistrations/{databaseRegistrationId}'.sub('{databaseRegistrationId}', database_registration_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_deployment(deployment_id, opts = {}) ⇒ Response

Note:

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

Deletes the Deployment.

Parameters:

  • deployment_id (String) —

    A unique Deployment 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2113

def delete_deployment(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_deployment.' if logger

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

  path = '/deployments/{deploymentId}'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_deployment_backup(deployment_backup_id, opts = {}) ⇒ Response

Note:

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

Deletes a DeploymentBackup.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2177

def delete_deployment_backup(deployment_backup_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_deployment_backup.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_pipeline(pipeline_id, opts = {}) ⇒ Response

Note:

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

Deletes a Pipeline.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2241

def delete_pipeline(pipeline_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#delete_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#deployment_wallet_exists(deployment_id, deployment_wallet_exists_details, opts = {}) ⇒ Response

Note:

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

Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • deployment_wallet_exists_details (OCI::GoldenGate::Models::DeploymentWalletExistsDetails) —

    A placeholder for any additional metadata to describe the deployment start.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2311

def deployment_wallet_exists(deployment_id, deployment_wallet_exists_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#deployment_wallet_exists.' if logger

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

  path = '/deployments/{deploymentId}/actions/walletExists'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(deployment_wallet_exists_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#deployment_wallet_exists') do
    @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::GoldenGate::Models::DeploymentWalletExistsResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#export_deployment_wallet(deployment_id, export_deployment_wallet_details, opts = {}) ⇒ Response

Note:

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

Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • export_deployment_wallet_details (OCI::GoldenGate::Models::ExportDeploymentWalletDetails) —

    Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2384

def export_deployment_wallet(deployment_id, export_deployment_wallet_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#export_deployment_wallet.' if logger

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

  path = '/deployments/{deploymentId}/actions/exportWallet'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(export_deployment_wallet_details)

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

#generate_disaster_recovery_precheck_report(deployment_id, generate_disaster_recovery_precheck_report_details, opts = {}) ⇒ Response

Note:

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

Generates disaster recovery precheck report for standby peer.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 is 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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2456

def generate_disaster_recovery_precheck_report(deployment_id, generate_disaster_recovery_precheck_report_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#generate_disaster_recovery_precheck_report.' if logger

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

  path = '/deployments/{deploymentId}/actions/generateDisasterRecoveryPrecheckReport'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#generate_disaster_recovery_precheck_report') do
    @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_library_url(deployment_id, generate_library_url_details, opts = {}) ⇒ Response

Note:

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

Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • generate_library_url_details (OCI::GoldenGate::Models::GenerateLibraryUrlDetails) —

    A placeholder for any additional metadata to describe the request details.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2528

def generate_library_url(deployment_id, generate_library_url_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#generate_library_url.' if logger

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

  path = '/deployments/{deploymentId}/actions/generateLibraryUrl'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(generate_library_url_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#generate_library_url') do
    @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::GoldenGate::Models::LibraryUrl'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_certificate(deployment_id, certificate_key, opts = {}) ⇒ Response

Note:

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

Retrieves a Certificate.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • certificate_key (String) —

    A unique certificate 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:



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

def get_certificate(deployment_id, certificate_key, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_certificate.' if logger

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

  path = '/deployments/{deploymentId}/certificates/{certificateKey}'.sub('{deploymentId}', deployment_id.to_s).sub('{certificateKey}', certificate_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_connection(connection_id, opts = {}) ⇒ Response

Note:

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

Retrieves a Connection.

Allowed values are: FULL, COMPACT

Parameters:

  • connection_id (String) —

    The OCID of a Connection.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :view (String) —

    Selects the connection fields returned in connection details. (default to FULL)

Returns:



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

def get_connection(connection_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_connection.' if logger

  raise "Missing the required parameter 'connection_id' when calling get_connection." if connection_id.nil?

  if opts[:view] && !%w[FULL COMPACT].include?(opts[:view])
    raise 'Invalid value for "view", must be one of FULL, COMPACT.'
  end
  raise "Parameter value for 'connection_id' must not be blank" if OCI::Internal::Util.blank_string?(connection_id)

  path = '/connections/{connectionId}'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#get_connection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::Connection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_connection_assignment(connection_assignment_id, opts = {}) ⇒ Response

Note:

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

Retrieves a Connection Assignment.

Parameters:

  • connection_assignment_id (String) —

    The OCID of the Connection Assignment.

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

    the optional parameters

Options Hash (opts):

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

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



2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2715

def get_connection_assignment(connection_assignment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_connection_assignment.' if logger

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

  path = '/connectionAssignments/{connectionAssignmentId}'.sub('{connectionAssignmentId}', connection_assignment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#get_connection_assignment') 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::GoldenGate::Models::ConnectionAssignment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_registration(database_registration_id, opts = {}) ⇒ Response

Note:

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

Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.

Parameters:

  • database_registration_id (String) —

    A unique DatabaseRegistration 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:



2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2773

def get_database_registration(database_registration_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_database_registration.' if logger

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

  path = '/databaseRegistrations/{databaseRegistrationId}'.sub('{databaseRegistrationId}', database_registration_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#get_database_registration') 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::GoldenGate::Models::DatabaseRegistration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_deployment(deployment_id, opts = {}) ⇒ Response

Note:

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

Retrieves a deployment.

Parameters:

  • deployment_id (String) —

    A unique Deployment 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:



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2830

def get_deployment(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_deployment.' if logger

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

  path = '/deployments/{deploymentId}'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#get_deployment') 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::GoldenGate::Models::Deployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_deployment_backup(deployment_backup_id, opts = {}) ⇒ Response

Note:

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

Retrieves a DeploymentBackup.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup 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:



2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2887

def get_deployment_backup(deployment_backup_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_deployment_backup.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#get_deployment_backup') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentBackup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_deployment_upgrade(deployment_upgrade_id, opts = {}) ⇒ Response

Note:

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

Retrieves a deployment upgrade.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade 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:



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2944

def get_deployment_upgrade(deployment_upgrade_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#get_deployment_upgrade') 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::GoldenGate::Models::DeploymentUpgrade'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_disaster_recovery_precheck_report(deployment_id, availability_domain, fault_domain, opts = {}) ⇒ Response

Note:

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

Returns DR precheck report for a standby peer with the specified placement (availabilityDomain and faultDomain).

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • availability_domain (String) —

    The availability domain of the placement to evaluate DR pre-checks for.

  • fault_domain (String) —

    The fault domain of the placement to evaluate DR pre-checks for.

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

    the optional parameters

Options Hash (opts):

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

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



3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3005

def get_disaster_recovery_precheck_report(deployment_id, availability_domain, fault_domain, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_disaster_recovery_precheck_report.' if logger

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

  path = '/deployments/{deploymentId}/disasterRecoveryPrecheckReport'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:availabilityDomain] = availability_domain
  query_params[:faultDomain] = fault_domain

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#get_disaster_recovery_precheck_report') 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::GoldenGate::Models::DisasterRecoveryPrecheckReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pipeline(pipeline_id, opts = {}) ⇒ Response

Note:

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

Retrieves a Pipeline details.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

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

    the optional parameters

Options Hash (opts):

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

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



3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3066

def get_pipeline(pipeline_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#get_pipeline') 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::GoldenGate::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Retrieve the WorkRequest identified by the given OCID.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3123

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_deployment_wallet(deployment_id, import_deployment_wallet_details, opts = {}) ⇒ Response

Note:

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

Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • import_deployment_wallet_details (OCI::GoldenGate::Models::ImportDeploymentWalletDetails) —

    Metadata to import wallet to deployment. This also includes the OCI Vault information where the wallet will be imported from

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3193

def import_deployment_wallet(deployment_id, import_deployment_wallet_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#import_deployment_wallet.' if logger

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

  path = '/deployments/{deploymentId}/actions/importWallet'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(import_deployment_wallet_details)

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

#list_ai_models(compartment_id, provider_type, opts = {}) ⇒ Response

Note:

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

Returns the list of AI models for the specified provider. If the provider requires additional context to resolve its supported models, that context must be supplied in the request.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

  • provider_type (String) —

    The AI provider type for which model information is requested.

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

    the optional parameters

Options Hash (opts):

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

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

  • :region (String) —

    OCI region identifier, for example us-ashburn-1.

  • :tenancy_id (String) —

    OCI tenancy OCID to use when resolving provider models, for example for OCI Generative AI model discovery across a specific tenancy.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3266

def list_ai_models(compartment_id, provider_type, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_ai_models.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_ai_models." if compartment_id.nil?
  raise "Missing the required parameter 'provider_type' when calling list_ai_models." if provider_type.nil?
  unless OCI::GoldenGate::Models::AiProviderSummary::PROVIDER_TYPE_ENUM.include?(provider_type)
    raise 'Invalid value for "provider_type", must be one of the values in OCI::GoldenGate::Models::AiProviderSummary::PROVIDER_TYPE_ENUM.'
  end


  path = '/aiModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:providerType] = provider_type
  query_params[:region] = opts[:region] if opts[:region]
  query_params[:tenancyId] = opts[:tenancy_id] if opts[:tenancy_id]

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

  post_body = nil

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

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

Note:

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

Returns the list of AI providers along with their supported models.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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



3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3334

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

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

  path = '/aiProviders'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

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

  post_body = nil

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

#list_certificates(deployment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of certificates from truststore.

Parameters:

  • deployment_id (String) —

    A unique Deployment 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.

  • :lifecycle_state (String) —

    A filter to return only connections having the 'lifecycleState' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3404

def list_certificates(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_certificates.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_certificates." if deployment_id.nil?

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

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(deployment_id)

  path = '/deployments/{deploymentId}/certificates'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[: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]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_certificates') 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::GoldenGate::Models::CertificateCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the Connection Assignments in the compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :deployment_id (String) —

    The OCID of the deployment in which to list resources.

  • :connection_id (String) —

    The OCID of the connection.

  • :connection_type (Array<String>) —

    The array of connection types.

    Allowed values are: GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL

  • :connection_type_not_equal_to (Array<String>) —

    The array of connection types to exclude.

    Allowed values are: GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL

  • :name (String) —

    The name of the connection in the assignment (aliasName).

  • :lifecycle_state (String) —

    A filter to return only connection assignments having the 'lifecycleState' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3504

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

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


  connection_type_allowable_values = %w[GOLDENGATE KAFKA KAFKA_SCHEMA_REGISTRY MYSQL JAVA_MESSAGE_SERVICE MICROSOFT_SQLSERVER OCI_OBJECT_STORAGE ORACLE AZURE_DATA_LAKE_STORAGE POSTGRESQL AZURE_SYNAPSE_ANALYTICS SNOWFLAKE AMAZON_S3 HDFS ORACLE_AI_DATA_PLATFORM ORACLE_NOSQL MONGODB AMAZON_KINESIS AMAZON_REDSHIFT DB2 REDIS ELASTICSEARCH GENERIC GOOGLE_CLOUD_STORAGE GOOGLE_BIGQUERY DATABRICKS GOOGLE_PUBSUB MICROSOFT_FABRIC ICEBERG AI_MODEL]
  if opts[:connection_type] && !opts[:connection_type].empty?
    opts[:connection_type].each do |val_to_check|
      unless connection_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "connection_type", must be one of GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL.'
      end
    end
  end


  connection_type_not_equal_to_allowable_values = %w[GOLDENGATE KAFKA KAFKA_SCHEMA_REGISTRY MYSQL JAVA_MESSAGE_SERVICE MICROSOFT_SQLSERVER OCI_OBJECT_STORAGE ORACLE AZURE_DATA_LAKE_STORAGE POSTGRESQL AZURE_SYNAPSE_ANALYTICS SNOWFLAKE AMAZON_S3 HDFS ORACLE_AI_DATA_PLATFORM ORACLE_NOSQL MONGODB AMAZON_KINESIS AMAZON_REDSHIFT DB2 REDIS ELASTICSEARCH GENERIC GOOGLE_CLOUD_STORAGE GOOGLE_BIGQUERY DATABRICKS GOOGLE_PUBSUB MICROSOFT_FABRIC ICEBERG AI_MODEL]
  if opts[:connection_type_not_equal_to] && !opts[:connection_type_not_equal_to].empty?
    opts[:connection_type_not_equal_to].each do |val_to_check|
      unless connection_type_not_equal_to_allowable_values.include?(val_to_check)
        raise 'Invalid value for "connection_type_not_equal_to", must be one of GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL.'
      end
    end
  end

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

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

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

  path = '/connectionAssignments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:deploymentId] = opts[:deployment_id] if opts[:deployment_id]
  query_params[:connectionId] = opts[:connection_id] if opts[:connection_id]
  query_params[:connectionType] = OCI::ApiClient.build_collection_params(opts[:connection_type], :multi) if opts[:connection_type] && !opts[:connection_type].empty?
  query_params[:connectionTypeNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:connection_type_not_equal_to], :multi) if opts[:connection_type_not_equal_to] && !opts[:connection_type_not_equal_to].empty?
  query_params[:name] = opts[:name] if opts[:name]
  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]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_connection_assignments') 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::GoldenGate::Models::ConnectionAssignmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the Connections in the compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :technology_type (Array<String>) —

    The array of technology types.

    Allowed values are: GOLDENGATE, GENERIC, OCI_AUTONOMOUS_DATABASE, OCI_AUTONOMOUS_JSON_DATABASE, OCI_CACHE_WITH_REDIS, OCI_MYSQL, OCI_OBJECT_STORAGE, OCI_POSTGRESQL, OCI_STREAMING, OCI_STREAMING_WITH_APACHE_KAFKA, ORACLE_DATABASE, ORACLE_EXADATA, ORACLE_EXADATA_EXASCALE, ORACLE_EXADATA_DATABASE_AT_AZURE, ORACLE_EXADATA_EXASCALE_AT_AZURE, ORACLE_AUTONOMOUS_DATABASE_AT_AZURE, ORACLE_JSON_COLLECTION, ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD, ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD, ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD, ORACLE_EXADATA_DATABASE_AT_AWS, ORACLE_AUTONOMOUS_DATABASE_AT_AWS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, ORACLE_REST_DATA_SERVICES, ORACLE_WEBLOGIC_JMS, AMAZON_RDS_ORACLE, AMAZON_RDS_SQLSERVER, AMAZON_S3, AMAZON_AURORA_MYSQL, AMAZON_AURORA_POSTGRESQL, AMAZON_DOCUMENT_DB, AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_RDS_MARIADB, AMAZON_RDS_MYSQL, AMAZON_RDS_POSTGRESQL, APACHE_ICEBERG, APACHE_KAFKA, AZURE_COSMOS_DB_FOR_MONGODB, AZURE_COSMOS_DB_FOR_POSTGRESQL, AZURE_DATA_LAKE_STORAGE, AZURE_EVENT_HUBS, AZURE_MYSQL, AZURE_POSTGRESQL, AZURE_SQLSERVER_MANAGED_INSTANCE, AZURE_SQLSERVER_NON_MANAGED_INSTANCE, AZURE_SYNAPSE_ANALYTICS, CONFLUENT_KAFKA, CONFLUENT_SCHEMA_REGISTRY, DATABRICKS, DB2_I, DB2_ZOS, ELASTICSEARCH, EDB_POSTGRES_ADVANCED_SERVER, GOOGLE_ALLOY_DB_FOR_POSTGRESQL, GOOGLE_BIGQUERY, GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA, GOOGLE_CLOUD_STORAGE, GOOGLE_CLOUD_SQL_MYSQL, GOOGLE_CLOUD_SQL_POSTGRESQL, GOOGLE_CLOUD_SQL_SQLSERVER, GOOGLE_PUBSUB, HDFS, MARIADB, MICROSOFT_SQLSERVER, MICROSOFT_FABRIC_EVENTSTREAM, MICROSOFT_FABRIC_LAKEHOUSE, MICROSOFT_FABRIC_MIRROR, MONGODB, MYSQL_SERVER, MYSQL_HEATWAVE_ON_AZURE, MYSQL_HEATWAVE_ON_AWS, POSTGRESQL_SERVER, REDIS, SINGLESTOREDB, SINGLESTOREDB_CLOUD, SNOWFLAKE, YUGABYTE_DB, AI_MODEL

  • :connection_type (Array<String>) —

    The array of connection types.

    Allowed values are: GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL

  • :connection_type_not_equal_to (Array<String>) —

    The array of connection types to exclude.

    Allowed values are: GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL

  • :assigned_deployment_id (String) —

    The OCID of the deployment which for the connection must be assigned.

  • :assignable_deployment_id (String) —

    Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.

  • :assignable_deployment_type (String) —

    Filters for connections which can be assigned to the latest version of the specified deployment type.

  • :lifecycle_state (String) —

    A filter to return only connections having the 'lifecycleState' given.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3637

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

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


  technology_type_allowable_values = %w[GOLDENGATE GENERIC OCI_AUTONOMOUS_DATABASE OCI_AUTONOMOUS_JSON_DATABASE OCI_CACHE_WITH_REDIS OCI_MYSQL OCI_OBJECT_STORAGE OCI_POSTGRESQL OCI_STREAMING OCI_STREAMING_WITH_APACHE_KAFKA ORACLE_DATABASE ORACLE_EXADATA ORACLE_EXADATA_EXASCALE ORACLE_EXADATA_DATABASE_AT_AZURE ORACLE_EXADATA_EXASCALE_AT_AZURE ORACLE_AUTONOMOUS_DATABASE_AT_AZURE ORACLE_JSON_COLLECTION ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD ORACLE_EXADATA_DATABASE_AT_AWS ORACLE_AUTONOMOUS_DATABASE_AT_AWS ORACLE_AI_DATA_PLATFORM ORACLE_NOSQL ORACLE_REST_DATA_SERVICES ORACLE_WEBLOGIC_JMS AMAZON_RDS_ORACLE AMAZON_RDS_SQLSERVER AMAZON_S3 AMAZON_AURORA_MYSQL AMAZON_AURORA_POSTGRESQL AMAZON_DOCUMENT_DB AMAZON_KINESIS AMAZON_REDSHIFT AMAZON_RDS_MARIADB AMAZON_RDS_MYSQL AMAZON_RDS_POSTGRESQL APACHE_ICEBERG APACHE_KAFKA AZURE_COSMOS_DB_FOR_MONGODB AZURE_COSMOS_DB_FOR_POSTGRESQL AZURE_DATA_LAKE_STORAGE AZURE_EVENT_HUBS AZURE_MYSQL AZURE_POSTGRESQL AZURE_SQLSERVER_MANAGED_INSTANCE AZURE_SQLSERVER_NON_MANAGED_INSTANCE AZURE_SYNAPSE_ANALYTICS CONFLUENT_KAFKA CONFLUENT_SCHEMA_REGISTRY DATABRICKS DB2_I DB2_ZOS ELASTICSEARCH EDB_POSTGRES_ADVANCED_SERVER GOOGLE_ALLOY_DB_FOR_POSTGRESQL GOOGLE_BIGQUERY GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA GOOGLE_CLOUD_STORAGE GOOGLE_CLOUD_SQL_MYSQL GOOGLE_CLOUD_SQL_POSTGRESQL GOOGLE_CLOUD_SQL_SQLSERVER GOOGLE_PUBSUB HDFS MARIADB MICROSOFT_SQLSERVER MICROSOFT_FABRIC_EVENTSTREAM MICROSOFT_FABRIC_LAKEHOUSE MICROSOFT_FABRIC_MIRROR MONGODB MYSQL_SERVER MYSQL_HEATWAVE_ON_AZURE MYSQL_HEATWAVE_ON_AWS POSTGRESQL_SERVER REDIS SINGLESTOREDB SINGLESTOREDB_CLOUD SNOWFLAKE YUGABYTE_DB AI_MODEL]
  if opts[:technology_type] && !opts[:technology_type].empty?
    opts[:technology_type].each do |val_to_check|
      unless technology_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "technology_type", must be one of GOLDENGATE, GENERIC, OCI_AUTONOMOUS_DATABASE, OCI_AUTONOMOUS_JSON_DATABASE, OCI_CACHE_WITH_REDIS, OCI_MYSQL, OCI_OBJECT_STORAGE, OCI_POSTGRESQL, OCI_STREAMING, OCI_STREAMING_WITH_APACHE_KAFKA, ORACLE_DATABASE, ORACLE_EXADATA, ORACLE_EXADATA_EXASCALE, ORACLE_EXADATA_DATABASE_AT_AZURE, ORACLE_EXADATA_EXASCALE_AT_AZURE, ORACLE_AUTONOMOUS_DATABASE_AT_AZURE, ORACLE_JSON_COLLECTION, ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD, ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD, ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD, ORACLE_EXADATA_DATABASE_AT_AWS, ORACLE_AUTONOMOUS_DATABASE_AT_AWS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, ORACLE_REST_DATA_SERVICES, ORACLE_WEBLOGIC_JMS, AMAZON_RDS_ORACLE, AMAZON_RDS_SQLSERVER, AMAZON_S3, AMAZON_AURORA_MYSQL, AMAZON_AURORA_POSTGRESQL, AMAZON_DOCUMENT_DB, AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_RDS_MARIADB, AMAZON_RDS_MYSQL, AMAZON_RDS_POSTGRESQL, APACHE_ICEBERG, APACHE_KAFKA, AZURE_COSMOS_DB_FOR_MONGODB, AZURE_COSMOS_DB_FOR_POSTGRESQL, AZURE_DATA_LAKE_STORAGE, AZURE_EVENT_HUBS, AZURE_MYSQL, AZURE_POSTGRESQL, AZURE_SQLSERVER_MANAGED_INSTANCE, AZURE_SQLSERVER_NON_MANAGED_INSTANCE, AZURE_SYNAPSE_ANALYTICS, CONFLUENT_KAFKA, CONFLUENT_SCHEMA_REGISTRY, DATABRICKS, DB2_I, DB2_ZOS, ELASTICSEARCH, EDB_POSTGRES_ADVANCED_SERVER, GOOGLE_ALLOY_DB_FOR_POSTGRESQL, GOOGLE_BIGQUERY, GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA, GOOGLE_CLOUD_STORAGE, GOOGLE_CLOUD_SQL_MYSQL, GOOGLE_CLOUD_SQL_POSTGRESQL, GOOGLE_CLOUD_SQL_SQLSERVER, GOOGLE_PUBSUB, HDFS, MARIADB, MICROSOFT_SQLSERVER, MICROSOFT_FABRIC_EVENTSTREAM, MICROSOFT_FABRIC_LAKEHOUSE, MICROSOFT_FABRIC_MIRROR, MONGODB, MYSQL_SERVER, MYSQL_HEATWAVE_ON_AZURE, MYSQL_HEATWAVE_ON_AWS, POSTGRESQL_SERVER, REDIS, SINGLESTOREDB, SINGLESTOREDB_CLOUD, SNOWFLAKE, YUGABYTE_DB, AI_MODEL.'
      end
    end
  end


  connection_type_allowable_values = %w[GOLDENGATE KAFKA KAFKA_SCHEMA_REGISTRY MYSQL JAVA_MESSAGE_SERVICE MICROSOFT_SQLSERVER OCI_OBJECT_STORAGE ORACLE AZURE_DATA_LAKE_STORAGE POSTGRESQL AZURE_SYNAPSE_ANALYTICS SNOWFLAKE AMAZON_S3 HDFS ORACLE_AI_DATA_PLATFORM ORACLE_NOSQL MONGODB AMAZON_KINESIS AMAZON_REDSHIFT DB2 REDIS ELASTICSEARCH GENERIC GOOGLE_CLOUD_STORAGE GOOGLE_BIGQUERY DATABRICKS GOOGLE_PUBSUB MICROSOFT_FABRIC ICEBERG AI_MODEL]
  if opts[:connection_type] && !opts[:connection_type].empty?
    opts[:connection_type].each do |val_to_check|
      unless connection_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "connection_type", must be one of GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL.'
      end
    end
  end


  connection_type_not_equal_to_allowable_values = %w[GOLDENGATE KAFKA KAFKA_SCHEMA_REGISTRY MYSQL JAVA_MESSAGE_SERVICE MICROSOFT_SQLSERVER OCI_OBJECT_STORAGE ORACLE AZURE_DATA_LAKE_STORAGE POSTGRESQL AZURE_SYNAPSE_ANALYTICS SNOWFLAKE AMAZON_S3 HDFS ORACLE_AI_DATA_PLATFORM ORACLE_NOSQL MONGODB AMAZON_KINESIS AMAZON_REDSHIFT DB2 REDIS ELASTICSEARCH GENERIC GOOGLE_CLOUD_STORAGE GOOGLE_BIGQUERY DATABRICKS GOOGLE_PUBSUB MICROSOFT_FABRIC ICEBERG AI_MODEL]
  if opts[:connection_type_not_equal_to] && !opts[:connection_type_not_equal_to].empty?
    opts[:connection_type_not_equal_to].each do |val_to_check|
      unless connection_type_not_equal_to_allowable_values.include?(val_to_check)
        raise 'Invalid value for "connection_type_not_equal_to", must be one of GOLDENGATE, KAFKA, KAFKA_SCHEMA_REGISTRY, MYSQL, JAVA_MESSAGE_SERVICE, MICROSOFT_SQLSERVER, OCI_OBJECT_STORAGE, ORACLE, AZURE_DATA_LAKE_STORAGE, POSTGRESQL, AZURE_SYNAPSE_ANALYTICS, SNOWFLAKE, AMAZON_S3, HDFS, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, DB2, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY, DATABRICKS, GOOGLE_PUBSUB, MICROSOFT_FABRIC, ICEBERG, AI_MODEL.'
      end
    end
  end

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

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

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

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

  path = '/connections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:technologyType] = OCI::ApiClient.build_collection_params(opts[:technology_type], :multi) if opts[:technology_type] && !opts[:technology_type].empty?
  query_params[:connectionType] = OCI::ApiClient.build_collection_params(opts[:connection_type], :multi) if opts[:connection_type] && !opts[:connection_type].empty?
  query_params[:connectionTypeNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:connection_type_not_equal_to], :multi) if opts[:connection_type_not_equal_to] && !opts[:connection_type_not_equal_to].empty?
  query_params[:assignedDeploymentId] = opts[:assigned_deployment_id] if opts[:assigned_deployment_id]
  query_params[:assignableDeploymentId] = opts[:assignable_deployment_id] if opts[:assignable_deployment_id]
  query_params[:assignableDeploymentType] = opts[:assignable_deployment_type] if opts[:assignable_deployment_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_connections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::ConnectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 the resources that match the 'lifecycleState' given.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3772

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

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

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

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

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

  path = '/databaseRegistrations'
  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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Lists the Backups in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :deployment_id (String) —

    The OCID of the deployment in which to list resources.

  • :lifecycle_state (String) —

    A filter to return only the deployment backups having the 'lifecycleState' given.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3868

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

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

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

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

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

  path = '/deploymentBackups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:deploymentId] = opts[:deployment_id] if opts[:deployment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_deployment_backups') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentBackupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns an array of DeploymentEnvironmentDescriptor

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3959

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

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

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

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

  path = '/deploymentEnvironments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_deployment_environments') 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::GoldenGate::Models::DeploymentEnvironmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_deployment_peers(deployment_id, opts = {}) ⇒ Response

Note:

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

Lists the local and remote peers in a deployment.

Parameters:

  • deployment_id (String) —

    A unique Deployment 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

  • :lifecycle_state (String) —

    A filter to return only the deployment peers having the 'lifecycleState' given.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4044

def list_deployment_peers(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_deployment_peers.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_deployment_peers." if deployment_id.nil?

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

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(deployment_id)

  path = '/deployments/{deploymentId}/peers'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_deployment_peers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentPeerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns an array of DeploymentTypeDescriptor

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :deployment_type (String) —

    The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE. (default to DATABASE_ORACLE)

  • :ogg_version (String) —

    Allows to query by a specific GoldenGate version.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4140

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

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

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

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

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

  path = '/deploymentTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:deploymentType] = opts[:deployment_type] if opts[:deployment_type]
  query_params[:oggVersion] = opts[:ogg_version] if opts[:ogg_version]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_deployment_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the Deployment Upgrades in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :deployment_id (String) —

    The OCID of the deployment in which to list resources.

  • :lifecycle_state (String) —

    A filter to return only the deployment upgrades having the 'lifecycleState' given.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4237

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

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

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

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

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

  path = '/deploymentUpgrades'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:deploymentId] = opts[:deployment_id] if opts[:deployment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_deployment_upgrades') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentUpgradeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns the list of available deployment versions.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :deployment_id (String) —

    The OCID of the deployment in which to list resources.

  • :deployment_type (String) —

    The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE. (default to DATABASE_ORACLE)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4332

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

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

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

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

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

  path = '/deploymentVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:deploymentId] = opts[:deployment_id] if opts[:deployment_id]
  query_params[:deploymentType] = opts[:deployment_type] if opts[:deployment_type]
  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]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_deployment_versions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GoldenGate::Models::DeploymentVersionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_deployment_wallets_operations(deployment_id, opts = {}) ⇒ Response

Note:

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

Lists the wallets export/import operations to/from a deployment.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeStarted' is descending. (default to timeStarted) Allowed values are: timeStarted

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4420

def list_deployment_wallets_operations(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_deployment_wallets_operations.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_deployment_wallets_operations." if deployment_id.nil?

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

  if opts[:sort_order] && !OCI::GoldenGate::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GoldenGate::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(deployment_id)

  path = '/deployments/{deploymentId}/deploymentWalletsOperations'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

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

Note:

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

Lists the Deployments in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :supported_connection_type (String) —

    The connection type which the deployment must support.

  • :assigned_connection_id (String) —

    The OCID of the connection which for the deployment must be assigned.

  • :assignable_connection_id (String) —

    Return the deployments to which the specified connectionId may be assigned.

  • :lifecycle_state (String) —

    A filter to return only the deployments having the 'lifecycleState' given.

  • :lifecycle_sub_state (String) —

    A filter to return only the resources that match the 'lifecycleSubState' given.

  • :deployment_type (String) —

    A filter that returns only the resources matching the specified 'deploymentType'.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :fqdn (String) —

    A filter to return only the resources that match the 'fqdn' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4521

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

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

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

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

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

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

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

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

  path = '/deployments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:supportedConnectionType] = opts[:supported_connection_type] if opts[:supported_connection_type]
  query_params[:assignedConnectionId] = opts[:assigned_connection_id] if opts[:assigned_connection_id]
  query_params[:assignableConnectionId] = opts[:assignable_connection_id] if opts[:assignable_connection_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleSubState] = opts[:lifecycle_sub_state] if opts[:lifecycle_sub_state]
  query_params[:deploymentType] = opts[:deployment_type] if opts[:deployment_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:fqdn] = opts[:fqdn] if opts[:fqdn]
  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]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_deployments') 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::GoldenGate::Models::DeploymentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_messages(deployment_id, opts = {}) ⇒ Response

Note:

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

Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.

Parameters:

  • deployment_id (String) —

    A unique Deployment 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.

  • :limit (Integer) —

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

  • :page (String) —

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

Returns:



4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4619

def list_messages(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_messages.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_messages." if deployment_id.nil?

  path = '/messages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:deploymentId] = deployment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

#list_pipeline_initialization_steps(pipeline_id, opts = {}) ⇒ Response

Note:

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

Retrieves a Pipeline recipe steps and its progress details.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

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

    the optional parameters

Options Hash (opts):

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

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



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4678

def list_pipeline_initialization_steps(pipeline_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_pipeline_initialization_steps.' if logger

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

  path = '/pipelines/{pipelineId}/initializationSteps'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'GoldenGateClient#list_pipeline_initialization_steps') 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::GoldenGate::Models::PipelineInitializationSteps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pipeline_running_processes(pipeline_id, opts = {}) ⇒ Response

Note:

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

Retrieves a Pipeline's running replication process's status like Capture/Apply.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4747

def list_pipeline_running_processes(pipeline_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_pipeline_running_processes.' if logger

  raise "Missing the required parameter 'pipeline_id' when calling list_pipeline_running_processes." if pipeline_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'pipeline_id' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_id)

  path = '/pipelines/{pipelineId}/runningProcesses'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_pipeline_running_processes') 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::GoldenGate::Models::PipelineRunningProcessCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_pipeline_schema_tables(pipeline_id, source_schema_name, target_schema_name, opts = {}) ⇒ Response

Note:

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

Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

  • source_schema_name (String) —

    Name of the source schema obtained from get schema endpoint of the created pipeline.

  • target_schema_name (String) —

    Name of the target schema obtained from get schema endpoint of the created pipeline.

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4834

def list_pipeline_schema_tables(pipeline_id, source_schema_name, target_schema_name, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_pipeline_schema_tables.' if logger

  raise "Missing the required parameter 'pipeline_id' when calling list_pipeline_schema_tables." if pipeline_id.nil?
  raise "Missing the required parameter 'source_schema_name' when calling list_pipeline_schema_tables." if source_schema_name.nil?
  raise "Missing the required parameter 'target_schema_name' when calling list_pipeline_schema_tables." if target_schema_name.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'pipeline_id' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_id)

  path = '/pipelines/{pipelineId}/schemaTables'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sourceSchemaName] = source_schema_name
  query_params[:targetSchemaName] = target_schema_name
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_pipeline_schemas(pipeline_id, opts = {}) ⇒ Response

Note:

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

Returns an array of schemas based on mapping rules for a pipeline.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4922

def list_pipeline_schemas(pipeline_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_pipeline_schemas.' if logger

  raise "Missing the required parameter 'pipeline_id' when calling list_pipeline_schemas." if pipeline_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'pipeline_id' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_id)

  path = '/pipelines/{pipelineId}/schemas'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[: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]

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_pipeline_schemas') 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::GoldenGate::Models::PipelineSchemaCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the Pipelines in the compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 filtered list of pipelines to return for a given lifecycleState.

  • :lifecycle_sub_state (String) —

    A filtered list of pipelines to return for a given lifecycleSubState.

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5013

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

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

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

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

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

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

  path = '/pipelines'
  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[:lifecycleSubState] = opts[:lifecycle_sub_state] if opts[:lifecycle_sub_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Returns an array of Recipe Summary.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :recipe_type (String) —

    The pipeline's recipe type. The default value is ZERO_ETL. (default to ZERO_ETL)

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5112

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

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

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

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

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

  path = '/recipes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:recipeType] = opts[:recipe_type] if opts[:recipe_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_trail_files(deployment_id, opts = {}) ⇒ Response

Note:

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

Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :trail_file_id (String) —

    A Trail File identifier

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is descending. Default order for 'displayName' is ascending. If no value is specified displayName is the default. (default to displayName) Allowed values are: timeLastUpdated, displayName

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5204

def list_trail_files(deployment_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_trail_files.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_trail_files." if deployment_id.nil?

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

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

  path = '/trailFiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:deploymentId] = deployment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:trailFileId] = opts[:trail_file_id] if opts[:trail_file_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_trail_sequences(deployment_id, trail_file_id, opts = {}) ⇒ Response

Note:

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

Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • trail_file_id (String) —

    A Trail File 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

  • :trail_sequence_id (String) —

    A Trail Sequence identifier

  • :display_name (String) —

    A filter to return only the resources that match the entire 'displayName' given.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is descending. Default order for 'displayName' is ascending. If no value is specified displayName is the default. (default to displayName) Allowed values are: timeLastUpdated, displayName

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

Returns:



5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5294

def list_trail_sequences(deployment_id, trail_file_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_trail_sequences.' if logger

  raise "Missing the required parameter 'deployment_id' when calling list_trail_sequences." if deployment_id.nil?
  raise "Missing the required parameter 'trail_file_id' when calling list_trail_sequences." if trail_file_id.nil?

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

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

  path = '/trailSequences'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:deploymentId] = deployment_id
  query_params[:trailFileId] = trail_file_id
  query_params[:trailSequenceId] = opts[:trail_sequence_id] if opts[:trail_sequence_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists work request errors.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

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

  • :limit (Integer) —

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

Returns:



5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5372

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_work_request_errors.' if logger

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::GoldenGate::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists work request logs.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

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

  • :limit (Integer) —

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

Returns:



5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5436

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation GoldenGateClient#list_work_request_logs.' if logger

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_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: 'GoldenGateClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::GoldenGate::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the work requests in the compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

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

    the optional parameters

Options Hash (opts):

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

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

  • :resource_id (String) —

    The OCID of the resource in which to list resources.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

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

  • :limit (Integer) —

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

Returns:



5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5505

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::GoldenGate::Models::WorkRequest>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 94

def logger
  @api_client.config.logger
end

#migrate_connection(connection_id, migrate_connection_details, opts = {}) ⇒ Response

Note:

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

Migrate Connection attributes.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5573

def migrate_connection(connection_id, migrate_connection_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#migrate_connection.' if logger

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

  path = '/connections/{connectionId}/actions/migrate'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(migrate_connection_details)

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

#pause_pipeline(pipeline_id, pause_pipeline_details, opts = {}) ⇒ Response

Note:

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

Pauses the pipeline.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5645

def pause_pipeline(pipeline_id, pause_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#pause_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}/actions/pause'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(pause_pipeline_details)

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

#refresh_connection(connection_id, refresh_connection_details, opts = {}) ⇒ Response

Note:

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

Refresh the external Connection attributes.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5714

def refresh_connection(connection_id, refresh_connection_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#refresh_connection.' if logger

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

  path = '/connections/{connectionId}/actions/refresh'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(refresh_connection_details)

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

#remove_connection_lock(connection_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a Connection resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5778

def remove_connection_lock(connection_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#remove_connection_lock.' if logger

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

  path = '/connections/{connectionId}/actions/removeLock'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

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

#remove_deployment_backup_lock(deployment_backup_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a DeploymentBackup resource.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup identifier.

  • remove_resource_lock_details (OCI::GoldenGate::Models::RemoveResourceLockDetails) —

    RemoveResourceLockDetails body parameter

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5842

def remove_deployment_backup_lock(deployment_backup_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#remove_deployment_backup_lock.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/removeLock'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

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

#remove_deployment_local_peer(deployment_id, remove_deployment_local_peer_details, opts = {}) ⇒ Response

Note:

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

Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5913

def remove_deployment_local_peer(deployment_id, remove_deployment_local_peer_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#remove_deployment_local_peer.' if logger

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

  path = '/deployments/{deploymentId}/actions/removeLocalPeer'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(remove_deployment_local_peer_details)

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

#remove_deployment_lock(deployment_id, remove_resource_lock_details, opts = {}) ⇒ Response

Note:

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

Removes a lock from a Deployment resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

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

  • :if_match (String) —

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

Returns:



5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 5978

def remove_deployment_lock(deployment_id, remove_resource_lock_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#remove_deployment_lock.' if logger

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

  path = '/deployments/{deploymentId}/actions/removeLock'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

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

#reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6049

def reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#reschedule_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/reschedule'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(reschedule_deployment_upgrade_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#reschedule_deployment_upgrade') do
    @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::GoldenGate::Models::DeploymentUpgrade'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#restore_deployment(deployment_backup_id, restore_deployment_details, opts = {}) ⇒ Response

Note:

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

Restores a Deployment from a Deployment Backup created from the same Deployment.

Parameters:

  • deployment_backup_id (String) —

    A unique DeploymentBackup identifier.

  • restore_deployment_details (OCI::GoldenGate::Models::RestoreDeploymentDetails) —

    A placeholder for any additional metadata to describe the deployment restore.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6122

def restore_deployment(deployment_backup_id, restore_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#restore_deployment.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}/actions/restore'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(restore_deployment_details)

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

#rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade identifier.

  • rollback_deployment_upgrade_details (OCI::GoldenGate::Models::RollbackDeploymentUpgradeDetails) —

    A placeholder for any additional metadata to describe the deployment rollback.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6196

def rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#rollback_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/rollback'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(rollback_deployment_upgrade_details)

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

#snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade identifier.

  • snooze_deployment_upgrade_details (OCI::GoldenGate::Models::SnoozeDeploymentUpgradeDetails) —

    A placeholder for any additional metadata to describe the snooze of deployment upgrade.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6269

def snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#snooze_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/snooze'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(snooze_deployment_upgrade_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#snooze_deployment_upgrade') do
    @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_deployment(deployment_id, start_deployment_details, opts = {}) ⇒ Response

Note:

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

Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • start_deployment_details (OCI::GoldenGate::Models::StartDeploymentDetails) —

    A placeholder for any additional metadata to describe the deployment start.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6342

def start_deployment(deployment_id, start_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#start_deployment.' if logger

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

  path = '/deployments/{deploymentId}/actions/start'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(start_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#start_deployment') do
    @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_pipeline(pipeline_id, start_pipeline_details, opts = {}) ⇒ Response

Note:

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

Starts the pipeline for data replication.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6416

def start_pipeline(pipeline_id, start_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#start_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}/actions/start'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(start_pipeline_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#start_pipeline') do
    @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_deployment(deployment_id, stop_deployment_details, opts = {}) ⇒ Response

Note:

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

Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • stop_deployment_details (OCI::GoldenGate::Models::StopDeploymentDetails) —

    A placeholder for any additional metadata to describe the deployment stop.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6490

def stop_deployment(deployment_id, stop_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#stop_deployment.' if logger

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

  path = '/deployments/{deploymentId}/actions/stop'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(stop_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#stop_deployment') do
    @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_pipeline(pipeline_id, stop_pipeline_details, opts = {}) ⇒ Response

Note:

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

Stops the pipeline for data replication.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6564

def stop_pipeline(pipeline_id, stop_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#stop_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}/actions/stop'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(stop_pipeline_details)

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

#switchover_deployment_peer(deployment_id, switchover_deployment_peer_details, opts = {}) ⇒ Response

Note:

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

Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6637

def switchover_deployment_peer(deployment_id, switchover_deployment_peer_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#switchover_deployment_peer.' if logger

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

  path = '/deployments/{deploymentId}/actions/switchover'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(switchover_deployment_peer_details)

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

#test_connection_assignment(connection_assignment_id, test_connection_assignment_details, opts = {}) ⇒ Response

Note:

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

Tests the connectivity between given GoldenGate deployment and one of the associated database / service. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • connection_assignment_id (String) —

    The OCID of the Connection Assignment.

  • test_connection_assignment_details (OCI::GoldenGate::Models::TestConnectionAssignmentDetails) —

    A placeholder for any additional metadata to describe the requested tests of the assigned connection.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6710

def test_connection_assignment(connection_assignment_id, test_connection_assignment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#test_connection_assignment.' if logger

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

  path = '/connectionAssignments/{connectionAssignmentId}/actions/test'.sub('{connectionAssignmentId}', connection_assignment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(test_connection_assignment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GoldenGateClient#test_connection_assignment') do
    @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::GoldenGate::Models::TestConnectionAssignmentResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#test_pipeline_connection(pipeline_id, test_pipeline_connection_details, opts = {}) ⇒ Response

Note:

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

Tests pipeline connections against pipeline to verify the connectivity. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline created.

  • test_pipeline_connection_details (OCI::GoldenGate::Models::TestPipelineConnectionDetails) —

    Additional metadata required to test the connection assigned to the pipeline.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-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 is 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 the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

Returns:



6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6784

def test_pipeline_connection(pipeline_id, test_pipeline_connection_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#test_pipeline_connection.' if logger

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

  path = '/pipelines/{pipelineId}/actions/testConnection'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

#update_connection(connection_id, update_connection_details, opts = {}) ⇒ Response

Note:

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

Updates the Connection.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6853

def update_connection(connection_id, update_connection_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#update_connection.' if logger

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

  path = '/connections/{connectionId}'.sub('{connectionId}', connection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_connection_details)

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

#update_database_registration(database_registration_id, update_database_registration_details, opts = {}) ⇒ Response

Note:

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

Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.

Parameters:

  • database_registration_id (String) —

    A unique DatabaseRegistration identifier.

  • update_database_registration_details (OCI::GoldenGate::Models::UpdateDatabaseRegistrationDetails) —

    The new DatabaseRegistration specifications to apply.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6920

def update_database_registration(database_registration_id, update_database_registration_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#update_database_registration.' if logger

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

  path = '/databaseRegistrations/{databaseRegistrationId}'.sub('{databaseRegistrationId}', database_registration_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_database_registration_details)

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

#update_deployment(deployment_id, update_deployment_details, opts = {}) ⇒ Response

Note:

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

Modifies a Deployment.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 6986

def update_deployment(deployment_id, update_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#update_deployment.' if logger

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

  path = '/deployments/{deploymentId}'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_deployment_details)

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

#update_deployment_backup(deployment_backup_id, update_deployment_backup_details, opts = {}) ⇒ Response

Note:

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

Modifies a Deployment Backup.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:



7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 7053

def update_deployment_backup(deployment_backup_id, update_deployment_backup_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#update_deployment_backup.' if logger

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

  path = '/deploymentBackups/{deploymentBackupId}'.sub('{deploymentBackupId}', deployment_backup_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_deployment_backup_details)

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

#update_pipeline(pipeline_id, update_pipeline_details, opts = {}) ⇒ Response

Note:

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

Updates the Pipeline.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 7121

def update_pipeline(pipeline_id, update_pipeline_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#update_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_pipeline_details)

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

#upgrade_deployment(deployment_id, upgrade_deployment_details, opts = {}) ⇒ Response

Note:

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

Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_id (String) —

    A unique Deployment identifier.

  • upgrade_deployment_details (OCI::GoldenGate::Models::UpgradeDeploymentDetails) —

    A placeholder for any additional metadata to describe the deployment upgrade.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 7193

def upgrade_deployment(deployment_id, upgrade_deployment_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#upgrade_deployment.' if logger

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

  path = '/deployments/{deploymentId}/actions/upgrade'.sub('{deploymentId}', deployment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(upgrade_deployment_details)

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

#upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, opts = {}) ⇒ Response

Note:

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

Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • deployment_upgrade_id (String) —

    A unique Deployment Upgrade identifier.

  • upgrade_deployment_upgrade_details (OCI::GoldenGate::Models::UpgradeDeploymentUpgradeDetails) —

    A placeholder for any additional metadata to describe the deployment upgrade.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the 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 was deleted and purged from the system, then a retry of the original creation request is rejected.

  • :is_lock_override (BOOLEAN) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
 
# File 'lib/oci/golden_gate/golden_gate_client.rb', line 7267

def upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, opts = {})
  logger.debug 'Calling operation GoldenGateClient#upgrade_deployment_upgrade.' if logger

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

  path = '/deploymentUpgrades/{deploymentUpgradeId}/actions/upgrade'.sub('{deploymentUpgradeId}', deployment_upgrade_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(upgrade_deployment_upgrade_details)

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