ObjectStorageClientCompositeOperations¶
- class oci.object_storage.ObjectStorageClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
ObjectStorageClientand 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 ObjectStorageClientCompositeOperations object
copy_object_and_wait_for_state(...[, ...])Calls
copy_object()and waits for theWorkRequestto enter the given state(s).Calls
create_private_endpoint()and waits for theWorkRequestto enter the given state(s).Calls
delete_private_endpoint()and waits for theWorkRequestto enter the given state(s).reencrypt_bucket_and_wait_for_state(...[, ...])Calls
reencrypt_bucket()and waits for theWorkRequestto enter the given state(s).Calls
update_private_endpoint()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new ObjectStorageClientCompositeOperations object
- Parameters
client (ObjectStorageClient) – The service client which will be wrapped by this object
- copy_object_and_wait_for_state(namespace_name, bucket_name, copy_object_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
copy_object()and waits for theWorkRequestto enter the given state(s).- Parameters
namespace_name (str) – (required) The Object Storage namespace used for the request.
bucket_name (str) – (required) The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
copy_object_details (oci.object_storage.models.CopyObjectDetails) – (required) The source and destination of the object to be copied.
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
copy_object()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_endpoint_and_wait_for_state(namespace_name, create_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
namespace_name (str) – (required) The Object Storage namespace used for the request.
create_private_endpoint_details (oci.object_storage.models.CreatePrivateEndpointDetails) – (required) Details to create a private endpoint.
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_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
- delete_private_endpoint_and_wait_for_state(namespace_name, pe_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
namespace_name (str) – (required) The Object Storage namespace used for the request.
pe_name (str) – (required) The name of the private endpoint. Avoid entering confidential information. Example: my-new-pe-1
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_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
- reencrypt_bucket_and_wait_for_state(namespace_name, bucket_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
reencrypt_bucket()and waits for theWorkRequestto enter the given state(s).- Parameters
namespace_name (str) – (required) The Object Storage namespace used for the request.
bucket_name (str) – (required) The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
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
reencrypt_bucket()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_endpoint_and_wait_for_state(namespace_name, pe_name, update_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
namespace_name (str) – (required) The Object Storage namespace used for the request.
pe_name (str) – (required) The name of the private endpoint. Avoid entering confidential information. Example: my-new-pe-1
update_private_endpoint_details (oci.object_storage.models.UpdatePrivateEndpointDetails) – (required) Request object for updating the Private Endpoint.
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_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