ScheduleClientCompositeOperations

class oci.resource_scheduler.ScheduleClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ScheduleClient 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 ScheduleClientCompositeOperations object
activate_schedule_and_wait_for_state(schedule_id)	Calls activate_schedule() and waits for the Schedule acted upon to enter the given state(s).
change_schedule_compartment_and_wait_for_state(…)	Calls change_schedule_compartment() and waits for the WorkRequest to enter the given state(s).
create_schedule_and_wait_for_state(…[, …])	Calls create_schedule() and waits for the WorkRequest to enter the given state(s).
deactivate_schedule_and_wait_for_state(…)	Calls deactivate_schedule() and waits for the Schedule acted upon to enter the given state(s).
delete_schedule_and_wait_for_state(schedule_id)	Calls delete_schedule() and waits for the Schedule acted upon to enter the given state(s).
update_schedule_and_wait_for_state(…[, …])	Calls update_schedule() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new ScheduleClientCompositeOperations object

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

activate_schedule_and_wait_for_state(schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls activate_schedule() and waits for the Schedule acted upon to enter the given state(s).

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• 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 activate_schedule()
• 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

change_schedule_compartment_and_wait_for_state(schedule_id, change_schedule_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_schedule_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• change_schedule_compartment_details (oci.resource_scheduler.models.ChangeScheduleCompartmentDetails) – (required) This is the change schedule compartment details that will 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_schedule_compartment()
• 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

create_schedule_and_wait_for_state(create_schedule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_schedule() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_schedule_details (oci.resource_scheduler.models.CreateScheduleDetails) – (required) This API shows the details of the new schedule
• 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_schedule()
• 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

deactivate_schedule_and_wait_for_state(schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls deactivate_schedule() and waits for the Schedule acted upon to enter the given state(s).

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• 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 deactivate_schedule()
• 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_schedule_and_wait_for_state(schedule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_schedule() and waits for the Schedule acted upon to enter the given state(s).

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• 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_schedule()
• 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_schedule_and_wait_for_state(schedule_id, update_schedule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_schedule() and waits for the WorkRequest to enter the given state(s).

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• update_schedule_details (oci.resource_scheduler.models.UpdateScheduleDetails) – (required) The information about a schedule that will 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_schedule()
• 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