GoldenGateClientCompositeOperations¶
-
class
oci.golden_gate.
GoldenGateClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
GoldenGateClient
and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods
__init__
(client, **kwargs)Creates a new GoldenGateClientCompositeOperations object cancel_deployment_backup_and_wait_for_state
(…)Calls cancel_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).change_database_registration_compartment_and_wait_for_state
(…)Calls change_database_registration_compartment()
and waits for theWorkRequest
to enter the given state(s).change_deployment_compartment_and_wait_for_state
(…)Calls change_deployment_compartment()
and waits for theWorkRequest
to enter the given state(s).create_database_registration_and_wait_for_state
(…)Calls create_database_registration()
and waits for theWorkRequest
to enter the given state(s).create_deployment_and_wait_for_state
(…[, …])Calls create_deployment()
and waits for theWorkRequest
to enter the given state(s).create_deployment_backup_and_wait_for_state
(…)Calls create_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).delete_database_registration_and_wait_for_state
(…)Calls delete_database_registration()
and waits for theWorkRequest
to enter the given state(s).delete_deployment_and_wait_for_state
(…[, …])Calls delete_deployment()
and waits for theWorkRequest
to enter the given state(s).delete_deployment_backup_and_wait_for_state
(…)Calls delete_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).restore_deployment_and_wait_for_state
(…[, …])Calls restore_deployment()
and waits for theWorkRequest
to enter the given state(s).start_deployment_and_wait_for_state
(…[, …])Calls start_deployment()
and waits for theWorkRequest
to enter the given state(s).stop_deployment_and_wait_for_state
(…[, …])Calls stop_deployment()
and waits for theWorkRequest
to enter the given state(s).update_database_registration_and_wait_for_state
(…)Calls update_database_registration()
and waits for theWorkRequest
to enter the given state(s).update_deployment_and_wait_for_state
(…[, …])Calls update_deployment()
and waits for theWorkRequest
to enter the given state(s).update_deployment_backup_and_wait_for_state
(…)Calls update_deployment_backup()
and waits for theDeploymentBackup
acted upon to enter the given state(s).upgrade_deployment_and_wait_for_state
(…[, …])Calls upgrade_deployment()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new GoldenGateClientCompositeOperations object
Parameters: client (GoldenGateClient) – The service client which will be wrapped by this object
-
cancel_deployment_backup_and_wait_for_state
(deployment_backup_id, cancel_deployment_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
cancel_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_backup_id (str) – (required) A unique DeploymentBackup identifier.
- cancel_deployment_backup_details (oci.golden_gate.models.CancelDeploymentBackupDetails) – (required) A placeholder for any additional metadata to describe the deployment backup cancel.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_deployment_backup()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
change_database_registration_compartment_and_wait_for_state
(database_registration_id, change_database_registration_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_database_registration_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_registration_id (str) – (required) A unique DatabaseRegistration identifier.
- change_database_registration_compartment_details (oci.golden_gate.models.ChangeDatabaseRegistrationCompartmentDetails) – (required) Properties to change the compartment of a DatabaseRegistration.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_database_registration_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
change_deployment_compartment_and_wait_for_state
(deployment_id, change_deployment_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_deployment_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- change_deployment_compartment_details (oci.golden_gate.models.ChangeDeploymentCompartmentDetails) – (required) Properties to change the compartment of a Deployment.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_deployment_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_database_registration_and_wait_for_state
(create_database_registration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_database_registration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_database_registration_details (oci.golden_gate.models.CreateDatabaseRegistrationDetails) – (required) Specification of the DatabaseRegistration to create.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_database_registration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_deployment_and_wait_for_state
(create_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_deployment_details (oci.golden_gate.models.CreateDeploymentDetails) – (required) Specifications to create the Deployment.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_deployment_backup_and_wait_for_state
(create_deployment_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_deployment_backup_details (oci.golden_gate.models.CreateDeploymentBackupDetails) – (required) Specification of the DeploymentBackup to create.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_deployment_backup()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_database_registration_and_wait_for_state
(database_registration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_database_registration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_registration_id (str) – (required) A unique DatabaseRegistration identifier.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_database_registration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_deployment_and_wait_for_state
(deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_deployment_backup_and_wait_for_state
(deployment_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_deployment_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_backup_id (str) – (required) A unique DeploymentBackup identifier.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_deployment_backup()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
restore_deployment_and_wait_for_state
(deployment_backup_id, restore_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
restore_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_backup_id (str) – (required) A unique DeploymentBackup identifier.
- restore_deployment_details (oci.golden_gate.models.RestoreDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment restore.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
restore_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
start_deployment_and_wait_for_state
(deployment_id, start_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- start_deployment_details (oci.golden_gate.models.StartDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment start.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
start_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
stop_deployment_and_wait_for_state
(deployment_id, stop_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- stop_deployment_details (oci.golden_gate.models.StopDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment stop.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
stop_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_database_registration_and_wait_for_state
(database_registration_id, update_database_registration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_database_registration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_registration_id (str) – (required) A unique DatabaseRegistration identifier.
- update_database_registration_details (oci.golden_gate.models.UpdateDatabaseRegistrationDetails) – (required) The new DatabaseRegistration specifications to apply.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_database_registration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_deployment_and_wait_for_state
(deployment_id, update_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- update_deployment_details (oci.golden_gate.models.UpdateDeploymentDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_deployment_backup_and_wait_for_state
(deployment_backup_id, update_deployment_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_deployment_backup()
and waits for theDeploymentBackup
acted upon to enter the given state(s).Parameters: - deployment_backup_id (str) – (required) A unique DeploymentBackup identifier.
- update_deployment_backup_details (oci.golden_gate.models.UpdateDeploymentBackupDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_deployment_backup()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
upgrade_deployment_and_wait_for_state
(deployment_id, upgrade_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
upgrade_deployment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - deployment_id (str) – (required) A unique Deployment identifier.
- upgrade_deployment_details (oci.golden_gate.models.UpgradeDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment upgrade.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
upgrade_deployment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-