PurgeQueueDetails¶

class oci.queue.models.PurgeQueueDetails(**kwargs)¶

Bases: object

Purge parameters.

Attributes

`PURGE_TYPE_BOTH`	A constant which can be used with the purge_type property of a PurgeQueueDetails.
`PURGE_TYPE_DLQ`	A constant which can be used with the purge_type property of a PurgeQueueDetails.
`PURGE_TYPE_NORMAL`	A constant which can be used with the purge_type property of a PurgeQueueDetails.
`channel_ids`	Gets the channel_ids of this PurgeQueueDetails.
`purge_type`	[Required] Gets the purge_type of this PurgeQueueDetails.

Methods

__init__(**kwargs) Initializes a new PurgeQueueDetails object with values from keyword arguments.

PURGE_TYPE_BOTH = 'BOTH'¶: A constant which can be used with the purge_type property of a PurgeQueueDetails. This constant has a value of “BOTH”

PURGE_TYPE_DLQ = 'DLQ'¶: A constant which can be used with the purge_type property of a PurgeQueueDetails. This constant has a value of “DLQ”

PURGE_TYPE_NORMAL = 'NORMAL'¶: A constant which can be used with the purge_type property of a PurgeQueueDetails. This constant has a value of “NORMAL”

__init__(**kwargs)¶

Initializes a new PurgeQueueDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	purge_type (str) – The value to assign to the purge_type property of this PurgeQueueDetails. Allowed values for this property are: “NORMAL”, “DLQ”, “BOTH” channel_ids (list[str]) – The value to assign to the channel_ids property of this PurgeQueueDetails.

channel_ids¶

Gets the channel_ids of this PurgeQueueDetails. Optional parameter to specify the destination of purge operation. If the channel ID is specified, the purge operation will delete all the messages in the specific channels. If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.

Returns:	The channel_ids of this PurgeQueueDetails.
Return type:	list[str]

purge_type¶

[Required] Gets the purge_type of this PurgeQueueDetails. Type of the purge to perform: - NORMAL - purge only the normal queue - DLQ - purge only the dead letter queue - BOTH - purge both the normal queue and the dead letter queue

Allowed values for this property are: “NORMAL”, “DLQ”, “BOTH”

Returns:	The purge_type of this PurgeQueueDetails.
Return type:	str