1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Queue
  5. getQueues
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Queue.getQueues

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This data source provides the list of Queues in Oracle Cloud Infrastructure Queue service.

    Returns a list of queues.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testQueues = Oci.Queue.GetQueues.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Queue_display_name,
            Id = @var.Queue_id,
            State = @var.Queue_state,
        });
    
    });
    
    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.GetQueues(ctx, &queue.GetQueuesArgs{
    			CompartmentId: pulumi.StringRef(_var.Compartment_id),
    			DisplayName:   pulumi.StringRef(_var.Queue_display_name),
    			Id:            pulumi.StringRef(_var.Queue_id),
    			State:         pulumi.StringRef(_var.Queue_state),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetQueuesArgs;
    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 testQueues = QueueFunctions.getQueues(GetQueuesArgs.builder()
                .compartmentId(var_.compartment_id())
                .displayName(var_.queue_display_name())
                .id(var_.queue_id())
                .state(var_.queue_state())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_queues = oci.Queue.get_queues(compartment_id=var["compartment_id"],
        display_name=var["queue_display_name"],
        id=var["queue_id"],
        state=var["queue_state"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testQueues = oci.Queue.getQueues({
        compartmentId: _var.compartment_id,
        displayName: _var.queue_display_name,
        id: _var.queue_id,
        state: _var.queue_state,
    });
    
    variables:
      testQueues:
        fn::invoke:
          Function: oci:Queue:getQueues
          Arguments:
            compartmentId: ${var.compartment_id}
            displayName: ${var.queue_display_name}
            id: ${var.queue_id}
            state: ${var.queue_state}
    

    Using getQueues

    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 getQueues(args: GetQueuesArgs, opts?: InvokeOptions): Promise<GetQueuesResult>
    function getQueuesOutput(args: GetQueuesOutputArgs, opts?: InvokeOptions): Output<GetQueuesResult>
    def get_queues(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_queue.GetQueuesFilter]] = None,
                   id: Optional[str] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetQueuesResult
    def get_queues_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_queue.GetQueuesFilterArgs]]]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetQueuesResult]
    func GetQueues(ctx *Context, args *GetQueuesArgs, opts ...InvokeOption) (*GetQueuesResult, error)
    func GetQueuesOutput(ctx *Context, args *GetQueuesOutputArgs, opts ...InvokeOption) GetQueuesResultOutput

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

    public static class GetQueues 
    {
        public static Task<GetQueuesResult> InvokeAsync(GetQueuesArgs args, InvokeOptions? opts = null)
        public static Output<GetQueuesResult> Invoke(GetQueuesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQueuesResult> getQueues(GetQueuesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Queue/getQueues:getQueues
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetQueuesFilter>
    Id string
    The unique queue identifier.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetQueuesFilter
    Id string
    The unique queue identifier.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetsFilter>
    id String
    The unique queue identifier.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetQueuesFilter[]
    id string
    The unique queue identifier.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters GetQueuesFilter]
    id str
    The unique queue identifier.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    id String
    The unique queue identifier.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.

    getQueues Result

    The following output properties are available:

    QueueCollections List<GetQueuesQueueCollection>
    The list of queue_collection.
    CompartmentId string
    The OCID of the compartment containing the queue.
    DisplayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetQueuesFilter>
    Id string
    A unique identifier for the queue that is immutable on creation.
    State string
    The current state of the queue.
    QueueCollections []GetQueuesQueueCollection
    The list of queue_collection.
    CompartmentId string
    The OCID of the compartment containing the queue.
    DisplayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetQueuesFilter
    Id string
    A unique identifier for the queue that is immutable on creation.
    State string
    The current state of the queue.
    queueCollections List<GetsCollection>
    The list of queue_collection.
    compartmentId String
    The OCID of the compartment containing the queue.
    displayName String
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetsFilter>
    id String
    A unique identifier for the queue that is immutable on creation.
    state String
    The current state of the queue.
    queueCollections GetQueuesQueueCollection[]
    The list of queue_collection.
    compartmentId string
    The OCID of the compartment containing the queue.
    displayName string
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetQueuesFilter[]
    id string
    A unique identifier for the queue that is immutable on creation.
    state string
    The current state of the queue.
    queue_collections GetQueuesQueueCollection]
    The list of queue_collection.
    compartment_id str
    The OCID of the compartment containing the queue.
    display_name str
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetQueuesFilter]
    id str
    A unique identifier for the queue that is immutable on creation.
    state str
    The current state of the queue.
    queueCollections List<Property Map>
    The list of queue_collection.
    compartmentId String
    The OCID of the compartment containing the queue.
    displayName String
    A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<Property Map>
    id String
    A unique identifier for the queue that is immutable on creation.
    state String
    The current state of the queue.

    Supporting Types

    GetQueuesFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetQueuesQueueCollection

    GetQueuesQueueCollectionItem

    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    RetentionInSeconds int
    The retention period of the messages in the queue, in seconds.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    RetentionInSeconds int
    The retention period of the messages in the queue, in seconds.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    retentionInSeconds Integer
    The retention period of the messages in the queue, in seconds.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    retentionInSeconds number
    The retention period of the messages in the queue, in seconds.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    retention_in_seconds int
    The retention period of the messages in the queue, in seconds.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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 in which to list resources.
    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 filter to return only resources that match the entire display name given.
    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
    The unique queue identifier.
    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
    retentionInSeconds Number
    The retention period of the messages in the queue, in seconds.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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.24.0 published on Thursday, Feb 22, 2024 by Pulumi