openapi: 3.2.0 info: description: Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm). title: Queue Queue Admin API version: '20210201' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/49b73908fe2a44b79dc0e48d624a171339887f6587b79da8d22e48eeae28a8ce.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Queue API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/49b73908fe2a44b79dc0e48d624a171339887f6587b79da8d22e48eeae28a8ce.yaml what: the harvested document for Queue API servers: - url: http://127.0.0.1/20210201 - url: https://127.0.0.1/20210201 tags: - name: queueAdmin paths: /consumerGroups: get: description: 'Returns a list of consumer groups. ' operationId: ListConsumerGroups parameters: - $ref: '#/components/parameters/ConsumerGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ConsumerGroupIdentifierQueryParam' - $ref: '#/components/parameters/QueueIdentifierCgQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ConsumerGroupSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConsumerGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all consumer groups in a queue tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ConsumerGroupCollection' post: description: 'Creates a new consumer group. ' operationId: CreateConsumerGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The consumer group will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new consumer group tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ConsumerGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConsumerGroupDetails' description: Details for the new consumer group. required: true /consumerGroups/{consumerGroupId}: delete: description: Deletes a consumer group resource by identifier. operationId: DeleteConsumerGroup parameters: - $ref: '#/components/parameters/ConsumerGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The consumer group will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a consumer group tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ConsumerGroup' get: description: Gets a consumer group by identifier. operationId: GetConsumerGroup parameters: - $ref: '#/components/parameters/ConsumerGroupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the consumer group with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConsumerGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the consumer group tags: - queueAdmin x-obmcs-client-retries-enabled: true put: description: Updates the specified consumer group. operationId: UpdateConsumerGroup parameters: - $ref: '#/components/parameters/ConsumerGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The consumer group will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the consumer group identified by the id tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ConsumerGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConsumerGroupDetails' description: The information to be updated. required: true /queues: get: description: 'Returns a list of queues. ' operationId: ListQueues parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/QueueIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of QueueSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/QueueCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Queues in a compartment tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/QueueCollection' post: description: 'Creates a new queue. ' operationId: CreateQueue parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Queue will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Queue tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Queue' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQueueDetails' description: Details for the new Queue. required: true /queues/{queueId}: delete: description: Deletes a queue resource by identifier. operationId: DeleteQueue parameters: - $ref: '#/components/parameters/QueueIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Queue will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Queue tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Queue' get: description: Gets a queue by identifier. operationId: GetQueue parameters: - $ref: '#/components/parameters/QueueIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Queue with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Queue' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Queue tags: - queueAdmin x-obmcs-client-retries-enabled: true put: description: Updates the specified queue. operationId: UpdateQueue parameters: - $ref: '#/components/parameters/QueueIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Queue will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Queue identified by the id tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Queue' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateQueueDetails' description: The information to be updated. required: true /queues/{queueId}/actions/changeCompartment: post: description: Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeQueueCompartment parameters: - $ref: '#/components/parameters/QueueIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Queue resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Queue' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeQueueCompartmentDetails' description: The information to be updated. required: true /queues/{queueId}/actions/purge: post: description: "Deletes all messages present in the queue or in the specified consumer group, or deletes all the messages in the specific channel at the time of invocation. \nOnly one concurrent purge operation is supported for any given queue. \nHowever multiple concurrent purge operations are supported for different queues.\nPurge request without specification of target channels will clean up all messages in the queue and in the child channels. \nPurge request without specification of consumer group will either clean up all messages in the queue or in the primary consumer group, depending on the presence of the CONSUMER_GROUPS capability on the queue.\nTo purge all consumer groups, the special value 'all' can be used.\n" operationId: PurgeQueue parameters: - $ref: '#/components/parameters/QueueIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Queue resource will be purged. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Deletes all messages present in the queue at the time of invocation. tags: - queueAdmin x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Queue' requestBody: content: application/json: schema: $ref: '#/components/schemas/PurgeQueueDetails' description: The information to be updated. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestSummaryCollection' /workRequests/{workRequestId}: get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestErrorCollection' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - queueAdmin x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestLogEntryCollection' components: schemas: QueueCollection: description: Results of a queue search. Contains both QueueSummary items and other information, such as metadata. properties: items: description: List of queues. items: $ref: '#/components/schemas/QueueSummary' type: array required: - items type: object ChangeQueueCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ConsumerGroupCollection: description: Results of a consumer group search. Contains both ConsumerGroupSummary items and other information, such as metadata. properties: items: description: List of consumer groups. items: $ref: '#/components/schemas/ConsumerGroupSummary' type: array required: - items type: object ConsumerGroup: description: A detailed representation of a consumer group. properties: deadLetterQueueDeliveryCount: description: "The number of times a message can be delivered to a consumer before being moved to the dead letter queue. \nA value of 0 indicates that the DLQ is not used.\nIf the value isn't set, it will be using the value defined at the queue level.\n" type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information. type: string filter: description: 'The filter used by the 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. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the consumer group that is immutable on creation. type: string lifecycleDetails: description: Any additional details about the current state of the consumer group. type: string lifecycleState: description: The current state of the consumer group. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE type: string queueId: description: The OCID of the associated queue. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time that the consumer group was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` ' format: date-time type: string timeUpdated: description: 'The time that the consumer group was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` ' format: date-time type: string required: - id - displayName - timeCreated - timeUpdated - lifecycleState - filter - queueId type: object CreateConsumerGroupDetails: description: The information about a new consumer group. properties: deadLetterQueueDeliveryCount: description: "The number of times a message can be delivered to a consumer before being moved to the dead letter queue. \nA value of 0 indicates that the DLQ is not used.\nIf the value isn't specified, it will be using the value defined at the queue level.\n" minimum: 0 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The user-friendly name of the consumer group. maxLength: 255 minLength: 1 type: string filter: description: The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isEnabled: default: true description: "Used to enable or disable the consumer group. \nAn enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.\n" type: boolean queueId: description: The OCID of the associated queue. maxLength: 255 minLength: 1 type: string required: - displayName - queueId type: object ConsumerGroupSummary: description: Summary of the consumer group. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information. type: string filter: description: The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the consumer group that is immutable on creation. type: string lifecycleDetails: description: Any additional details about the current state of the consumer group. type: string lifecycleState: description: The current state of the consumer group. type: string x-obmcs-enumref: '#/definitions/ConsumerGroup/lifecycleState' queueId: description: The OCID of the associated queue. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time that the consumer group was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` ' format: date-time type: string timeUpdated: description: 'The time that the consumer group was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` ' format: date-time type: string required: - id - displayName - timeCreated - timeUpdated - lifecycleState - filter - queueId type: object Queue: description: A detailed representation of a queue and its configuration. properties: capabilities: description: The list of capabilities enabled on the queue items: $ref: '#/components/schemas/CapabilityDetails' type: array channelConsumptionLimit: default: 100 description: 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. maximum: 100 minimum: 1 type: integer compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue. type: string customEncryptionKeyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content. maxLength: 255 minLength: 1 type: string deadLetterQueueDeliveryCount: description: 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. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the queue that is immutable on creation. type: string lifecycleDetails: description: Any additional details about the current state of the queue. type: string lifecycleState: description: The current state of the queue. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE type: string messagesEndpoint: description: The endpoint to use to consume or publish messages in the queue. type: string retentionInSeconds: description: The retention period of the messages in the queue, in seconds. type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: '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` ' format: date-time type: string timeUpdated: description: '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` ' format: date-time type: string timeoutInSeconds: description: The default polling timeout of the messages in the queue, in seconds. type: integer visibilityInSeconds: description: The default visibility timeout of the messages consumed from the queue, in seconds. type: integer required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - messagesEndpoint - retentionInSeconds - visibilityInSeconds - timeoutInSeconds - deadLetterQueueDeliveryCount type: object CreateQueueDetails: description: The information about a new queue. properties: capabilities: description: The capability to add on the queue items: $ref: '#/components/schemas/CapabilityDetails' type: array channelConsumptionLimit: default: 100 description: 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. maximum: 100 minimum: 1 type: integer compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue. maxLength: 255 minLength: 1 type: string customEncryptionKeyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content. maxLength: 255 minLength: 1 type: string deadLetterQueueDeliveryCount: default: 0 description: 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. minimum: 0 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The user-friendly name of the queue. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionInSeconds: default: 86400 description: The retention period of messages in the queue, in seconds. maximum: 604800 minimum: 10 type: integer timeoutInSeconds: default: 30 description: The default polling timeout of the messages in the queue, in seconds. maximum: 30 minimum: 0 type: integer visibilityInSeconds: default: 30 description: The default visibility timeout of the messages consumed from the queue, in seconds. maximum: 43200 minimum: 1 type: integer required: - displayName - compartmentId type: object CapabilityDetails: description: Base object for capabilities discriminator: propertyName: type properties: type: description: The type of the capability enum: - CONSUMER_GROUPS - LARGE_MESSAGES type: string x-obmcs-top-level-enum: '#/definitions/QueueCapability' type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object PurgeQueueDetails: description: Purge parameters. properties: channelIds: description: "Optional parameter to specify the destination of purge operation. \nIf the channel ID is specified, the purge operation will delete all the messages in the specific channels. \nIf the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.\n" items: maxLength: 64 minLength: 1 type: string type: array consumerGroupId: description: "The consumer group ID to purge. If the CONSUMER_GROUPS capability is enabled on the queue, omitting that field\nwill purge the \"Primary Consumer Group\", otherwise it will purge the queue. \nIf you wish to purge all consumer groups in the queue, you can pass the special value 'all'.\n" type: string purgeType: description: '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 ' enum: - NORMAL - DLQ - BOTH type: string required: - purgeType type: object UpdateConsumerGroupDetails: description: The information to be updated. properties: deadLetterQueueDeliveryCount: description: '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. Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue. A value of -1 unsets the delivery count for the consumer group (i.e. it will now be using the value set at the queue level). ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the consumer group. maxLength: 255 minLength: 1 type: string filter: description: The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isEnabled: description: "Used to enable or disable the consumer group. \nAn enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.\n" type: boolean type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The ID of the work request. type: string operationType: description: Type of the work request enum: - CREATE_QUEUE - UPDATE_QUEUE - DELETE_QUEUE - MOVE_QUEUE - PURGE_QUEUE - CREATE_CONSUMER_GROUP - UPDATE_CONSUMER_GROUP - DELETE_CONSUMER_GROUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string. format: date-time type: string required: - code - message - timestamp UpdateQueueDetails: description: The information to be updated. properties: capabilities: description: The list of capabilities enabled on the queue items: $ref: '#/components/schemas/CapabilityDetails' type: array channelConsumptionLimit: default: 100 description: 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. maximum: 100 minimum: 1 type: integer customEncryptionKeyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue. maxLength: 255 minLength: 0 type: string deadLetterQueueDeliveryCount: default: 0 description: '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. Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue. ' minimum: 0 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the queue. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object timeoutInSeconds: default: 30 description: The default polling timeout of the messages in the queue, in seconds. maximum: 30 minimum: 0 type: integer visibilityInSeconds: default: 30 description: The default visibility timeout of the messages consumed from the queue, in seconds. maximum: 43200 minimum: 1 type: integer type: object QueueSummary: description: Summary of the queue. properties: capabilities: description: The list of capabilities enabled on the queue items: enum: - CONSUMER_GROUPS - LARGE_MESSAGES type: string x-obmcs-top-level-enum: '#/definitions/QueueCapability' type: array compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the queue that is immutable on creation. type: string lifecycleDetails: description: Any additional details about the current state of the queue. type: string lifecycleState: description: The current state of the queue. type: string x-obmcs-enumref: '#/definitions/Queue/lifecycleState' messagesEndpoint: description: The endpoint to use to consume or publish messages in the queue. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: '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` ' format: date-time type: string timeUpdated: description: '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` ' format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - messagesEndpoint type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string format: date-time type: string required: - message - timestamp WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_QUEUE - UPDATE_QUEUE - DELETE_QUEUE - MOVE_QUEUE - PURGE_QUEUE - CREATE_CONSUMER_GROUP - UPDATE_CONSUMER_GROUP - DELETE_CONSUMER_GROUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted parameters: PaginationTokenQueryParam: description: For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated QueueIdentifierPathParam: description: The unique queue identifier. in: path name: queueId required: true schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string PaginationLimitQueryParam: description: For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 LifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Queue/lifecycleState' schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string ConsumerGroupLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ConsumerGroup/lifecycleState' schema: type: string QueueIdentifierQueryParam: description: The unique queue identifier. in: query name: id x-default-description: 'null' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 QueueIdentifierCgQueryParam: description: The unique queue identifier. in: query name: queueId x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ConsumerGroupIdentifierQueryParam: description: The unique consumer group identifier. in: query name: id x-default-description: 'null' schema: type: string RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string ConsumerGroupIdentifierPathParam: description: The unique consumer group identifier. in: path name: consumerGroupId required: true schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.queue.cp