AnalyticsClientCompositeOperations¶
-
class
oci.analytics.
AnalyticsClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
AnalyticsClient
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 AnalyticsClientCompositeOperations object
Parameters: client (AnalyticsClient) – The service client which will be wrapped by this object
-
change_analytics_instance_compartment_and_wait_for_state
(analytics_instance_id, change_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_analytics_instance_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- change_compartment_details (oci.analytics.models.ChangeCompartmentDetails) – (required) Input payload to move the resource to a different 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_analytics_instance_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
-
change_analytics_instance_network_endpoint_and_wait_for_state
(analytics_instance_id, change_analytics_instance_network_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_analytics_instance_network_endpoint()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- change_analytics_instance_network_endpoint_details (oci.analytics.models.ChangeAnalyticsInstanceNetworkEndpointDetails) – (required) Input payload for changing an Analytics instance network endpoint.
- 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_analytics_instance_network_endpoint()
- 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_analytics_instance_and_wait_for_state
(create_analytics_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_analytics_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_analytics_instance_details (oci.analytics.models.CreateAnalyticsInstanceDetails) – (required) Analytics Instance 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_analytics_instance()
- 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_analytics_instance_and_wait_for_state
(analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_analytics_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- 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_analytics_instance()
- 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
-
scale_analytics_instance_and_wait_for_state
(analytics_instance_id, scale_analytics_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
scale_analytics_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- scale_analytics_instance_details (oci.analytics.models.ScaleAnalyticsInstanceDetails) – (required) Input payload for scaling an Analytics instance up or down.
- 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
scale_analytics_instance()
- 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
-
start_analytics_instance_and_wait_for_state
(analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_analytics_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- 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
start_analytics_instance()
- 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
-
stop_analytics_instance_and_wait_for_state
(analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_analytics_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- 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
stop_analytics_instance()
- 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_analytics_instance_and_wait_for_state
(analytics_instance_id, update_analytics_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_analytics_instance()
and waits for theAnalyticsInstance
acted upon to enter the given state(s).Parameters: - analytics_instance_id (str) – (required) The OCID of the AnalyticsInstance.
- update_analytics_instance_details (oci.analytics.models.UpdateAnalyticsInstanceDetails) – (required) The Analytics Instance fields to update. Fields that are not provided will not 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_analytics_instance()
- 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
-