ChannelsClientCompositeOperations

class oci.mysql.ChannelsClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around ChannelsClient 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[, work_request_clients])	Creates a new ChannelsClientCompositeOperations object
create_channel_and_wait_for_state(...[, ...])	Calls create_channel() and waits for the WorkRequest to enter the given state(s).
delete_channel_and_wait_for_state(channel_id)	Calls delete_channel() and waits for the WorkRequest to enter the given state(s).
generate_channel_status_and_wait_for_state(...)	Calls generate_channel_status() and waits for the WorkRequest to enter the given state(s).
reset_channel_and_wait_for_state(channel_id)	Calls reset_channel() and waits for the WorkRequest to enter the given state(s).
resume_channel_and_wait_for_state(channel_id)	Calls resume_channel() and waits for the WorkRequest to enter the given state(s).
update_channel_and_wait_for_state(...[, ...])	Calls update_channel() and waits for the WorkRequest to enter the given state(s).

__init__(client, work_request_clients=None, **kwargs)

Creates a new ChannelsClientCompositeOperations object

Parameters

• client (ChannelsClient) – The service client which will be wrapped by this object

• work_request_clients (dict) –

  (optional) Service-local clients keyed by generated client class name, for example {'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.

  Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.

  Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.

create_channel_and_wait_for_state(create_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_channel() and waits for the WorkRequest to enter the given state(s).

Parameters

• create_channel_details (oci.mysql.models.CreateChannelDetails) – (required) The parameters of the request to create the Channel.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_channel()

• 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_channel_and_wait_for_state(channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_channel() and waits for the WorkRequest to enter the given state(s).

Parameters

• channel_id (str) –

  (required) The Channel OCID.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_channel()

• 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

generate_channel_status_and_wait_for_state(channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls generate_channel_status() and waits for the WorkRequest to enter the given state(s).

Parameters

• channel_id (str) –

  (required) The Channel OCID.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to generate_channel_status()

• 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

reset_channel_and_wait_for_state(channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls reset_channel() and waits for the WorkRequest to enter the given state(s).

Parameters

• channel_id (str) –

  (required) The Channel OCID.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to reset_channel()

• 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

resume_channel_and_wait_for_state(channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls resume_channel() and waits for the WorkRequest to enter the given state(s).

Parameters

• channel_id (str) –

  (required) The Channel OCID.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to resume_channel()

• 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_channel_and_wait_for_state(channel_id, update_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_channel() and waits for the WorkRequest to enter the given state(s).

Parameters

• channel_id (str) –

  (required) The Channel OCID.

• update_channel_details (oci.mysql.models.UpdateChannelDetails) – (required) The parameters of the request to update the Channel.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_channel()

• 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