ScheduledJobClientCompositeOperations

class oci.os_management_hub.ScheduledJobClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ScheduledJobClient 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 functionality

Methods

__init__(client, **kwargs)	Creates a new ScheduledJobClientCompositeOperations object
create_scheduled_job_and_wait_for_state(…)	Calls create_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).
delete_scheduled_job_and_wait_for_state(…)	Calls delete_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).
update_scheduled_job_and_wait_for_state(…)	Calls update_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new ScheduledJobClientCompositeOperations object

Parameters:client (ScheduledJobClient) – The service client which will be wrapped by this object

create_scheduled_job_and_wait_for_state(create_scheduled_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:

• create_scheduled_job_details (oci.os_management_hub.models.CreateScheduledJobDetails) – (required) Provides the information used to create the scheduled 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_scheduled_job()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_scheduled_job_and_wait_for_state(scheduled_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:

• scheduled_job_id (str) –

  (required) The OCID of the scheduled 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_scheduled_job()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_scheduled_job_and_wait_for_state(scheduled_job_id, update_scheduled_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:

• scheduled_job_id (str) –

  (required) The OCID of the scheduled job.

• update_scheduled_job_details (oci.os_management_hub.models.UpdateScheduledJobDetails) – (required) Provides the information used to update the 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 update_scheduled_job()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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