Class: OCI::GoldenGate::GoldenGateClient

Inherits:

Object

Object
OCI::GoldenGate::GoldenGateClient

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

#api_client ⇒ OCI::ApiClient readonly

Client used to make HTTP requests.
#endpoint ⇒ String readonly

Fully qualified endpoint URL.
#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.
#retry_config ⇒ OCI::Retry::RetryConfig readonly

The default retry configuration to apply to all operations in this service client.

Instance Method Summary collapse

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

Cancels a Deployment Backup creation process.
#cancel_deployment_upgrade(deployment_upgrade_id, cancel_deployment_upgrade_details, opts = {}) ⇒ Response

Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
#cancel_snooze_deployment_upgrade(deployment_upgrade_id, cancel_snooze_deployment_upgrade_details, opts = {}) ⇒ Response

Cancel snooze of a DeploymentUpgrade.
#change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ Response

Moves the Connection into a different compartment within the same tenancy.
#change_database_registration_compartment(database_registration_id, change_database_registration_compartment_details, opts = {}) ⇒ Response

Note: Deprecated.
#change_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, opts = {}) ⇒ Response

Moves a DeploymentBackup into a different compartment within the same tenancy.
#change_deployment_compartment(deployment_id, change_deployment_compartment_details, opts = {}) ⇒ Response

Moves the Deployment into a different compartment within the same tenancy.
#collect_deployment_diagnostic(deployment_id, collect_deployment_diagnostic_details, opts = {}) ⇒ Response

Collects the diagnostic of a Deployment.
#copy_deployment_backup(deployment_backup_id, copy_deployment_backup_details, opts = {}) ⇒ Response

Creates a copy of a Deployment Backup.
#create_certificate(create_certificate_details, deployment_id, opts = {}) ⇒ Response

Creates a new certificate to truststore.
#create_connection(create_connection_details, opts = {}) ⇒ Response

Creates a new Connection.
#create_connection_assignment(create_connection_assignment_details, opts = {}) ⇒ Response

Creates a new Connection Assignment.
#create_database_registration(create_database_registration_details, opts = {}) ⇒ Response

Note: Deprecated.
#create_deployment(create_deployment_details, opts = {}) ⇒ Response

Creates a new Deployment.
#create_deployment_backup(create_deployment_backup_details, opts = {}) ⇒ Response

Creates a new DeploymentBackup.
#delete_certificate(deployment_id, certificate_key, opts = {}) ⇒ Response

Deletes the certificate from truststore.
#delete_connection(connection_id, opts = {}) ⇒ Response

Deletes a Connection.
#delete_connection_assignment(connection_assignment_id, opts = {}) ⇒ Response

Deletes a Connection Assignment.
#delete_database_registration(database_registration_id, opts = {}) ⇒ Response

Note: Deprecated.
#delete_deployment(deployment_id, opts = {}) ⇒ Response

Deletes the Deployment.
#delete_deployment_backup(deployment_backup_id, opts = {}) ⇒ Response

Deletes a DeploymentBackup.
#deployment_wallet_exists(deployment_id, deployment_wallet_exists_details, opts = {}) ⇒ Response

Checks if a wallet is already present in the deployment.
#export_deployment_wallet(deployment_id, export_deployment_wallet_details, opts = {}) ⇒ Response

Export the OGG wallet from the deployment to OCI vault.
#get_certificate(deployment_id, certificate_key, opts = {}) ⇒ Response

Retrieves a Certificate.
#get_connection(connection_id, opts = {}) ⇒ Response

Retrieves a Connection.
#get_connection_assignment(connection_assignment_id, opts = {}) ⇒ Response

Retrieves a Connection Assignment.
#get_database_registration(database_registration_id, opts = {}) ⇒ Response

Note: Deprecated.
#get_deployment(deployment_id, opts = {}) ⇒ Response

Retrieves a deployment.
#get_deployment_backup(deployment_backup_id, opts = {}) ⇒ Response

Retrieves a DeploymentBackup.
#get_deployment_upgrade(deployment_upgrade_id, opts = {}) ⇒ Response

Retrieves a deployment upgrade.
#get_work_request(work_request_id, opts = {}) ⇒ Response

Retrieve the WorkRequest identified by the given OCID.
#import_deployment_wallet(deployment_id, import_deployment_wallet_details, opts = {}) ⇒ Response

Imports an OGG wallet from the OCI Vault to the Deployment.
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GoldenGateClient constructor

Creates a new GoldenGateClient.
#list_certificates(deployment_id, opts = {}) ⇒ Response

Returns a list of certificates from truststore.
#list_connection_assignments(compartment_id, opts = {}) ⇒ Response

Lists the Connection Assignments in the compartment.
#list_connections(compartment_id, opts = {}) ⇒ Response

Lists the Connections in the compartment.
#list_database_registrations(compartment_id, opts = {}) ⇒ Response

Note: Deprecated.
#list_deployment_backups(compartment_id, opts = {}) ⇒ Response

Lists the Backups in a compartment.
#list_deployment_types(compartment_id, opts = {}) ⇒ Response

Returns an array of DeploymentTypeDescriptor.
#list_deployment_upgrades(compartment_id, opts = {}) ⇒ Response

Lists the Deployment Upgrades in a compartment.
#list_deployment_versions(compartment_id, opts = {}) ⇒ Response

Returns the list of available deployment versions.
#list_deployment_wallets_operations(deployment_id, opts = {}) ⇒ Response

Lists the wallets export/import operations to/from a deployment.
#list_deployments(compartment_id, opts = {}) ⇒ Response

Lists the Deployments in a compartment.
#list_messages(deployment_id, opts = {}) ⇒ Response

Lists the DeploymentMessages for a deployment.
#list_trail_files(deployment_id, opts = {}) ⇒ Response

Lists the TrailFiles for a deployment.
#list_trail_sequences(deployment_id, trail_file_id, opts = {}) ⇒ Response

Lists the Trail Sequences for a TrailFile in a given deployment.
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Lists work request errors.
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Lists work request logs.
#list_work_requests(compartment_id, opts = {}) ⇒ Response

Lists the work requests in the compartment.
#logger ⇒ Logger

The logger for this client.
#reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, opts = {}) ⇒ Response

Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
#restore_deployment(deployment_backup_id, restore_deployment_details, opts = {}) ⇒ Response

Restores a Deployment from a Deployment Backup created from the same Deployment.
#rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, opts = {}) ⇒ Response

Rollback a deployment to it's previous version.
#snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, opts = {}) ⇒ Response

Snooze a DeploymentUpgrade.
#start_deployment(deployment_id, start_deployment_details, opts = {}) ⇒ Response

Starts a Deployment.
#stop_deployment(deployment_id, stop_deployment_details, opts = {}) ⇒ Response

Stops a Deployment.
#test_connection_assignment(connection_assignment_id, test_connection_assignment_details, opts = {}) ⇒ Response

Tests the connectivity between given GoldenGate deployment and one of the associated database / service.
#update_connection(connection_id, update_connection_details, opts = {}) ⇒ Response

Updates the Connection.
#update_database_registration(database_registration_id, update_database_registration_details, opts = {}) ⇒ Response

Note: Deprecated.
#update_deployment(deployment_id, update_deployment_details, opts = {}) ⇒ Response

Modifies a Deployment.
#update_deployment_backup(deployment_backup_id, update_deployment_backup_details, opts = {}) ⇒ Response

Modifies a Deployment Backup.
#upgrade_deployment(deployment_id, upgrade_deployment_details, opts = {}) ⇒ Response

Upgrade a Deployment.
#upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, opts = {}) ⇒ Response

Upgrade a deployment.

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

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

(OCI::ApiClient)



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:

(OCI::Retry::RetryConfig)



25
26
27

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 125

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 = {}

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

(Response) —

A Response object with data of type DeploymentUpgrade

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 197

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 270

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:

connection_id (String) —

The OCID of a Connection.
change_connection_compartment_details (OCI::GoldenGate::Models::ChangeConnectionCompartmentDetails) —

Properties to change the compartment 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.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 340

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 = {}

  # 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_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:

database_registration_id (String) —

A unique DatabaseRegistration identifier.
change_database_registration_compartment_details (OCI::GoldenGate::Models::ChangeDatabaseRegistrationCompartmentDetails) —

Properties to change the compartment of a DatabaseRegistration.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 414

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:

deployment_backup_id (String) —

A unique DeploymentBackup identifier.
change_deployment_backup_compartment_details (OCI::GoldenGate::Models::ChangeDeploymentBackupCompartmentDetails) —

Properties to change the compartment of a DeploymentBackup.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 489

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 = {}

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

deployment_id (String) —

A unique Deployment identifier.
change_deployment_compartment_details (OCI::GoldenGate::Models::ChangeDeploymentCompartmentDetails) —

Properties to change the compartment of a Deployment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 564

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 = {}

  # 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

#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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 636

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

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

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 707

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 774

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 = {}

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

create_connection_details (OCI::GoldenGate::Models::CreateConnectionDetails) —

Specification of the Connection to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type Connection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 838

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:

create_connection_assignment_details (OCI::GoldenGate::Models::CreateConnectionAssignmentDetails) —

Specification of the connection assignment to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type ConnectionAssignment

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 899

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 = {}

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

create_database_registration_details (OCI::GoldenGate::Models::CreateDatabaseRegistrationDetails) —

Specification of the DatabaseRegistration to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type DatabaseRegistration

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 963

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:

create_deployment_details (OCI::GoldenGate::Models::CreateDeploymentDetails) —

Specifications to create the Deployment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type Deployment

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1026

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:

create_deployment_backup_details (OCI::GoldenGate::Models::CreateDeploymentBackupDetails) —

Specification of the DeploymentBackup to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1087

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1151

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 = {}

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1215

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 = {}

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1276

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 = {}

  # 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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1339

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.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1401

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 = {}

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1463

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 = {}

  # 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

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

(Response) —

A Response object with data of type DeploymentWalletExistsResponseDetails

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1532

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1605

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

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

(Response) —

A Response object with data of type Certificate

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1667

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.

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.

Returns:

(Response) —

A Response object with data of type Connection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1726

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?
  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 = {}

  # Header Params
  header_params = {}
  header_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:

(Response) —

A Response object with data of type ConnectionAssignment

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1783

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:

(Response) —

A Response object with data of type DatabaseRegistration

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1841

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:

(Response) —

A Response object with data of type Deployment

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1898

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:

(Response) —

A Response object with data of type DeploymentBackup

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 1955

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:

(Response) —

A Response object with data of type DeploymentUpgrade

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2012

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

(Response) —

A Response object with data of type WorkRequest

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2069

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.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2138

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 = {}

  # 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_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 10)
: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:

(Response) —

A Response object with data of type CertificateCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2211

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.
: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 10)
: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:

(Response) —

A Response object with data of type ConnectionAssignmentCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2305

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?

  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[: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_MYSQL, OCI_OBJECT_STORAGE, OCI_STREAMING, ORACLE_DATABASE, ORACLE_EXADATA, ORACLE_NOSQL, ORACLE_WEBLOGIC_JMS, AMAZON_RDS_ORACLE, AMAZON_RDS_SQLSERVER, AMAZON_S3, AMAZON_AURORA_MYSQL, AMAZON_AURORA_POSTGRESQL, AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_RDS_MARIADB, AMAZON_RDS_MYSQL, AMAZON_RDS_POSTGRESQL, APACHE_KAFKA, AZURE_COSMOS_DB_FOR_MONGODB, 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, ELASTICSEARCH, GOOGLE_BIGQUERY, GOOGLE_CLOUD_STORAGE, GOOGLE_CLOUD_SQL_MYSQL, GOOGLE_CLOUD_SQL_POSTGRESQL, GOOGLE_CLOUD_SQL_SQLSERVER, HDFS, MARIADB, MICROSOFT_SQLSERVER, MONGODB, MYSQL_SERVER, POSTGRESQL_SERVER, REDIS, SINGLESTOREDB, SINGLESTOREDB_CLOUD, SNOWFLAKE
: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_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY
: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 10)
: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:

(Response) —

A Response object with data of type ConnectionCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2413

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_MYSQL OCI_OBJECT_STORAGE OCI_STREAMING ORACLE_DATABASE ORACLE_EXADATA ORACLE_NOSQL ORACLE_WEBLOGIC_JMS AMAZON_RDS_ORACLE AMAZON_RDS_SQLSERVER AMAZON_S3 AMAZON_AURORA_MYSQL AMAZON_AURORA_POSTGRESQL AMAZON_KINESIS AMAZON_REDSHIFT AMAZON_RDS_MARIADB AMAZON_RDS_MYSQL AMAZON_RDS_POSTGRESQL APACHE_KAFKA AZURE_COSMOS_DB_FOR_MONGODB 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 ELASTICSEARCH GOOGLE_BIGQUERY GOOGLE_CLOUD_STORAGE GOOGLE_CLOUD_SQL_MYSQL GOOGLE_CLOUD_SQL_POSTGRESQL GOOGLE_CLOUD_SQL_SQLSERVER HDFS MARIADB MICROSOFT_SQLSERVER MONGODB MYSQL_SERVER POSTGRESQL_SERVER REDIS SINGLESTOREDB SINGLESTOREDB_CLOUD SNOWFLAKE]
  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_MYSQL, OCI_OBJECT_STORAGE, OCI_STREAMING, ORACLE_DATABASE, ORACLE_EXADATA, ORACLE_NOSQL, ORACLE_WEBLOGIC_JMS, AMAZON_RDS_ORACLE, AMAZON_RDS_SQLSERVER, AMAZON_S3, AMAZON_AURORA_MYSQL, AMAZON_AURORA_POSTGRESQL, AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_RDS_MARIADB, AMAZON_RDS_MYSQL, AMAZON_RDS_POSTGRESQL, APACHE_KAFKA, AZURE_COSMOS_DB_FOR_MONGODB, 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, ELASTICSEARCH, GOOGLE_BIGQUERY, GOOGLE_CLOUD_STORAGE, GOOGLE_CLOUD_SQL_MYSQL, GOOGLE_CLOUD_SQL_POSTGRESQL, GOOGLE_CLOUD_SQL_SQLSERVER, HDFS, MARIADB, MICROSOFT_SQLSERVER, MONGODB, MYSQL_SERVER, POSTGRESQL_SERVER, REDIS, SINGLESTOREDB, SINGLESTOREDB_CLOUD, SNOWFLAKE.'
      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_NOSQL MONGODB AMAZON_KINESIS AMAZON_REDSHIFT REDIS ELASTICSEARCH GENERIC GOOGLE_CLOUD_STORAGE GOOGLE_BIGQUERY]
  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_NOSQL, MONGODB, AMAZON_KINESIS, AMAZON_REDSHIFT, REDIS, ELASTICSEARCH, GENERIC, GOOGLE_CLOUD_STORAGE, GOOGLE_BIGQUERY.'
      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[: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 10)
: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:

(Response) —

A Response object with data of type DatabaseRegistrationCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2537

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 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 10)
: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:

(Response) —

A Response object with data of type DeploymentBackupCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2633

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::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 = '/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_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 10)
: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:

(Response) —

A Response object with data of type DeploymentTypeCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2730

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 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 10)
: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:

(Response) —

A Response object with data of type DeploymentUpgradeCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2827

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::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 = '/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 10)
: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:

(Response) —

A Response object with data of type DeploymentVersionCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 2922

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 10)
: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:

(Response) —

A Response object with data of type DeploymentWalletsOperationCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3010

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 resources that match the 'lifecycleState' given.
:lifecycle_sub_state (String) —

A filter to return only the resources that match the 'lifecycleSubState' given.
: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 10)
: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:

(Response) —

A Response object with data of type DeploymentCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3109

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::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[: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[: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[: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 10)
:page (String) —

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

Returns:

(Response) —

A Response object with data of type DeploymentMessageCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3202

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

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 10)
: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:

(Response) —

A Response object with data of type TrailFileCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3277

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.

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 10)
: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:

(Response) —

A Response object with data of type TrailSequenceCollection

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3366

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

Returns:

(Response) —

A Response object with data of type Array<WorkRequestError>

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3444

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

Returns:

(Response) —

A Response object with data of type Array<WorkRequestLogEntry>

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3508

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

Returns:

(Response) —

A Response object with data of type Array<WorkRequest>

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3577

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

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

deployment_upgrade_id (String) —

A unique Deployment Upgrade identifier.
reschedule_deployment_upgrade_details (OCI::GoldenGate::Models::RescheduleDeploymentUpgradeDetails) —

Properties to reschedule DeploymentUpgrade.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3649

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.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3721

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 = {}

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3793

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 = {}

  # 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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3865

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.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 3937

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 = {}

  # 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

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4009

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 = {}

  # 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

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

(Response) —

A Response object with data of type TestConnectionAssignmentResult

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4082

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

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

connection_id (String) —

The OCID of a Connection.
update_connection_details (OCI::GoldenGate::Models::UpdateConnectionDetails) —

The new Connection 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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4150

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 = {}

  # 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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4216

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:

deployment_id (String) —

A unique Deployment identifier.
update_deployment_details (OCI::GoldenGate::Models::UpdateDeploymentDetails) —

The information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4281

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 = {}

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

deployment_backup_id (String) —

A unique DeploymentBackup identifier.
update_deployment_backup_details (OCI::GoldenGate::Models::UpdateDeploymentBackupDetails) —

The information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4346

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 = {}

  # 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

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4417

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 = {}

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/golden_gate/golden_gate_client.rb', line 4489

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 = {}

  # 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

Class: OCI::GoldenGate::GoldenGateClient

Overview

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

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

Instance Method Details

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

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

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

#change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ Response

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

#change_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, opts = {}) ⇒ Response

#change_deployment_compartment(deployment_id, change_deployment_compartment_details, opts = {}) ⇒ Response

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#list_trail_sequences(deployment_id, trail_file_id, opts = {}) ⇒ Response

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

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

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

#logger ⇒ Logger

#reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, opts = {}) ⇒ Response

#restore_deployment(deployment_backup_id, restore_deployment_details, opts = {}) ⇒ Response

#rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, opts = {}) ⇒ Response

#snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, opts = {}) ⇒ Response

#start_deployment(deployment_id, start_deployment_details, opts = {}) ⇒ Response

#stop_deployment(deployment_id, stop_deployment_details, opts = {}) ⇒ Response

#test_connection_assignment(connection_assignment_id, test_connection_assignment_details, opts = {}) ⇒ Response

#update_connection(connection_id, update_connection_details, opts = {}) ⇒ Response

#update_database_registration(database_registration_id, update_database_registration_details, opts = {}) ⇒ Response

#update_deployment(deployment_id, update_deployment_details, opts = {}) ⇒ Response

#update_deployment_backup(deployment_backup_id, update_deployment_backup_details, opts = {}) ⇒ Response

#upgrade_deployment(deployment_id, upgrade_deployment_details, opts = {}) ⇒ Response

#upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, opts = {}) ⇒ Response

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

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

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

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

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

#change_connection_compartment(connection_id, change_connection_compartment_details, opts = {}) ⇒ `Response`

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

#change_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, opts = {}) ⇒ `Response`

#change_deployment_compartment(deployment_id, change_deployment_compartment_details, opts = {}) ⇒ `Response`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#list_deployment_versions(compartment_id, opts = {}) ⇒ `Response`

#list_deployment_wallets_operations(deployment_id, opts = {}) ⇒ `Response`

#list_deployments(compartment_id, opts = {}) ⇒ `Response`

#list_messages(deployment_id, opts = {}) ⇒ `Response`

#list_trail_files(deployment_id, opts = {}) ⇒ `Response`

#list_trail_sequences(deployment_id, trail_file_id, opts = {}) ⇒ `Response`

#list_work_request_errors(work_request_id, opts = {}) ⇒ `Response`

#list_work_request_logs(work_request_id, opts = {}) ⇒ `Response`

#list_work_requests(compartment_id, opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

#reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, opts = {}) ⇒ `Response`

#restore_deployment(deployment_backup_id, restore_deployment_details, opts = {}) ⇒ `Response`

#rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, opts = {}) ⇒ `Response`

#snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, opts = {}) ⇒ `Response`

#start_deployment(deployment_id, start_deployment_details, opts = {}) ⇒ `Response`

#stop_deployment(deployment_id, stop_deployment_details, opts = {}) ⇒ `Response`

#test_connection_assignment(connection_assignment_id, test_connection_assignment_details, opts = {}) ⇒ `Response`

#update_connection(connection_id, update_connection_details, opts = {}) ⇒ `Response`

#update_database_registration(database_registration_id, update_database_registration_details, opts = {}) ⇒ `Response`

#update_deployment(deployment_id, update_deployment_details, opts = {}) ⇒ `Response`

#update_deployment_backup(deployment_backup_id, update_deployment_backup_details, opts = {}) ⇒ `Response`

#upgrade_deployment(deployment_id, upgrade_deployment_details, opts = {}) ⇒ `Response`

#upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, opts = {}) ⇒ `Response`