AnalyticsClientCompositeOperations¶
- class oci.analytics.AnalyticsClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
AnalyticsClientand 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
change_analytics_instance_compartment_and_wait_for_state(...)Calls
change_analytics_instance_compartment()and waits for theWorkRequestto enter the given state(s).change_analytics_instance_network_endpoint_and_wait_for_state(...)Calls
change_analytics_instance_network_endpoint()and waits for theWorkRequestto enter the given state(s).Calls
create_analytics_instance()and waits for theWorkRequestto enter the given state(s).Calls
create_private_access_channel()and waits for theWorkRequestto enter the given state(s).Calls
create_resource_group()and waits for theWorkRequestto enter the given state(s).create_vanity_url_and_wait_for_state(...[, ...])Calls
create_vanity_url()and waits for theWorkRequestto enter the given state(s).Calls
delete_analytics_instance()and waits for theWorkRequestto enter the given state(s).Calls
delete_private_access_channel()and waits for theWorkRequestto enter the given state(s).Calls
delete_resource_group()and waits for theWorkRequestto enter the given state(s).delete_vanity_url_and_wait_for_state(...[, ...])Calls
delete_vanity_url()and waits for theWorkRequestto enter the given state(s).Calls
scale_analytics_instance()and waits for theWorkRequestto enter the given state(s).set_feature_bundle_and_wait_for_state(...[, ...])Calls
set_feature_bundle()and waits for theWorkRequestto enter the given state(s).set_kms_key_and_wait_for_state(...[, ...])Calls
set_kms_key()and waits for theWorkRequestto enter the given state(s).Calls
start_analytics_instance()and waits for theWorkRequestto enter the given state(s).Calls
stop_analytics_instance()and waits for theWorkRequestto enter the given state(s).Calls
update_analytics_instance()and waits for theAnalyticsInstanceacted upon to enter the given state(s).Calls
update_private_access_channel()and waits for theWorkRequestto enter the given state(s).Calls
update_resource_group()and waits for theWorkRequestto enter the given state(s).update_vanity_url_and_wait_for_state(...[, ...])Calls
update_vanity_url()and waits for theWorkRequestto enter the given state(s).- __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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
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
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
change_analytics_instance_network_endpoint_details (oci.analytics.models.ChangeAnalyticsInstanceNetworkEndpointDetails) – (required) Input payload for changing a network endpoint for an Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto 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
statusoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_private_access_channel_and_wait_for_state(analytics_instance_id, create_private_access_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_private_access_channel()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
create_private_access_channel_details (oci.analytics.models.CreatePrivateAccessChannelDetails) – (required) Input payload for creating a private access channel for an Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_private_access_channel()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_resource_group_and_wait_for_state(analytics_instance_id, create_resource_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_resource_group()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
create_resource_group_details (oci.analytics.models.CreateResourceGroupDetails) – (required) Resource group details
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_resource_group()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_vanity_url_and_wait_for_state(analytics_instance_id, create_vanity_url_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_vanity_url()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
create_vanity_url_details (oci.analytics.models.CreateVanityUrlDetails) – (required) Vanity URL details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_vanity_url()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas 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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_private_access_channel_and_wait_for_state(private_access_channel_key, analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_private_access_channel()and waits for theWorkRequestto enter the given state(s).- Parameters
private_access_channel_key (str) – (required) The unique identifier key of the private access channel.
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_private_access_channel()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_resource_group_and_wait_for_state(analytics_instance_id, analytics_instance_resource_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_resource_group()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
analytics_instance_resource_group_id (str) – (required) Specify unique id of a resource group within an Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_resource_group()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_vanity_url_and_wait_for_state(analytics_instance_id, vanity_url_key, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_vanity_url()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
vanity_url_key (str) – (required) Specify unique identifier key of a vanity URL to update or delete.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_vanity_url()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas 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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
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
statusoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- set_feature_bundle_and_wait_for_state(analytics_instance_id, set_feature_bundle_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
set_feature_bundle()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
set_feature_bundle_details (oci.analytics.models.SetFeatureBundleDetails) – (required) Input payload for the feature set of an Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
set_feature_bundle()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- set_kms_key_and_wait_for_state(analytics_instance_id, set_kms_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
set_kms_key()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
set_kms_key_details (oci.analytics.models.SetKmsKeyDetails) – (required) Input payload to reset the OCI vault encryption key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
set_kms_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas 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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_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_secondsormax_interval_secondsas 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 theAnalyticsInstanceacted upon to enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
update_analytics_instance_details (oci.analytics.models.UpdateAnalyticsInstanceDetails) –
(required) Update specified fields for an Analytics instance. Fields that aren’t provided
won’t be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_private_access_channel_and_wait_for_state(private_access_channel_key, analytics_instance_id, update_private_access_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_private_access_channel()and waits for theWorkRequestto enter the given state(s).- Parameters
private_access_channel_key (str) – (required) The unique identifier key of the private access channel.
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
update_private_access_channel_details (oci.analytics.models.UpdatePrivateAccessChannelDetails) – (required) Update the private access channel with the given unique identifier key in the specified Analytics instance.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_private_access_channel()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_resource_group_and_wait_for_state(analytics_instance_id, analytics_instance_resource_group_id, update_resource_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_resource_group()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
analytics_instance_resource_group_id (str) – (required) Specify unique id of a resource group within an Analytics instance.
update_resource_group_details (oci.analytics.models.UpdateResourceGroupDetails) – (required) Resource group details to update (certificate).
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_resource_group()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_vanity_url_and_wait_for_state(analytics_instance_id, vanity_url_key, update_vanity_url_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_vanity_url()and waits for theWorkRequestto enter the given state(s).- Parameters
analytics_instance_id (str) – (required) The OCID of the Analytics instance.
vanity_url_key (str) – (required) Specify unique identifier key of a vanity URL to update or delete.
update_vanity_url_details (oci.analytics.models.UpdateVanityUrlDetails) – (required) Vanity URL details to update (certificate).
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_vanity_url()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait