QueueAdminClientCompositeOperations

class oci.queue.QueueAdminClientCompositeOperations(client, **kwargs)

This class provides a wrapper around QueueAdminClient 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 QueueAdminClientCompositeOperations object
change_queue_compartment_and_wait_for_state(...)	Calls change_queue_compartment() and waits for the WorkRequest to enter the given state(s).
create_consumer_group_and_wait_for_state(...)	Calls create_consumer_group() and waits for the WorkRequest to enter the given state(s).
create_queue_and_wait_for_state(...[, ...])	Calls create_queue() and waits for the WorkRequest to enter the given state(s).
delete_consumer_group_and_wait_for_state(...)	Calls delete_consumer_group() and waits for the WorkRequest to enter the given state(s).
delete_queue_and_wait_for_state(queue_id[, ...])	Calls delete_queue() and waits for the WorkRequest to enter the given state(s).
purge_queue_and_wait_for_state(queue_id, ...)	Calls purge_queue() and waits for the WorkRequest to enter the given state(s).
update_consumer_group_and_wait_for_state(...)	Calls update_consumer_group() and waits for the WorkRequest to enter the given state(s).
update_queue_and_wait_for_state(queue_id, ...)	Calls update_queue() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new QueueAdminClientCompositeOperations object

Parameters

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

change_queue_compartment_and_wait_for_state(queue_id, change_queue_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• queue_id (str) – (required) The unique queue identifier.

• change_queue_compartment_details (oci.queue.models.ChangeQueueCompartmentDetails) – (required) The information to be updated.

• 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 change_queue_compartment()

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

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

Parameters

• create_consumer_group_details (oci.queue.models.CreateConsumerGroupDetails) – (required) Details for the new consumer group.

• 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_consumer_group()

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

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

Parameters

• create_queue_details (oci.queue.models.CreateQueueDetails) – (required) Details for the new Queue.

• 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_queue()

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

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

Parameters

• consumer_group_id (str) – (required) The unique consumer group identifier.

• 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_consumer_group()

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

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

Parameters

• queue_id (str) – (required) The unique queue identifier.

• 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_queue()

• 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

purge_queue_and_wait_for_state(queue_id, purge_queue_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• queue_id (str) – (required) The unique queue identifier.

• purge_queue_details (oci.queue.models.PurgeQueueDetails) – (required) The information to be updated.

• 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 purge_queue()

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

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

Parameters

• consumer_group_id (str) – (required) The unique consumer group identifier.

• update_consumer_group_details (oci.queue.models.UpdateConsumerGroupDetails) – (required) The information to be updated.

• 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_consumer_group()

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

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

Parameters

• queue_id (str) – (required) The unique queue identifier.

• update_queue_details (oci.queue.models.UpdateQueueDetails) – (required) The information to be updated.

• 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_queue()

• 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