ManagementAgentClientCompositeOperations

class oci.management_agent.ManagementAgentClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ManagementAgentClient 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 ManagementAgentClientCompositeOperations object
create_data_source_and_wait_for_state(…[, …]) Calls create_data_source() and waits for the WorkRequest to enter the given state(s).
create_management_agent_install_key_and_wait_for_state(…) Calls create_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).
delete_data_source_and_wait_for_state(…[, …]) Calls delete_data_source() and waits for the WorkRequest to enter the given state(s).
delete_management_agent_and_wait_for_state(…) Calls delete_management_agent() and waits for the ManagementAgent acted upon to enter the given state(s).
delete_management_agent_install_key_and_wait_for_state(…) Calls delete_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).
deploy_plugins_and_wait_for_state(…[, …]) Calls deploy_plugins() and waits for the WorkRequest to enter the given state(s).
update_data_source_and_wait_for_state(…[, …]) Calls update_data_source() and waits for the WorkRequest to enter the given state(s).
update_management_agent_and_wait_for_state(…) Calls update_management_agent() and waits for the ManagementAgent acted upon to enter the given state(s).
update_management_agent_install_key_and_wait_for_state(…) Calls update_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new ManagementAgentClientCompositeOperations object

Parameters:client (ManagementAgentClient) – The service client which will be wrapped by this object
create_data_source_and_wait_for_state(management_agent_id, create_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • management_agent_id (str) – (required) Unique Management Agent identifier
  • create_data_source_details (oci.management_agent.models.CreateDataSourceDetails) – (required) Details of DataSource to be created for the given Management Agent.
  • 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_data_source()
  • 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_management_agent_install_key_and_wait_for_state(create_management_agent_install_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:
  • create_management_agent_install_key_details (oci.management_agent.models.CreateManagementAgentInstallKeyDetails) – (required) Details of the Agent install Key
  • 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_management_agent_install_key()
  • 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_data_source_and_wait_for_state(management_agent_id, data_source_key, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • management_agent_id (str) – (required) Unique Management Agent identifier
  • data_source_key (str) – (required) Data source type and name 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_data_source()
  • 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_management_agent_and_wait_for_state(management_agent_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_management_agent() and waits for the ManagementAgent acted upon to enter the given state(s).

Parameters:
  • management_agent_id (str) – (required) Unique Management Agent identifier
  • 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_management_agent()
  • 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_management_agent_install_key_and_wait_for_state(management_agent_install_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:
  • management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier
  • 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_management_agent_install_key()
  • 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
deploy_plugins_and_wait_for_state(deploy_plugins_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • deploy_plugins_details (oci.management_agent.models.DeployPluginsDetails) – (required) Details of Plugins to be deployed for a given list of Management Agents.
  • 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 deploy_plugins()
  • 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_data_source_and_wait_for_state(management_agent_id, data_source_key, update_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • management_agent_id (str) – (required) Unique Management Agent identifier
  • data_source_key (str) – (required) Data source type and name identifier.
  • update_data_source_details (oci.management_agent.models.UpdateDataSourceDetails) – (required) Details of DataSource to be update for the given Management Agent.
  • 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_data_source()
  • 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_management_agent_and_wait_for_state(management_agent_id, update_management_agent_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_management_agent() and waits for the ManagementAgent acted upon to enter the given state(s).

Parameters:
  • management_agent_id (str) – (required) Unique Management Agent identifier
  • update_management_agent_details (oci.management_agent.models.UpdateManagementAgentDetails) – (required) Details required for changing the console managed properties of the Management Agent.
  • 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_management_agent()
  • 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_management_agent_install_key_and_wait_for_state(management_agent_install_key_id, update_management_agent_install_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_management_agent_install_key() and waits for the ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:
  • management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier
  • update_management_agent_install_key_details (oci.management_agent.models.UpdateManagementAgentInstallKeyDetails) – (required) Details required for changing the modifiable properties of the Management Agent install key.
  • 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_management_agent_install_key()
  • 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