BatchComputingClientCompositeOperations¶
-
class
oci.batch.BatchComputingClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
BatchComputingClientand 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 BatchComputingClientCompositeOperations object
Parameters: client (BatchComputingClient) – The service client which will be wrapped by this object
-
cancel_batch_job_and_wait_for_state(batch_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
cancel_batch_job()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_id (str) –
(required) The OCID of the batch job.
- 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_batch_job() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_id (str) –
-
change_batch_context_compartment_and_wait_for_state(batch_context_id, change_batch_context_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_batch_context_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_context_id (str) –
(required) The OCID of the batch context.
- change_batch_context_compartment_details (oci.batch.models.ChangeBatchContextCompartmentDetails) – (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
change_batch_context_compartment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_context_id (str) –
-
change_batch_job_compartment_and_wait_for_state(batch_job_id, change_batch_job_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_batch_job_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_id (str) –
(required) The OCID of the batch job.
- change_batch_job_compartment_details (oci.batch.models.ChangeBatchJobCompartmentDetails) – (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
change_batch_job_compartment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_id (str) –
-
change_batch_job_pool_compartment_and_wait_for_state(batch_job_pool_id, change_batch_job_pool_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_batch_job_pool_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_pool_id (str) –
(required) The OCID of the batch job pool.
- change_batch_job_pool_compartment_details (oci.batch.models.ChangeBatchJobPoolCompartmentDetails) – (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
change_batch_job_pool_compartment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_pool_id (str) –
-
change_batch_task_environment_compartment_and_wait_for_state(batch_task_environment_id, change_batch_task_environment_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_batch_task_environment_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_task_environment_id (str) –
(required) The OCID of the batch task environment.
- change_batch_task_environment_compartment_details (oci.batch.models.ChangeBatchTaskEnvironmentCompartmentDetails) – (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
change_batch_task_environment_compartment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_environment_id (str) –
-
change_batch_task_profile_compartment_and_wait_for_state(batch_task_profile_id, change_batch_task_profile_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_batch_task_profile_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_task_profile_id (str) –
(required) The OCID of the batch task profile.
- change_batch_task_profile_compartment_details (oci.batch.models.ChangeBatchTaskProfileCompartmentDetails) – (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
change_batch_task_profile_compartment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_profile_id (str) –
-
create_batch_context_and_wait_for_state(create_batch_context_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_batch_context()and waits for theWorkRequestto enter the given state(s).Parameters: - create_batch_context_details (oci.batch.models.CreateBatchContextDetails) – (required) Details for the new batch context.
- 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_batch_context() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_batch_job_and_wait_for_state(create_batch_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_batch_job()and waits for theWorkRequestto enter the given state(s).Parameters: - create_batch_job_details (oci.batch.models.CreateBatchJobDetails) – (required) Details for the new batch job.
- 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_batch_job() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_batch_job_pool_and_wait_for_state(create_batch_job_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_batch_job_pool()and waits for theBatchJobPoolacted upon to enter the given state(s).Parameters: - create_batch_job_pool_details (oci.batch.models.CreateBatchJobPoolDetails) – (required) Details for the new batch job pool.
- 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_batch_job_pool() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_batch_task_environment_and_wait_for_state(create_batch_task_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_batch_task_environment()and waits for theBatchTaskEnvironmentacted upon to enter the given state(s).Parameters: - create_batch_task_environment_details (oci.batch.models.CreateBatchTaskEnvironmentDetails) – (required) Details for the new batch task environment.
- 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_batch_task_environment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_batch_task_profile_and_wait_for_state(create_batch_task_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_batch_task_profile()and waits for theBatchTaskProfileacted upon to enter the given state(s).Parameters: - create_batch_task_profile_details (oci.batch.models.CreateBatchTaskProfileDetails) – (required) Details for the new batch task profile.
- 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_batch_task_profile() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_batch_context_and_wait_for_state(batch_context_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_batch_context()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_context_id (str) –
(required) The OCID of the batch context.
- 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_batch_context() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_context_id (str) –
-
delete_batch_job_pool_and_wait_for_state(batch_job_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_batch_job_pool()and waits for theBatchJobPoolacted upon to enter the given state(s).Parameters: - batch_job_pool_id (str) –
(required) The OCID of the batch job pool.
- 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_batch_job_pool() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_pool_id (str) –
-
delete_batch_task_environment_and_wait_for_state(batch_task_environment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_batch_task_environment()and waits for theBatchTaskEnvironmentacted upon to enter the given state(s).Parameters: - batch_task_environment_id (str) –
(required) The OCID of the batch task environment.
- 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_batch_task_environment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_environment_id (str) –
-
delete_batch_task_profile_and_wait_for_state(batch_task_profile_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_batch_task_profile()and waits for theBatchTaskProfileacted upon to enter the given state(s).Parameters: - batch_task_profile_id (str) –
(required) The OCID of the batch task profile.
- 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_batch_task_profile() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_profile_id (str) –
-
pause_batch_job_and_wait_for_state(batch_job_id, pause_batch_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
pause_batch_job()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_id (str) –
(required) The OCID of the batch job.
- pause_batch_job_details (oci.batch.models.PauseBatchJobDetails) – (required) Information needed to pause the batch job.
- 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
pause_batch_job() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_id (str) –
-
start_batch_context_and_wait_for_state(batch_context_id, start_batch_context_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_batch_context()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_context_id (str) –
(required) The OCID of the batch context.
- start_batch_context_details (oci.batch.models.StartBatchContextDetails) – (required) Information needed to start the batch context.
- 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_batch_context() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_context_id (str) –
-
start_batch_job_pool_and_wait_for_state(batch_job_pool_id, start_batch_job_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_batch_job_pool()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_pool_id (str) –
(required) The OCID of the batch job pool.
- start_batch_job_pool_details (oci.batch.models.StartBatchJobPoolDetails) – (required) Information needed to start the batch job pool.
- 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_batch_job_pool() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_pool_id (str) –
-
stop_batch_context_and_wait_for_state(batch_context_id, stop_batch_context_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_batch_context()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_context_id (str) –
(required) The OCID of the batch context.
- stop_batch_context_details (oci.batch.models.StopBatchContextDetails) – (required) Information needed to stop the batch context.
- 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_batch_context() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_context_id (str) –
-
stop_batch_job_pool_and_wait_for_state(batch_job_pool_id, stop_batch_job_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_batch_job_pool()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_pool_id (str) –
(required) The OCID of the batch job pool.
- stop_batch_job_pool_details (oci.batch.models.StopBatchJobPoolDetails) – (required) Information needed to stop the batch job pool.
- 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_batch_job_pool() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_pool_id (str) –
-
unpause_batch_job_and_wait_for_state(batch_job_id, unpause_batch_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
unpause_batch_job()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_id (str) –
(required) The OCID of the batch job.
- unpause_batch_job_details (oci.batch.models.UnpauseBatchJobDetails) – (required) Information needed to unpause the batch job.
- 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
unpause_batch_job() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_id (str) –
-
update_batch_context_and_wait_for_state(batch_context_id, update_batch_context_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_batch_context()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_context_id (str) –
(required) The OCID of the batch context.
- update_batch_context_details (oci.batch.models.UpdateBatchContextDetails) – (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_batch_context() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_context_id (str) –
-
update_batch_job_and_wait_for_state(batch_job_id, update_batch_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_batch_job()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_id (str) –
(required) The OCID of the batch job.
- update_batch_job_details (oci.batch.models.UpdateBatchJobDetails) – (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_batch_job() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_id (str) –
-
update_batch_job_pool_and_wait_for_state(batch_job_pool_id, update_batch_job_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_batch_job_pool()and waits for theWorkRequestto enter the given state(s).Parameters: - batch_job_pool_id (str) –
(required) The OCID of the batch job pool.
- update_batch_job_pool_details (oci.batch.models.UpdateBatchJobPoolDetails) – (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_batch_job_pool() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_job_pool_id (str) –
-
update_batch_task_environment_and_wait_for_state(batch_task_environment_id, update_batch_task_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_batch_task_environment()and waits for theBatchTaskEnvironmentacted upon to enter the given state(s).Parameters: - batch_task_environment_id (str) –
(required) The OCID of the batch task environment.
- update_batch_task_environment_details (oci.batch.models.UpdateBatchTaskEnvironmentDetails) – (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_batch_task_environment() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_environment_id (str) –
-
update_batch_task_profile_and_wait_for_state(batch_task_profile_id, update_batch_task_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_batch_task_profile()and waits for theBatchTaskProfileacted upon to enter the given state(s).Parameters: - batch_task_profile_id (str) –
(required) The OCID of the batch task profile.
- update_batch_task_profile_details (oci.batch.models.UpdateBatchTaskProfileDetails) – (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_batch_task_profile() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- batch_task_profile_id (str) –
-