Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateQueueDetails

The information about a new queue.

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.

Optional deadLetterQueueDeliveryCount

deadLetterQueueDeliveryCount: undefined | 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"}}}

displayName

displayName: string

The user-friendly name of the queue.

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"}}

Optional retentionInSeconds

retentionInSeconds: undefined | number

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

Optional timeoutInSeconds

timeoutInSeconds: undefined | 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.

Optional visibilityInSeconds

visibilityInSeconds: undefined | 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

getJsonObj