LoggingManagementClientCompositeOperations

class oci.logging.LoggingManagementClientCompositeOperations(client, **kwargs)

This class provides a wrapper around LoggingManagementClient 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 LoggingManagementClientCompositeOperations object

change_log_group_compartment_and_wait_for_state(...)

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

change_log_log_group_and_wait_for_state(...)

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

change_unified_agent_configuration_compartment_and_wait_for_state(...)

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

create_log_and_wait_for_state(log_group_id, ...)

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

create_log_group_and_wait_for_state(...[, ...])

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

create_log_saved_search_and_wait_for_state(...)

Calls create_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

create_unified_agent_configuration_and_wait_for_state(...)

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

delete_log_and_wait_for_state(log_group_id, ...)

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

delete_log_group_and_wait_for_state(log_group_id)

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

delete_log_saved_search_and_wait_for_state(...)

Calls delete_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

delete_unified_agent_configuration_and_wait_for_state(...)

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

delete_work_request_and_wait_for_state(...)

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

update_log_and_wait_for_state(log_group_id, ...)

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

update_log_group_and_wait_for_state(...[, ...])

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

update_log_saved_search_and_wait_for_state(...)

Calls update_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

update_unified_agent_configuration_and_wait_for_state(...)

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

__init__(client, **kwargs)

Creates a new LoggingManagementClientCompositeOperations object

Parameters

client (LoggingManagementClient) – The service client which will be wrapped by this object

change_log_group_compartment_and_wait_for_state(log_group_id, change_log_group_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • change_log_group_compartment_details (oci.logging.models.ChangeLogGroupCompartmentDetails) – (required) Request to change the compartment of a given resource.

  • 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_log_group_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_log_log_group_and_wait_for_state(log_group_id, log_id, change_log_log_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • log_id (str) – (required) OCID of a log to work with.

  • change_log_log_group_details (oci.logging.models.ChangeLogLogGroupDetails) – (required) Request to change the log group of a given log.

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

  • 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_unified_agent_configuration_compartment_and_wait_for_state(unified_agent_configuration_id, change_unified_agent_configuration_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.

  • change_unified_agent_configuration_compartment_details (oci.logging.models.ChangeUnifiedAgentConfigurationCompartmentDetails) – (required) Request to change the compartment of a given resource.

  • 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_unified_agent_configuration_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_log_and_wait_for_state(log_group_id, create_log_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • create_log_details (oci.logging.models.CreateLogDetails) – (required) Log object configuration details.

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

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

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

Parameters
  • create_log_group_details (oci.logging.models.CreateLogGroupDetails) – (required) Details to create log group.

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

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

Calls create_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

Parameters
  • create_log_saved_search_details (oci.logging.models.CreateLogSavedSearchDetails) – (required) Specification of the saved search to create.

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

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

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

Parameters
  • create_unified_agent_configuration_details (oci.logging.models.CreateUnifiedAgentConfigurationDetails) – (required) Unified agent configuration creation object.

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

  • 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_log_and_wait_for_state(log_group_id, log_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • log_id (str) – (required) OCID of a log to work with.

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

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

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

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

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

Calls delete_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

Parameters
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch.

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

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

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

Parameters
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.

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

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

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

Parameters
  • work_request_id (str) – (required) The asynchronous request ID.

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

  • 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_log_and_wait_for_state(log_group_id, log_id, update_log_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • log_id (str) – (required) OCID of a log to work with.

  • update_log_details (oci.logging.models.UpdateLogDetails) – (required) Log config parameters to update.

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

  • 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_log_group_and_wait_for_state(log_group_id, update_log_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • log_group_id (str) – (required) OCID of a log group to work with.

  • update_log_group_details (oci.logging.models.UpdateLogGroupDetails) – (required) LogGroup config parameters to update.

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

  • 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_log_saved_search_and_wait_for_state(log_saved_search_id, update_log_saved_search_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_log_saved_search() and waits for the LogSavedSearch acted upon to enter the given state(s).

Parameters
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch.

  • update_log_saved_search_details (oci.logging.models.UpdateLogSavedSearchDetails) – (required) Updates to the saved search.

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

  • 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_unified_agent_configuration_and_wait_for_state(unified_agent_configuration_id, update_unified_agent_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.

  • update_unified_agent_configuration_details (oci.logging.models.UpdateUnifiedAgentConfigurationDetails) – (required) Unified agent configuration to update. Empty group associations list doesn’t modify the list, null value for group association clears all the previous associations.

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

  • 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