Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Queue
  5. getQueue
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

oci.Queue.getQueue

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Queue resource in Oracle Cloud Infrastructure Queue service.

    Gets a queue by identifier.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testQueue = oci.Queue.getQueue({
    queueId: oci_queue_queue.test_queue.id,
});

    import pulumi
import pulumi_oci as oci

test_queue = oci.Queue.get_queue(queue_id=oci_queue_queue["test_queue"]["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Queue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Queue.GetQueue(ctx, &queue.GetQueueArgs{
			QueueId: oci_queue_queue.Test_queue.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testQueue = Oci.Queue.GetQueue.Invoke(new()
    {
        QueueId = oci_queue_queue.Test_queue.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Queue.QueueFunctions;
import com.pulumi.oci.Queue.inputs.GetQueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testQueue = QueueFunctions.getQueue(GetQueueArgs.builder()
            .queueId(oci_queue_queue.test_queue().id())
            .build());

    }
}

    variables:
  testQueue:
    fn::invoke:
      Function: oci:Queue:getQueue
      Arguments:
        queueId: ${oci_queue_queue.test_queue.id}

    Using getQueue

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>
    def get_queue(queue_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(queue_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]
    func GetQueue(ctx *Context, args *GetQueueArgs, opts ...InvokeOption) (*GetQueueResult, error)
func GetQueueOutput(ctx *Context, args *GetQueueOutputArgs, opts ...InvokeOption) GetQueueResultOutput

    > Note: This function is named GetQueue in the Go SDK.

    public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Queue/getQueue:getQueue
  arguments:
    # arguments dictionary

    The following arguments are supported:

    QueueId string
    The unique queue identifier.
    QueueId string
    The unique queue identifier.
    queueId String
    The unique queue identifier.
    queueId string
    The unique queue identifier.
    queue_id str
    The unique queue identifier.
    queueId String
    The unique queue identifier.

    getQueue Result

    The following output properties are available:

    ChannelConsumptionLimit 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 string
    The OCID of the compartment containing the queue.
    CustomEncryptionKeyId string
    The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount 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.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the queue that is immutable on creation.
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    PurgeQueue bool
    PurgeType string
    QueueId string
    RetentionInSeconds int
    The retention period of the messages in the queue, in seconds.
    State string
    The current state of the queue.
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeoutInSeconds int
    The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    The default visibility timeout of the messages consumed from the queue, in seconds.
    ChannelConsumptionLimit 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 string
    The OCID of the compartment containing the queue.
    CustomEncryptionKeyId string
    The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount 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.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the queue that is immutable on creation.
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    PurgeQueue bool
    PurgeType string
    QueueId string
    RetentionInSeconds int
    The retention period of the messages in the queue, in seconds.
    State string
    The current state of the queue.
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeoutInSeconds int
    The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit Integer
    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 String
    The OCID of the compartment containing the queue.
    customEncryptionKeyId String
    The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount Integer
    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.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the queue that is immutable on creation.
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    purgeQueue Boolean
    purgeType String
    queueId String
    retentionInSeconds Integer
    The retention period of the messages in the queue, in seconds.
    state String
    The current state of the queue.
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds Integer
    The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Integer
    The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit 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.
    compartmentId string
    The OCID of the compartment containing the queue.
    customEncryptionKeyId string
    The OCID of the custom encryption key to be used to encrypt messages content.
    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.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    A unique identifier for the queue that is immutable on creation.
    lifecycleDetails string
    Any additional details about the current state of the queue.
    messagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    purgeQueue boolean
    purgeType string
    queueId string
    retentionInSeconds number
    The retention period of the messages in the queue, in seconds.
    state string
    The current state of the queue.
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds number
    The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds number
    The default visibility timeout of the messages consumed from the queue, in seconds.
    channel_consumption_limit 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.
    compartment_id str
    The OCID of the compartment containing the queue.
    custom_encryption_key_id str
    The OCID of the custom encryption key to be used to encrypt messages content.
    dead_letter_queue_delivery_count 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.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    A unique identifier for the queue that is immutable on creation.
    lifecycle_details str
    Any additional details about the current state of the queue.
    messages_endpoint str
    The endpoint to use to consume or publish messages in the queue.
    purge_queue bool
    purge_type str
    queue_id str
    retention_in_seconds int
    The retention period of the messages in the queue, in seconds.
    state str
    The current state of the queue.
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeout_in_seconds int
    The default polling timeout of the messages in the queue, in seconds.
    visibility_in_seconds int
    The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit 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.
    compartmentId String
    The OCID of the compartment containing the queue.
    customEncryptionKeyId String
    The OCID of the custom encryption key to be used to encrypt messages content.
    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.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the queue that is immutable on creation.
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    purgeQueue Boolean
    purgeType String
    queueId String
    retentionInSeconds Number
    The retention period of the messages in the queue, in seconds.
    state String
    The current state of the queue.
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds Number
    The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Number
    The default visibility timeout of the messages consumed from the queue, in seconds.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-oci