FleetAppsManagementRunbooksClientCompositeOperations

class oci.fleet_apps_management.FleetAppsManagementRunbooksClientCompositeOperations(client, **kwargs)

This class provides a wrapper around FleetAppsManagementRunbooksClient 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 FleetAppsManagementRunbooksClientCompositeOperations object
change_runbook_compartment_and_wait_for_state(…)	Calls change_runbook_compartment() and waits for the WorkRequest to enter the given state(s).
change_task_record_compartment_and_wait_for_state(…)	Calls change_task_record_compartment() and waits for the WorkRequest to enter the given state(s).
create_runbook_and_wait_for_state(…[, …])	Calls create_runbook() and waits for the WorkRequest to enter the given state(s).
create_runbook_version_and_wait_for_state(…)	Calls create_runbook_version() and waits for the WorkRequest to enter the given state(s).
create_task_record_and_wait_for_state(…[, …])	Calls create_task_record() and waits for the TaskRecord acted upon to enter the given state(s).
delete_runbook_and_wait_for_state(runbook_id)	Calls delete_runbook() and waits for the WorkRequest to enter the given state(s).
delete_runbook_version_and_wait_for_state(…)	Calls delete_runbook_version() and waits for the WorkRequest to enter the given state(s).
delete_task_record_and_wait_for_state(…[, …])	Calls delete_task_record() and waits for the WorkRequest to enter the given state(s).
publish_runbook_and_wait_for_state(…[, …])	Calls publish_runbook() and waits for the WorkRequest to enter the given state(s).
update_runbook_and_wait_for_state(…[, …])	Calls update_runbook() and waits for the WorkRequest to enter the given state(s).
update_runbook_version_and_wait_for_state(…)	Calls update_runbook_version() and waits for the WorkRequest to enter the given state(s).
update_task_record_and_wait_for_state(…[, …])	Calls update_task_record() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new FleetAppsManagementRunbooksClientCompositeOperations object

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

change_runbook_compartment_and_wait_for_state(runbook_id, change_runbook_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• runbook_id (str) – (required) Unique Runbook identifier
• change_runbook_compartment_details (oci.fleet_apps_management.models.ChangeRunbookCompartmentDetails) – (required) Details of the target compartment.
• 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_runbook_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

change_task_record_compartment_and_wait_for_state(task_record_id, change_task_record_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• task_record_id (str) – (required) The OCID of the task record.
• change_task_record_compartment_details (oci.fleet_apps_management.models.ChangeTaskRecordCompartmentDetails) – (required) Details of the target compartment.
• 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_task_record_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_runbook_and_wait_for_state(create_runbook_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_runbook_details (oci.fleet_apps_management.models.CreateRunbookDetails) – (required) Details for the new Runbook.
• 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_runbook()
• 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_runbook_version_and_wait_for_state(create_runbook_version_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_runbook_version_details (oci.fleet_apps_management.models.CreateRunbookVersionDetails) – (required) Details for the new Runbook Version.
• 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_runbook_version()
• 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_task_record_and_wait_for_state(create_task_record_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_task_record() and waits for the TaskRecord acted upon to enter the given state(s).

Parameters:

• create_task_record_details (oci.fleet_apps_management.models.CreateTaskRecordDetails) – (required) Attributes to create a task record.
• 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_task_record()
• 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_runbook_and_wait_for_state(runbook_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• runbook_id (str) – (required) Unique Runbook 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_runbook()
• 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_runbook_version_and_wait_for_state(runbook_version_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• runbook_version_id (str) – (required) Unique Runbook Version 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_runbook_version()
• 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_task_record_and_wait_for_state(task_record_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• task_record_id (str) – (required) The OCID of the task record.
• 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_task_record()
• 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

publish_runbook_and_wait_for_state(publish_runbook_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• publish_runbook_details (oci.fleet_apps_management.models.PublishRunbookDetails) – (required) Details for publishing the specified version of runbook.
• 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 publish_runbook()
• 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_runbook_and_wait_for_state(runbook_id, update_runbook_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• runbook_id (str) – (required) Unique Runbook identifier
• update_runbook_details (oci.fleet_apps_management.models.UpdateRunbookDetails) – (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_runbook()
• 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_runbook_version_and_wait_for_state(runbook_version_id, update_runbook_version_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• runbook_version_id (str) – (required) Unique Runbook Version identifier
• update_runbook_version_details (oci.fleet_apps_management.models.UpdateRunbookVersionDetails) – (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_runbook_version()
• 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_task_record_and_wait_for_state(task_record_id, update_task_record_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• task_record_id (str) – (required) The OCID of the task record.
• update_task_record_details (oci.fleet_apps_management.models.UpdateTaskRecordDetails) – (required) Attributes to update a task record.
• 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_task_record()
• 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