queue.oracle.com/v1beta1¶

APIVersion: queue.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages¶

Package	Support	Latest release	Resources
Queue	preview	`v2.0.0-alpha`	Queue

Resources¶

Kind	Scope	Sample	Packages
Queue	Namespaced	Sample	Queue (`v2.0.0-alpha`)

Queue¶

Manage OCI Queue service queues.

Plural: queues
Scope: Namespaced
APIVersion: queue.oracle.com/v1beta1
Sample: Sample (config/samples/queue_v1beta1_queue.yaml)
Packages: Queue (v2.0.0-alpha)

Spec¶

QueueSpec defines the desired state of Queue.

Field	Description	Type	Required	Default	Enum
`capabilities`	The capability to add on the queue	`list[object]`	No	-	-
`channelConsumptionLimit`	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.	`integer`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue.	`string`	Yes	-	-
`customEncryptionKeyId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content.	`string`	No	-	-
`deadLetterQueueDeliveryCount`	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.	`integer`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`displayName`	The user-friendly name of the queue.	`string`	Yes	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`retentionInSeconds`	The retention period of messages in the queue, in seconds.	`integer`	No	-	-
`timeoutInSeconds`	The default polling timeout of the messages in the queue, in seconds.	`integer`	No	-	-
`visibilityInSeconds`	The default visibility timeout of the messages consumed from the queue, in seconds.	`integer`	No	-	-

Spec.capabilities[]¶

Back to Queue spec

QueueCapability defines nested fields for Queue.Capability.

Field	Description	Type	Required	Default	Enum
`isPrimaryConsumerGroupEnabled`	Specifies if the primary consumer group should be automatically enabled after adding the capability.	`boolean`	No	-	-
`jsonData`	-	`string`	No	-	-
`primaryConsumerGroupDeadLetterQueueDeliveryCount`	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. If the value isn't set, it will be using the value defined at the queue level.	`integer`	No	-	-
`primaryConsumerGroupDisplayName`	Name of the primary consumer group. If omitted, it will be named "Primary Consumer Group".	`string`	No	-	-
`primaryConsumerGroupFilter`	The filter used by the primary consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group.	`string`	No	-	-
`type`	-	`string`	No	-	-

Status¶

QueueStatus defines the observed state of Queue.

Field	Description	Type	Required	Default	Enum
`capabilities`	The list of capabilities enabled on the queue	`list[object]`	No	-	-
`channelConsumptionLimit`	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.	`integer`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue.	`string`	No	-	-
`createWorkRequestId`	The work request OCID tracking the in-flight create operation.	`string`	No	-	-
`customEncryptionKeyId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content.	`string`	No	-	-
`deadLetterQueueDeliveryCount`	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.	`integer`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deleteWorkRequestId`	The work request OCID tracking the in-flight delete operation.	`string`	No	-	-
`displayName`	A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	A unique identifier for the queue that is immutable on creation.	`string`	No	-	-
`lifecycleDetails`	Any additional details about the current state of the queue.	`string`	No	-	-
`lifecycleState`	The current state of the queue.	`string`	No	-	-
`messagesEndpoint`	The endpoint to use to consume or publish messages in the queue.	`string`	No	-	-
`retentionInSeconds`	The retention period of the messages in the queue, in seconds.	`integer`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The time that the queue was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z`	`string`	No	-	-
`timeUpdated`	The time that the queue was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z`	`string`	No	-	-
`timeoutInSeconds`	The default polling timeout of the messages in the queue, in seconds.	`integer`	No	-	-
`updateWorkRequestId`	The work request OCID tracking the in-flight update operation.	`string`	No	-	-
`visibilityInSeconds`	The default visibility timeout of the messages consumed from the queue, in seconds.	`integer`	No	-	-

Status.capabilities[]¶

Back to Queue status

QueueCapability defines nested fields for Queue.Capability.

Field	Description	Type	Required	Default	Enum
`isPrimaryConsumerGroupEnabled`	Specifies if the primary consumer group should be automatically enabled after adding the capability.	`boolean`	No	-	-
`jsonData`	-	`string`	No	-	-
`primaryConsumerGroupDeadLetterQueueDeliveryCount`	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. If the value isn't set, it will be using the value defined at the queue level.	`integer`	No	-	-
`primaryConsumerGroupDisplayName`	Name of the primary consumer group. If omitted, it will be named "Primary Consumer Group".	`string`	No	-	-
`primaryConsumerGroupFilter`	The filter used by the primary consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group.	`string`	No	-	-
`type`	-	`string`	No	-	-

Status.status¶

Back to Queue status

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Back to Queue status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Back to Queue status

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Back to Queue status

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-