OnboardingClientCompositeOperations

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

This class provides a wrapper around OnboardingClient 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 OnboardingClientCompositeOperations object
create_profile_and_wait_for_state(…[, …])	Calls create_profile() and waits for the Profile acted upon to enter the given state(s).
delete_profile_and_wait_for_state(profile_id)	Calls delete_profile() and waits for the Profile acted upon to enter the given state(s).
update_profile_and_wait_for_state(…[, …])	Calls update_profile() and waits for the Profile acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new OnboardingClientCompositeOperations object

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

create_profile_and_wait_for_state(create_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_profile() and waits for the Profile acted upon to enter the given state(s).

Parameters:

• create_profile_details (oci.os_management_hub.models.CreateProfileDetails) – (required) Provides the information used to create the registration 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_profile()
• 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_profile_and_wait_for_state(profile_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_profile() and waits for the Profile acted upon to enter the given state(s).

Parameters:

• profile_id (str) –

  (required) The OCID of the registration 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_profile()
• 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_profile_and_wait_for_state(profile_id, update_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_profile() and waits for the Profile acted upon to enter the given state(s).

Parameters:

• profile_id (str) –

  (required) The OCID of the registration profile.

• update_profile_details (oci.os_management_hub.models.UpdateProfileDetails) – (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_profile()
• 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