Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Queue

A detailed representation of a queue and its configuration.

Properties

Optional channelConsumptionLimit

channelConsumptionLimit: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

compartmentId

compartmentId: string

The OCID of the compartment containing the queue.

Optional customEncryptionKeyId

customEncryptionKeyId: undefined | string

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

deadLetterQueueDeliveryCount

deadLetterQueueDeliveryCount: number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

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

Optional displayName

displayName: undefined | string

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

Optional freeformTags

freeformTags: undefined | object

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

id

id: string

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

Optional lifecycleDetails

lifecycleDetails: undefined | string

Any additional details about the current state of the queue.

lifecycleState

lifecycleState: LifecycleState

The current state of the queue.

messagesEndpoint

messagesEndpoint: string

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

retentionInSeconds

retentionInSeconds: number

The retention period of the messages in the queue, in seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional systemTags

systemTags: undefined | object

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

timeCreated

timeCreated: Date

The time that the queue was created, expressed in RFC 3339 timestamp format.

Example: {@code 2018-04-20T00:00:07.405Z}

timeUpdated

timeUpdated: Date

The time that the queue was updated, expressed in RFC 3339 timestamp format.

Example: {@code 2018-04-20T00:00:07.405Z}

timeoutInSeconds

timeoutInSeconds: number

The default polling timeout of the messages in the queue, in seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

visibilityInSeconds

visibilityInSeconds: number

The default visibility timeout of the messages consumed from the queue, in seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Queue): object

getJsonObj

  • getJsonObj(obj: Queue): object