File: //lib/mysqlsh/lib/python3.8/site-packages/oci/nosql/nosql_client_composite_operations.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190828
import oci # noqa: F401
from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401
class NosqlClientCompositeOperations(object):
"""
This class provides a wrapper around :py:class:`~oci.nosql.NosqlClient` 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
"""
def __init__(self, client, **kwargs):
"""
Creates a new NosqlClientCompositeOperations object
:param NosqlClient client:
The service client which will be wrapped by this object
"""
self.client = client
def change_table_compartment_and_wait_for_state(self, table_name_or_id, change_table_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.change_table_compartment` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param oci.nosql.models.ChangeTableCompartmentDetails change_table_compartment_details: (required)
Specifications of the source and target compartments.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.change_table_compartment`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = self.client.change_table_compartment(table_name_or_id, change_table_compartment_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def create_index_and_wait_for_state(self, table_name_or_id, create_index_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.create_index` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param oci.nosql.models.CreateIndexDetails create_index_details: (required)
Specifications for the new index.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.create_index`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = self.client.create_index(table_name_or_id, create_index_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def create_replica_and_wait_for_state(self, table_name_or_id, create_replica_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.create_replica` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param oci.nosql.models.CreateReplicaDetails create_replica_details: (required)
Specifications for the new replica
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.create_replica`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = self.client.create_replica(table_name_or_id, create_replica_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def create_table_and_wait_for_state(self, create_table_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.create_table` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param oci.nosql.models.CreateTableDetails create_table_details: (required)
Specifications for the new table.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.create_table`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = self.client.create_table(create_table_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def delete_index_and_wait_for_state(self, table_name_or_id, index_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.delete_index` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param str index_name: (required)
The name of a table's index.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.delete_index`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = None
try:
operation_result = self.client.delete_index(table_name_or_id, index_name, **operation_kwargs)
except oci.exceptions.ServiceError as e:
if e.status == 404:
return WAIT_RESOURCE_NOT_FOUND
else:
raise e
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def delete_replica_and_wait_for_state(self, table_name_or_id, region, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.delete_replica` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param str region: (required)
A customer-facing region identifier
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.delete_replica`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = None
try:
operation_result = self.client.delete_replica(table_name_or_id, region, **operation_kwargs)
except oci.exceptions.ServiceError as e:
if e.status == 404:
return WAIT_RESOURCE_NOT_FOUND
else:
raise e
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def delete_table_and_wait_for_state(self, table_name_or_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.delete_table` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.delete_table`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = None
try:
operation_result = self.client.delete_table(table_name_or_id, **operation_kwargs)
except oci.exceptions.ServiceError as e:
if e.status == 404:
return WAIT_RESOURCE_NOT_FOUND
else:
raise e
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def delete_work_request_and_wait_for_state(self, work_request_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.delete_work_request` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str work_request_id: (required)
The ID of the asynchronous request.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.delete_work_request`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = None
try:
operation_result = self.client.delete_work_request(work_request_id, **operation_kwargs)
except oci.exceptions.ServiceError as e:
if e.status == 404:
return WAIT_RESOURCE_NOT_FOUND
else:
raise e
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
def update_table_and_wait_for_state(self, table_name_or_id, update_table_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.nosql.NosqlClient.update_table` and waits for the :py:class:`~oci.nosql.models.WorkRequest`
to enter the given state(s).
:param str table_name_or_id: (required)
A table name within the compartment, or a table OCID.
:param oci.nosql.models.UpdateTableDetails update_table_details: (required)
Specifications for the alteration.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.nosql.models.WorkRequest.status`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.nosql.NosqlClient.update_table`
:param dict waiter_kwargs:
A dictionary of keyword arguments to pass to the :py:func:`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
"""
operation_result = self.client.update_table(table_name_or_id, update_table_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
if 'opc-work-request-id' not in operation_result.headers:
return operation_result
wait_for_resource_id = operation_result.headers['opc-work-request-id']
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_work_request(wait_for_resource_id),
evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
**waiter_kwargs
)
result_to_return = waiter_result
return result_to_return
except Exception as e:
raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)