LifecycleEnvironmentClientCompositeOperations¶
-
class
oci.os_management_hub.LifecycleEnvironmentClientCompositeOperations(client, work_request_clients=None, **kwargs)¶ This class provides a wrapper around
LifecycleEnvironmentClientand 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, work_request_clients=None, **kwargs)¶ Creates a new LifecycleEnvironmentClientCompositeOperations object
Parameters: - client (LifecycleEnvironmentClient) – The service client which will be wrapped by this object
- work_request_clients (dict) –
(optional) Service-local clients keyed by generated client class name, for example
{'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.
Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.
-
attach_managed_instances_to_lifecycle_stage_and_wait_for_state(lifecycle_stage_id, attach_managed_instances_to_lifecycle_stage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
attach_managed_instances_to_lifecycle_stage()and waits for theWorkRequestto enter the given state(s).Parameters: - lifecycle_stage_id (str) –
(required) The OCID of the lifecycle stage.
- attach_managed_instances_to_lifecycle_stage_details (oci.os_management_hub.models.AttachManagedInstancesToLifecycleStageDetails) – (required) Details for managed instances to attach to the lifecycle stage.
- 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
attach_managed_instances_to_lifecycle_stage() - 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
- lifecycle_stage_id (str) –
-
create_lifecycle_environment_and_wait_for_state(create_lifecycle_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_lifecycle_environment()and waits for theLifecycleEnvironmentacted upon to enter the given state(s).Parameters: - create_lifecycle_environment_details (oci.os_management_hub.models.CreateLifecycleEnvironmentDetails) – (required) Details for the new lifecycle 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_lifecycle_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
-
delete_lifecycle_environment_and_wait_for_state(lifecycle_environment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_lifecycle_environment()and waits for theLifecycleEnvironmentacted upon to enter the given state(s).Parameters: - lifecycle_environment_id (str) –
(required) The OCID of the lifecycle 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_lifecycle_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
- lifecycle_environment_id (str) –
-
detach_managed_instances_from_lifecycle_stage_and_wait_for_state(lifecycle_stage_id, detach_managed_instances_from_lifecycle_stage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
detach_managed_instances_from_lifecycle_stage()and waits for theWorkRequestto enter the given state(s).Parameters: - lifecycle_stage_id (str) –
(required) The OCID of the lifecycle stage.
- detach_managed_instances_from_lifecycle_stage_details (oci.os_management_hub.models.DetachManagedInstancesFromLifecycleStageDetails) – (required) Details for the managed instance to detach from the lifecycle stage.
- 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
detach_managed_instances_from_lifecycle_stage() - 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
- lifecycle_stage_id (str) –
-
promote_software_source_to_lifecycle_stage_and_wait_for_state(lifecycle_stage_id, promote_software_source_to_lifecycle_stage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
promote_software_source_to_lifecycle_stage()and waits for theWorkRequestto enter the given state(s).Parameters: - lifecycle_stage_id (str) –
(required) The OCID of the lifecycle stage.
- promote_software_source_to_lifecycle_stage_details (oci.os_management_hub.models.PromoteSoftwareSourceToLifecycleStageDetails) – (required) Details for the software source promotion 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
promote_software_source_to_lifecycle_stage() - 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
- lifecycle_stage_id (str) –
-
reboot_lifecycle_stage_and_wait_for_state(lifecycle_stage_id, reboot_lifecycle_stage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
reboot_lifecycle_stage()and waits for theWorkRequestto enter the given state(s).Parameters: - lifecycle_stage_id (str) –
(required) The OCID of the lifecycle stage.
- reboot_lifecycle_stage_details (oci.os_management_hub.models.RebootLifecycleStageDetails) – (required) Details rebooting managed instances in a lifecycle stage.
- 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
reboot_lifecycle_stage() - 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
- lifecycle_stage_id (str) –
-
update_lifecycle_environment_and_wait_for_state(lifecycle_environment_id, update_lifecycle_environment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_lifecycle_environment()and waits for theLifecycleEnvironmentacted upon to enter the given state(s).Parameters: - lifecycle_environment_id (str) –
(required) The OCID of the lifecycle environment.
- update_lifecycle_environment_details (oci.os_management_hub.models.UpdateLifecycleEnvironmentDetails) – (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_lifecycle_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
- lifecycle_environment_id (str) –
-