StreamAdminClientCompositeOperations

class oci.streaming.StreamAdminClientCompositeOperations(client, **kwargs)

This class provides a wrapper around StreamAdminClient 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 StreamAdminClientCompositeOperations object
create_connect_harness_and_wait_for_state(…) Calls create_connect_harness() and waits for the ConnectHarness acted upon to enter the given state(s).
create_stream_and_wait_for_state(…[, …]) Calls create_stream() and waits for the Stream acted upon to enter the given state(s).
create_stream_pool_and_wait_for_state(…[, …]) Calls create_stream_pool() and waits for the StreamPool acted upon to enter the given state(s).
delete_connect_harness_and_wait_for_state(…) Calls delete_connect_harness() and waits for the ConnectHarness acted upon to enter the given state(s).
delete_stream_and_wait_for_state(stream_id) Calls delete_stream() and waits for the Stream acted upon to enter the given state(s).
delete_stream_pool_and_wait_for_state(…[, …]) Calls delete_stream_pool() and waits for the StreamPool acted upon to enter the given state(s).
update_connect_harness_and_wait_for_state(…) Calls update_connect_harness() and waits for the ConnectHarness acted upon to enter the given state(s).
update_stream_and_wait_for_state(stream_id, …) Calls update_stream() and waits for the Stream acted upon to enter the given state(s).
update_stream_pool_and_wait_for_state(…[, …]) Calls update_stream_pool() and waits for the StreamPool acted upon to 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
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 the ConnectHarness acted upon to enter the given state(s).

Parameters:
  • create_connect_harness_details (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 lifecycle_state
  • operation_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 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_stream_and_wait_for_state(create_stream_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_stream() and waits for the Stream acted upon to enter the given state(s).

Parameters:
  • create_stream_details (CreateStreamDetails) – (required) The stream to create.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_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 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_stream_pool_and_wait_for_state(create_stream_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_stream_pool() and waits for the StreamPool acted upon to enter the given state(s).

Parameters:
  • create_stream_pool_details (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 lifecycle_state
  • operation_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 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_connect_harness_and_wait_for_state(connect_harness_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_connect_harness() and waits for the ConnectHarness acted upon to 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 lifecycle_state
  • operation_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 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_stream_and_wait_for_state(stream_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_stream() and waits for the Stream acted upon to 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 lifecycle_state
  • operation_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 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_stream_pool_and_wait_for_state(stream_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_stream_pool() and waits for the StreamPool acted upon to 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 lifecycle_state
  • operation_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 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_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 the ConnectHarness acted upon to enter the given state(s).

Parameters:
  • connect_harness_id (str) – (required) The OCID of the connect harness.
  • update_connect_harness_details (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 lifecycle_state
  • operation_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 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_stream_and_wait_for_state(stream_id, update_stream_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_stream() and waits for the Stream acted upon to enter the given state(s).

Parameters:
  • stream_id (str) – (required) The OCID of the stream.
  • update_stream_details (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 lifecycle_state
  • operation_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 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_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 the StreamPool acted upon to enter the given state(s).

Parameters:
  • stream_pool_id (str) – (required) The OCID of the stream pool.
  • update_stream_pool_details (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 lifecycle_state
  • operation_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 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