ApmDomainClientCompositeOperations¶
-
class
oci.apm_control_plane.
ApmDomainClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
ApmDomainClient
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 functionalityMethods
__init__
(client, **kwargs)Creates a new ApmDomainClientCompositeOperations object change_apm_domain_compartment_and_wait_for_state
(…)Calls change_apm_domain_compartment()
and waits for theWorkRequest
to enter the given state(s).create_apm_domain_and_wait_for_state
(…[, …])Calls create_apm_domain()
and waits for theWorkRequest
to enter the given state(s).delete_apm_domain_and_wait_for_state
(…[, …])Calls delete_apm_domain()
and waits for theWorkRequest
to enter the given state(s).generate_data_keys_and_wait_for_state
(…[, …])Calls generate_data_keys()
and waits for theWorkRequest
to enter the given state(s).remove_data_keys_and_wait_for_state
(…[, …])Calls remove_data_keys()
and waits for theWorkRequest
to enter the given state(s).update_apm_domain_and_wait_for_state
(…[, …])Calls update_apm_domain()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new ApmDomainClientCompositeOperations object
Parameters: client (ApmDomainClient) – The service client which will be wrapped by this object
-
change_apm_domain_compartment_and_wait_for_state
(apm_domain_id, change_apm_domain_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_apm_domain_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - apm_domain_id (str) – (required) The OCID of the APM domain.
- change_apm_domain_compartment_details (oci.apm_control_plane.models.ChangeApmDomainCompartmentDetails) – (required) The information to be used in changing 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_apm_domain_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_apm_domain_and_wait_for_state
(create_apm_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_apm_domain()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_apm_domain_details (oci.apm_control_plane.models.CreateApmDomainDetails) – (required) Details for the new APM domain.
- 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_apm_domain()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_apm_domain_and_wait_for_state
(apm_domain_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_apm_domain()
and waits for theWorkRequest
to enter the given state(s).Parameters: - apm_domain_id (str) – (required) The OCID of the APM domain.
- 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_apm_domain()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
generate_data_keys_and_wait_for_state
(generate_data_keys_list_details, apm_domain_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
generate_data_keys()
and waits for theWorkRequest
to enter the given state(s).Parameters: - generate_data_keys_list_details (list[GenerateDataKeyDetails]) – (required) List of new Data Keys to be generated.
- apm_domain_id (str) – (required) The OCID of the APM domain.
- 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
generate_data_keys()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
remove_data_keys_and_wait_for_state
(apm_domain_id, remove_data_keys_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_data_keys()
and waits for theWorkRequest
to enter the given state(s).Parameters: - apm_domain_id (str) – (required) The OCID of the APM domain.
- remove_data_keys_list_details (list[RemoveDataKeyDetails]) – (required) List of Data Keys to be removed.
- 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
remove_data_keys()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_apm_domain_and_wait_for_state
(apm_domain_id, update_apm_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_apm_domain()
and waits for theWorkRequest
to enter the given state(s).Parameters: - apm_domain_id (str) – (required) The OCID of the APM domain.
- update_apm_domain_details (oci.apm_control_plane.models.UpdateApmDomainDetails) – (required) The information to be updated for the APM domain.
- 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_apm_domain()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-