TransferJobClientCompositeOperations¶
-
class
oci.dts.
TransferJobClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
TransferJobClient
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 TransferJobClientCompositeOperations object create_transfer_job_and_wait_for_state
(…)Calls create_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).delete_transfer_job_and_wait_for_state
(id[, …])Calls delete_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).update_transfer_job_and_wait_for_state
(id, …)Calls update_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new TransferJobClientCompositeOperations object
Parameters: client (TransferJobClient) – The service client which will be wrapped by this object
-
create_transfer_job_and_wait_for_state
(create_transfer_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).Parameters: - create_transfer_job_details (oci.dts.models.CreateTransferJobDetails) – (required) Creates a New Transfer Job
- 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
create_transfer_job()
- 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_transfer_job_and_wait_for_state
(id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).Parameters: - id (str) – (required) ID of the Transfer Job
- 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
delete_transfer_job()
- 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_transfer_job_and_wait_for_state
(id, update_transfer_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_transfer_job()
and waits for theTransferJob
acted upon to enter the given state(s).Parameters: - id (str) – (required) ID of the Transfer Job
- update_transfer_job_details (oci.dts.models.UpdateTransferJobDetails) – (required) fields to update
- 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_transfer_job()
- 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
-