Package com.oracle.bmc.queue.model

Class PurgeQueueDetails.Builder

java.lang.Object

com.oracle.bmc.queue.model.PurgeQueueDetails.Builder

Enclosing class:

PurgeQueueDetails

public static class PurgeQueueDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PurgeQueueDetails	build()
PurgeQueueDetails.Builder	channelIds(List<String> channelIds)	Optional parameter to specify the destination of purge operation.
PurgeQueueDetails.Builder	consumerGroupId(String consumerGroupId)	The consumer group ID to purge.
PurgeQueueDetails.Builder	copy(PurgeQueueDetails model)
PurgeQueueDetails.Builder	purgeType(PurgeQueueDetails.PurgeType purgeType)	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

purgeType

public PurgeQueueDetails.Builder purgeType(PurgeQueueDetails.PurgeType purgeType)

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

Parameters:

purgeType - the value to set

Returns:

this builder

channelIds

public PurgeQueueDetails.Builder channelIds(List<String> channelIds)

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.

Parameters:

channelIds - the value to set

Returns:

this builder

consumerGroupId

public PurgeQueueDetails.Builder consumerGroupId(String consumerGroupId)

The consumer group ID to purge.

If the CONSUMER_GROUPS capability is enabled on the queue, omitting that field will purge the “Primary Consumer Group”, otherwise it will purge the queue. If you wish to purge all consumer groups in the queue, you can pass the special value ‘all’.

Parameters:

consumerGroupId - the value to set

Returns:

this builder

build

public PurgeQueueDetails build()

copy

public PurgeQueueDetails.Builder copy(PurgeQueueDetails model)