Class Queue

A detailed representation of a queue and its configuration.

Inheritance
object
Queue
Inherited Members
Namespace: Oci.QueueService.Models
Assembly: OCI.DotNetSDK.Queue.dll
Syntax
public class Queue

Properties

ChannelConsumptionLimit

Declaration
[JsonProperty(PropertyName = "channelConsumptionLimit")]
public int? ChannelConsumptionLimit { get; set; }
Property Value
Type Description
int?

The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment containing the queue.
Remarks

Required

CustomEncryptionKeyId

Declaration
[JsonProperty(PropertyName = "customEncryptionKeyId")]
public string CustomEncryptionKeyId { get; set; }
Property Value
Type Description
string

The OCID of the custom encryption key to be used to encrypt messages content.

DeadLetterQueueDeliveryCount

Declaration
[Required(ErrorMessage = "DeadLetterQueueDeliveryCount is required.")]
[JsonProperty(PropertyName = "deadLetterQueueDeliveryCount")]
public int? DeadLetterQueueDeliveryCount { get; set; }
Property Value
Type Description
int?

The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

A unique identifier for the queue that is immutable on creation.
Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Any additional details about the current state of the queue.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Queue.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Queue.LifecycleStateEnum?

The current state of the queue.
Remarks

Required

MessagesEndpoint

Declaration
[Required(ErrorMessage = "MessagesEndpoint is required.")]
[JsonProperty(PropertyName = "messagesEndpoint")]
public string MessagesEndpoint { get; set; }
Property Value
Type Description
string

The endpoint to use to consume or publish messages in the queue.
Remarks

Required

RetentionInSeconds

Declaration
[Required(ErrorMessage = "RetentionInSeconds is required.")]
[JsonProperty(PropertyName = "retentionInSeconds")]
public int? RetentionInSeconds { get; set; }
Property Value
Type Description
int?

The retention period of the messages in the queue, in seconds.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The time that the queue was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The time that the queue was updated, expressed in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
Remarks

Required

TimeoutInSeconds

Declaration
[Required(ErrorMessage = "TimeoutInSeconds is required.")]
[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }
Property Value
Type Description
int?

The default polling timeout of the messages in the queue, in seconds.
Remarks

Required

VisibilityInSeconds

Declaration
[Required(ErrorMessage = "VisibilityInSeconds is required.")]
[JsonProperty(PropertyName = "visibilityInSeconds")]
public int? VisibilityInSeconds { get; set; }
Property Value
Type Description
int?

The default visibility timeout of the messages consumed from the queue, in seconds.
Remarks

Required