OpensearchClusterClientCompositeOperations

class oci.opensearch.OpensearchClusterClientCompositeOperations(client, **kwargs)

This class provides a wrapper around OpensearchClusterClient 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 OpensearchClusterClientCompositeOperations object
backup_opensearch_cluster_and_wait_for_state(…)	Calls backup_opensearch_cluster() and waits for the WorkRequest to enter the given state(s).
create_opensearch_cluster_and_wait_for_state(…)	Calls create_opensearch_cluster() and waits for the WorkRequest to enter the given state(s).
delete_opensearch_cluster_and_wait_for_state(…)	Calls delete_opensearch_cluster() and waits for the WorkRequest to enter the given state(s).
opensearch_cluster_restore_and_wait_for_state(…)	Calls opensearch_cluster_restore() and waits for the WorkRequest to enter the given state(s).
resize_opensearch_cluster_horizontal_and_wait_for_state(…)	Calls resize_opensearch_cluster_horizontal() and waits for the WorkRequest to enter the given state(s).
resize_opensearch_cluster_vertical_and_wait_for_state(…)	Calls resize_opensearch_cluster_vertical() and waits for the WorkRequest to enter the given state(s).
update_opensearch_cluster_and_wait_for_state(…)	Calls update_opensearch_cluster() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new OpensearchClusterClientCompositeOperations object

Parameters:client (OpensearchClusterClient) – The service client which will be wrapped by this object

backup_opensearch_cluster_and_wait_for_state(opensearch_cluster_id, backup_opensearch_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster identifier
• backup_opensearch_cluster_details (oci.opensearch.models.BackupOpensearchClusterDetails) – (required) Backup the opensearch cluster 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 backup_opensearch_cluster()
• 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_opensearch_cluster_and_wait_for_state(create_opensearch_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_opensearch_cluster_details (oci.opensearch.models.CreateOpensearchClusterDetails) – (required) Details for the new OpensearchCluster.
• 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_opensearch_cluster()
• 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_opensearch_cluster_and_wait_for_state(opensearch_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster 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_opensearch_cluster()
• 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

opensearch_cluster_restore_and_wait_for_state(opensearch_cluster_id, restore_opensearch_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster identifier
• restore_opensearch_cluster_details (oci.opensearch.models.RestoreOpensearchClusterDetails) – (required) Restore the opensearch cluster 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 opensearch_cluster_restore()
• 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

resize_opensearch_cluster_horizontal_and_wait_for_state(opensearch_cluster_id, resize_opensearch_cluster_horizontal_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster identifier
• resize_opensearch_cluster_horizontal_details (oci.opensearch.models.ResizeOpensearchClusterHorizontalDetails) – (required) Resize the opensearch cluster horizontal 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 resize_opensearch_cluster_horizontal()
• 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

resize_opensearch_cluster_vertical_and_wait_for_state(opensearch_cluster_id, resize_opensearch_cluster_vertical_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster identifier
• resize_opensearch_cluster_vertical_details (oci.opensearch.models.ResizeOpensearchClusterVerticalDetails) – (required) Resize the opensearch cluster vertical 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 resize_opensearch_cluster_vertical()
• 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_opensearch_cluster_and_wait_for_state(opensearch_cluster_id, update_opensearch_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• opensearch_cluster_id (str) – (required) unique OpensearchCluster identifier
• update_opensearch_cluster_details (oci.opensearch.models.UpdateOpensearchClusterDetails) – (required) Update the opensearch cluster 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 update_opensearch_cluster()
• 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