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

__init__(client, **kwargs)

Creates a new StreamAdminClientCompositeOperations object

Parameters:client (StreamAdminClient) -- The service client which will be wrapped by this object
create_archiver_and_wait_for_state(stream_id, create_archiver_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_archiver() and waits for the Archiver acted upon to enter the given state(s).

Parameters:
  • stream_id (str) -- (required) The OCID of the stream.
  • create_archiver_details (CreateArchiverDetails) -- (required) A stream archiver parameters 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_archiver()
  • 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
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 to delete.
  • 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
start_archiver_and_wait_for_state(stream_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_archiver() and waits for the Archiver 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 start_archiver()
  • 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
stop_archiver_and_wait_for_state(stream_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_archiver() and waits for the Archiver 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 stop_archiver()
  • 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_archiver_and_wait_for_state(stream_id, update_archiver_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_archiver() and waits for the Archiver acted upon to enter the given state(s).

Parameters:
  • stream_id (str) -- (required) The OCID of the stream.
  • update_archiver_details (UpdateArchiverDetails) -- (required) The new parameters of the stream archiver.
  • 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_archiver()
  • 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 to update.
  • update_stream_details (UpdateStreamDetails) -- (required) The stream 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_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