Class PurgeQueueDetails

Purge parameters.

Inheritance

object

PurgeQueueDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.QueueService.Models

Assembly: OCI.DotNetSDK.Queue.dll

Syntax

public class PurgeQueueDetails

Properties

ChannelIds

Declaration

[JsonProperty(PropertyName = "channelIds")]
public List<string> ChannelIds { get; set; }

Property Value

Type	Description
List<string>	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.

ConsumerGroupId

Declaration

[JsonProperty(PropertyName = "consumerGroupId")]
public string ConsumerGroupId { get; set; }

Property Value

Type	Description
string	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'.

PurgeType

Declaration

[Required(ErrorMessage = "PurgeType is required.")]
[JsonProperty(PropertyName = "purgeType")]
[JsonConverter(typeof(StringEnumConverter))]
public PurgeQueueDetails.PurgeTypeEnum? PurgeType { get; set; }

Property Value

Type	Description
PurgeQueueDetails.PurgeTypeEnum?	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

Remarks

Required