StreamAdminClientCompositeOperations¶
- class oci.streaming.StreamAdminClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
StreamAdminClientand 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 StreamAdminClientCompositeOperations object
Calls
change_connect_harness_compartment()and waits for theWorkRequestto enter the given state(s).Calls
change_stream_compartment()and waits for theWorkRequestto enter the given state(s).Calls
change_stream_pool_compartment()and waits for theWorkRequestto enter the given state(s).Calls
create_connect_harness()and waits for theWorkRequestto enter the given state(s).create_stream_and_wait_for_state(...[, ...])Calls
create_stream()and waits for theWorkRequestto enter the given state(s).create_stream_pool_and_wait_for_state(...[, ...])Calls
create_stream_pool()and waits for theWorkRequestto enter the given state(s).Calls
delete_connect_harness()and waits for theWorkRequestto enter the given state(s).delete_stream_and_wait_for_state(stream_id)Calls
delete_stream()and waits for theWorkRequestto enter the given state(s).delete_stream_pool_and_wait_for_state(...[, ...])Calls
delete_stream_pool()and waits for theWorkRequestto enter the given state(s).Calls
update_connect_harness()and waits for theWorkRequestto enter the given state(s).update_stream_and_wait_for_state(stream_id, ...)Calls
update_stream()and waits for theWorkRequestto enter the given state(s).update_stream_pool_and_wait_for_state(...[, ...])Calls
update_stream_pool()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new StreamAdminClientCompositeOperations object
- Parameters
client (StreamAdminClient) – The service client which will be wrapped by this object
- change_connect_harness_compartment_and_wait_for_state(connect_harness_id, change_connect_harness_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_connect_harness_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
connect_harness_id (str) – (required) The OCID of the connect harness.
change_connect_harness_compartment_details (oci.streaming.models.ChangeConnectHarnessCompartmentDetails) – (required) The connect harness will be moved into the compartment specified within this entity.
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_connect_harness_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_stream_compartment_and_wait_for_state(stream_id, change_stream_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_stream_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_id (str) – (required) The OCID of the stream.
change_stream_compartment_details (oci.streaming.models.ChangeStreamCompartmentDetails) – (required) The stream will be moved into the compartment specified within this entity.
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_stream_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_stream_pool_compartment_and_wait_for_state(stream_pool_id, change_stream_pool_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_stream_pool_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_pool_id (str) – (required) The OCID of the stream pool.
change_stream_pool_compartment_details (oci.streaming.models.ChangeStreamPoolCompartmentDetails) – (required) The stream pool will be moved into the compartment specified within this entity.
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_stream_pool_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
- create_connect_harness_and_wait_for_state(create_connect_harness_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_connect_harness()and waits for theWorkRequestto enter the given state(s).- Parameters
create_connect_harness_details (oci.streaming.models.CreateConnectHarnessDetails) – (required) The connect harness to create.
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_connect_harness()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_stream_and_wait_for_state(create_stream_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_stream()and waits for theWorkRequestto enter the given state(s).- Parameters
create_stream_details (oci.streaming.models.CreateStreamDetails) – (required) The stream to create.
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_stream()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_stream_pool_and_wait_for_state(create_stream_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_stream_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
create_stream_pool_details (oci.streaming.models.CreateStreamPoolDetails) – (required) The stream pool to create.
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_stream_pool()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_connect_harness_and_wait_for_state(connect_harness_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_connect_harness()and waits for theWorkRequestto enter the given state(s).- Parameters
connect_harness_id (str) – (required) The OCID of the connect harness.
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_connect_harness()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_stream_and_wait_for_state(stream_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_stream()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_id (str) – (required) The OCID of the stream.
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_stream()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_stream_pool_and_wait_for_state(stream_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_stream_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_pool_id (str) – (required) The OCID of the stream pool.
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_stream_pool()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_connect_harness_and_wait_for_state(connect_harness_id, update_connect_harness_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_connect_harness()and waits for theWorkRequestto enter the given state(s).- Parameters
connect_harness_id (str) – (required) The OCID of the connect harness.
update_connect_harness_details (oci.streaming.models.UpdateConnectHarnessDetails) – (required) The connect harness is updated with the tags provided.
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_connect_harness()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_stream_and_wait_for_state(stream_id, update_stream_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_stream()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_id (str) – (required) The OCID of the stream.
update_stream_details (oci.streaming.models.UpdateStreamDetails) – (required) The stream is updated with the values provided.
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_stream()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_stream_pool_and_wait_for_state(stream_pool_id, update_stream_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_stream_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
stream_pool_id (str) – (required) The OCID of the stream pool.
update_stream_pool_details (oci.streaming.models.UpdateStreamPoolDetails) – (required) The pool is updated with the provided fields.
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_stream_pool()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