queue

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 14, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetQueuesArgs

type GetQueuesArgs struct {
	// The ID of the compartment in which to list resources.
	CompartmentId *string `pulumi:"compartmentId"`
	// A filter to return only resources that match the entire display name given.
	DisplayName *string           `pulumi:"displayName"`
	Filters     []GetQueuesFilter `pulumi:"filters"`
	// unique Queue identifier
	Id *string `pulumi:"id"`
	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	State *string `pulumi:"state"`
}

A collection of arguments for invoking getQueues.

type GetQueuesFilter

type GetQueuesFilter struct {
	Name   string   `pulumi:"name"`
	Regex  *bool    `pulumi:"regex"`
	Values []string `pulumi:"values"`
}

type GetQueuesFilterArgs

type GetQueuesFilterArgs struct {
	Name   pulumi.StringInput      `pulumi:"name"`
	Regex  pulumi.BoolPtrInput     `pulumi:"regex"`
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetQueuesFilterArgs) ElementType

func (GetQueuesFilterArgs) ElementType() reflect.Type

func (GetQueuesFilterArgs) ToGetQueuesFilterOutput

func (i GetQueuesFilterArgs) ToGetQueuesFilterOutput() GetQueuesFilterOutput

func (GetQueuesFilterArgs) ToGetQueuesFilterOutputWithContext

func (i GetQueuesFilterArgs) ToGetQueuesFilterOutputWithContext(ctx context.Context) GetQueuesFilterOutput

type GetQueuesFilterArray

type GetQueuesFilterArray []GetQueuesFilterInput

func (GetQueuesFilterArray) ElementType

func (GetQueuesFilterArray) ElementType() reflect.Type

func (GetQueuesFilterArray) ToGetQueuesFilterArrayOutput

func (i GetQueuesFilterArray) ToGetQueuesFilterArrayOutput() GetQueuesFilterArrayOutput

func (GetQueuesFilterArray) ToGetQueuesFilterArrayOutputWithContext

func (i GetQueuesFilterArray) ToGetQueuesFilterArrayOutputWithContext(ctx context.Context) GetQueuesFilterArrayOutput

type GetQueuesFilterArrayInput

type GetQueuesFilterArrayInput interface {
	pulumi.Input

	ToGetQueuesFilterArrayOutput() GetQueuesFilterArrayOutput
	ToGetQueuesFilterArrayOutputWithContext(context.Context) GetQueuesFilterArrayOutput
}

GetQueuesFilterArrayInput is an input type that accepts GetQueuesFilterArray and GetQueuesFilterArrayOutput values. You can construct a concrete instance of `GetQueuesFilterArrayInput` via:

GetQueuesFilterArray{ GetQueuesFilterArgs{...} }

type GetQueuesFilterArrayOutput

type GetQueuesFilterArrayOutput struct{ *pulumi.OutputState }

func (GetQueuesFilterArrayOutput) ElementType

func (GetQueuesFilterArrayOutput) ElementType() reflect.Type

func (GetQueuesFilterArrayOutput) Index

func (GetQueuesFilterArrayOutput) ToGetQueuesFilterArrayOutput

func (o GetQueuesFilterArrayOutput) ToGetQueuesFilterArrayOutput() GetQueuesFilterArrayOutput

func (GetQueuesFilterArrayOutput) ToGetQueuesFilterArrayOutputWithContext

func (o GetQueuesFilterArrayOutput) ToGetQueuesFilterArrayOutputWithContext(ctx context.Context) GetQueuesFilterArrayOutput

type GetQueuesFilterInput

type GetQueuesFilterInput interface {
	pulumi.Input

	ToGetQueuesFilterOutput() GetQueuesFilterOutput
	ToGetQueuesFilterOutputWithContext(context.Context) GetQueuesFilterOutput
}

GetQueuesFilterInput is an input type that accepts GetQueuesFilterArgs and GetQueuesFilterOutput values. You can construct a concrete instance of `GetQueuesFilterInput` via:

GetQueuesFilterArgs{...}

type GetQueuesFilterOutput

type GetQueuesFilterOutput struct{ *pulumi.OutputState }

func (GetQueuesFilterOutput) ElementType

func (GetQueuesFilterOutput) ElementType() reflect.Type

func (GetQueuesFilterOutput) Name

func (GetQueuesFilterOutput) Regex

func (GetQueuesFilterOutput) ToGetQueuesFilterOutput

func (o GetQueuesFilterOutput) ToGetQueuesFilterOutput() GetQueuesFilterOutput

func (GetQueuesFilterOutput) ToGetQueuesFilterOutputWithContext

func (o GetQueuesFilterOutput) ToGetQueuesFilterOutputWithContext(ctx context.Context) GetQueuesFilterOutput

func (GetQueuesFilterOutput) Values

type GetQueuesOutputArgs

type GetQueuesOutputArgs struct {
	// The ID of the compartment in which to list resources.
	CompartmentId pulumi.StringPtrInput `pulumi:"compartmentId"`
	// A filter to return only resources that match the entire display name given.
	DisplayName pulumi.StringPtrInput     `pulumi:"displayName"`
	Filters     GetQueuesFilterArrayInput `pulumi:"filters"`
	// unique Queue identifier
	Id pulumi.StringPtrInput `pulumi:"id"`
	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	State pulumi.StringPtrInput `pulumi:"state"`
}

A collection of arguments for invoking getQueues.

func (GetQueuesOutputArgs) ElementType

func (GetQueuesOutputArgs) ElementType() reflect.Type

type GetQueuesQueueCollection

type GetQueuesQueueCollection struct {
	Items []GetQueuesQueueCollectionItem `pulumi:"items"`
}

type GetQueuesQueueCollectionArgs

type GetQueuesQueueCollectionArgs struct {
	Items GetQueuesQueueCollectionItemArrayInput `pulumi:"items"`
}

func (GetQueuesQueueCollectionArgs) ElementType

func (GetQueuesQueueCollectionArgs) ToGetQueuesQueueCollectionOutput

func (i GetQueuesQueueCollectionArgs) ToGetQueuesQueueCollectionOutput() GetQueuesQueueCollectionOutput

func (GetQueuesQueueCollectionArgs) ToGetQueuesQueueCollectionOutputWithContext

func (i GetQueuesQueueCollectionArgs) ToGetQueuesQueueCollectionOutputWithContext(ctx context.Context) GetQueuesQueueCollectionOutput

type GetQueuesQueueCollectionArray

type GetQueuesQueueCollectionArray []GetQueuesQueueCollectionInput

func (GetQueuesQueueCollectionArray) ElementType

func (GetQueuesQueueCollectionArray) ToGetQueuesQueueCollectionArrayOutput

func (i GetQueuesQueueCollectionArray) ToGetQueuesQueueCollectionArrayOutput() GetQueuesQueueCollectionArrayOutput

func (GetQueuesQueueCollectionArray) ToGetQueuesQueueCollectionArrayOutputWithContext

func (i GetQueuesQueueCollectionArray) ToGetQueuesQueueCollectionArrayOutputWithContext(ctx context.Context) GetQueuesQueueCollectionArrayOutput

type GetQueuesQueueCollectionArrayInput

type GetQueuesQueueCollectionArrayInput interface {
	pulumi.Input

	ToGetQueuesQueueCollectionArrayOutput() GetQueuesQueueCollectionArrayOutput
	ToGetQueuesQueueCollectionArrayOutputWithContext(context.Context) GetQueuesQueueCollectionArrayOutput
}

GetQueuesQueueCollectionArrayInput is an input type that accepts GetQueuesQueueCollectionArray and GetQueuesQueueCollectionArrayOutput values. You can construct a concrete instance of `GetQueuesQueueCollectionArrayInput` via:

GetQueuesQueueCollectionArray{ GetQueuesQueueCollectionArgs{...} }

type GetQueuesQueueCollectionArrayOutput

type GetQueuesQueueCollectionArrayOutput struct{ *pulumi.OutputState }

func (GetQueuesQueueCollectionArrayOutput) ElementType

func (GetQueuesQueueCollectionArrayOutput) Index

func (GetQueuesQueueCollectionArrayOutput) ToGetQueuesQueueCollectionArrayOutput

func (o GetQueuesQueueCollectionArrayOutput) ToGetQueuesQueueCollectionArrayOutput() GetQueuesQueueCollectionArrayOutput

func (GetQueuesQueueCollectionArrayOutput) ToGetQueuesQueueCollectionArrayOutputWithContext

func (o GetQueuesQueueCollectionArrayOutput) ToGetQueuesQueueCollectionArrayOutputWithContext(ctx context.Context) GetQueuesQueueCollectionArrayOutput

type GetQueuesQueueCollectionInput

type GetQueuesQueueCollectionInput interface {
	pulumi.Input

	ToGetQueuesQueueCollectionOutput() GetQueuesQueueCollectionOutput
	ToGetQueuesQueueCollectionOutputWithContext(context.Context) GetQueuesQueueCollectionOutput
}

GetQueuesQueueCollectionInput is an input type that accepts GetQueuesQueueCollectionArgs and GetQueuesQueueCollectionOutput values. You can construct a concrete instance of `GetQueuesQueueCollectionInput` via:

GetQueuesQueueCollectionArgs{...}

type GetQueuesQueueCollectionItem

type GetQueuesQueueCollectionItem struct {
	// The ID of the compartment in which to list resources.
	CompartmentId string `pulumi:"compartmentId"`
	// Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId string `pulumi:"customEncryptionKeyId"`
	// 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.
	DeadLetterQueueDeliveryCount int `pulumi:"deadLetterQueueDeliveryCount"`
	// Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags map[string]interface{} `pulumi:"definedTags"`
	// A filter to return only resources that match the entire display name given.
	DisplayName string `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags map[string]interface{} `pulumi:"freeformTags"`
	// unique Queue identifier
	Id string `pulumi:"id"`
	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	LifecycleDetails string `pulumi:"lifecycleDetails"`
	// The endpoint to use to consume or publish messages in the queue.
	MessagesEndpoint string `pulumi:"messagesEndpoint"`
	PurgeQueue       bool   `pulumi:"purgeQueue"`
	PurgeType        string `pulumi:"purgeType"`
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds int `pulumi:"retentionInSeconds"`
	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	State string `pulumi:"state"`
	// Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
	SystemTags map[string]interface{} `pulumi:"systemTags"`
	// The time the the Queue was created. An RFC3339 formatted datetime string
	TimeCreated string `pulumi:"timeCreated"`
	// The time the Queue was updated. An RFC3339 formatted datetime string
	TimeUpdated string `pulumi:"timeUpdated"`
	// The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds int `pulumi:"timeoutInSeconds"`
	// The default visibility of the messages consumed from the queue.
	VisibilityInSeconds int `pulumi:"visibilityInSeconds"`
}

type GetQueuesQueueCollectionItemArgs

type GetQueuesQueueCollectionItemArgs struct {
	// The ID of the compartment in which to list resources.
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId pulumi.StringInput `pulumi:"customEncryptionKeyId"`
	// 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.
	DeadLetterQueueDeliveryCount pulumi.IntInput `pulumi:"deadLetterQueueDeliveryCount"`
	// Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags pulumi.MapInput `pulumi:"definedTags"`
	// A filter to return only resources that match the entire display name given.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags pulumi.MapInput `pulumi:"freeformTags"`
	// unique Queue identifier
	Id pulumi.StringInput `pulumi:"id"`
	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	LifecycleDetails pulumi.StringInput `pulumi:"lifecycleDetails"`
	// The endpoint to use to consume or publish messages in the queue.
	MessagesEndpoint pulumi.StringInput `pulumi:"messagesEndpoint"`
	PurgeQueue       pulumi.BoolInput   `pulumi:"purgeQueue"`
	PurgeType        pulumi.StringInput `pulumi:"purgeType"`
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds pulumi.IntInput `pulumi:"retentionInSeconds"`
	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	State pulumi.StringInput `pulumi:"state"`
	// Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
	SystemTags pulumi.MapInput `pulumi:"systemTags"`
	// The time the the Queue was created. An RFC3339 formatted datetime string
	TimeCreated pulumi.StringInput `pulumi:"timeCreated"`
	// The time the Queue was updated. An RFC3339 formatted datetime string
	TimeUpdated pulumi.StringInput `pulumi:"timeUpdated"`
	// The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds pulumi.IntInput `pulumi:"timeoutInSeconds"`
	// The default visibility of the messages consumed from the queue.
	VisibilityInSeconds pulumi.IntInput `pulumi:"visibilityInSeconds"`
}

func (GetQueuesQueueCollectionItemArgs) ElementType

func (GetQueuesQueueCollectionItemArgs) ToGetQueuesQueueCollectionItemOutput

func (i GetQueuesQueueCollectionItemArgs) ToGetQueuesQueueCollectionItemOutput() GetQueuesQueueCollectionItemOutput

func (GetQueuesQueueCollectionItemArgs) ToGetQueuesQueueCollectionItemOutputWithContext

func (i GetQueuesQueueCollectionItemArgs) ToGetQueuesQueueCollectionItemOutputWithContext(ctx context.Context) GetQueuesQueueCollectionItemOutput

type GetQueuesQueueCollectionItemArray

type GetQueuesQueueCollectionItemArray []GetQueuesQueueCollectionItemInput

func (GetQueuesQueueCollectionItemArray) ElementType

func (GetQueuesQueueCollectionItemArray) ToGetQueuesQueueCollectionItemArrayOutput

func (i GetQueuesQueueCollectionItemArray) ToGetQueuesQueueCollectionItemArrayOutput() GetQueuesQueueCollectionItemArrayOutput

func (GetQueuesQueueCollectionItemArray) ToGetQueuesQueueCollectionItemArrayOutputWithContext

func (i GetQueuesQueueCollectionItemArray) ToGetQueuesQueueCollectionItemArrayOutputWithContext(ctx context.Context) GetQueuesQueueCollectionItemArrayOutput

type GetQueuesQueueCollectionItemArrayInput

type GetQueuesQueueCollectionItemArrayInput interface {
	pulumi.Input

	ToGetQueuesQueueCollectionItemArrayOutput() GetQueuesQueueCollectionItemArrayOutput
	ToGetQueuesQueueCollectionItemArrayOutputWithContext(context.Context) GetQueuesQueueCollectionItemArrayOutput
}

GetQueuesQueueCollectionItemArrayInput is an input type that accepts GetQueuesQueueCollectionItemArray and GetQueuesQueueCollectionItemArrayOutput values. You can construct a concrete instance of `GetQueuesQueueCollectionItemArrayInput` via:

GetQueuesQueueCollectionItemArray{ GetQueuesQueueCollectionItemArgs{...} }

type GetQueuesQueueCollectionItemArrayOutput

type GetQueuesQueueCollectionItemArrayOutput struct{ *pulumi.OutputState }

func (GetQueuesQueueCollectionItemArrayOutput) ElementType

func (GetQueuesQueueCollectionItemArrayOutput) Index

func (GetQueuesQueueCollectionItemArrayOutput) ToGetQueuesQueueCollectionItemArrayOutput

func (o GetQueuesQueueCollectionItemArrayOutput) ToGetQueuesQueueCollectionItemArrayOutput() GetQueuesQueueCollectionItemArrayOutput

func (GetQueuesQueueCollectionItemArrayOutput) ToGetQueuesQueueCollectionItemArrayOutputWithContext

func (o GetQueuesQueueCollectionItemArrayOutput) ToGetQueuesQueueCollectionItemArrayOutputWithContext(ctx context.Context) GetQueuesQueueCollectionItemArrayOutput

type GetQueuesQueueCollectionItemInput

type GetQueuesQueueCollectionItemInput interface {
	pulumi.Input

	ToGetQueuesQueueCollectionItemOutput() GetQueuesQueueCollectionItemOutput
	ToGetQueuesQueueCollectionItemOutputWithContext(context.Context) GetQueuesQueueCollectionItemOutput
}

GetQueuesQueueCollectionItemInput is an input type that accepts GetQueuesQueueCollectionItemArgs and GetQueuesQueueCollectionItemOutput values. You can construct a concrete instance of `GetQueuesQueueCollectionItemInput` via:

GetQueuesQueueCollectionItemArgs{...}

type GetQueuesQueueCollectionItemOutput

type GetQueuesQueueCollectionItemOutput struct{ *pulumi.OutputState }

func (GetQueuesQueueCollectionItemOutput) CompartmentId

The ID of the compartment in which to list resources.

func (GetQueuesQueueCollectionItemOutput) CustomEncryptionKeyId

func (o GetQueuesQueueCollectionItemOutput) CustomEncryptionKeyId() pulumi.StringOutput

Id of the custom master encryption key which will be used to encrypt messages content

func (GetQueuesQueueCollectionItemOutput) DeadLetterQueueDeliveryCount

func (o GetQueuesQueueCollectionItemOutput) DeadLetterQueueDeliveryCount() pulumi.IntOutput

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.

func (GetQueuesQueueCollectionItemOutput) DefinedTags

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`

func (GetQueuesQueueCollectionItemOutput) DisplayName

A filter to return only resources that match the entire display name given.

func (GetQueuesQueueCollectionItemOutput) ElementType

func (GetQueuesQueueCollectionItemOutput) FreeformTags

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

func (GetQueuesQueueCollectionItemOutput) Id

unique Queue identifier

func (GetQueuesQueueCollectionItemOutput) LifecycleDetails

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

func (GetQueuesQueueCollectionItemOutput) MessagesEndpoint

The endpoint to use to consume or publish messages in the queue.

func (GetQueuesQueueCollectionItemOutput) PurgeQueue

func (GetQueuesQueueCollectionItemOutput) PurgeType

func (GetQueuesQueueCollectionItemOutput) RetentionInSeconds

func (o GetQueuesQueueCollectionItemOutput) RetentionInSeconds() pulumi.IntOutput

The retention period of the messages in the queue, in seconds.

func (GetQueuesQueueCollectionItemOutput) State

A filter to return only resources their lifecycleState matches the given lifecycleState.

func (GetQueuesQueueCollectionItemOutput) SystemTags

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`

func (GetQueuesQueueCollectionItemOutput) TimeCreated

The time the the Queue was created. An RFC3339 formatted datetime string

func (GetQueuesQueueCollectionItemOutput) TimeUpdated

The time the Queue was updated. An RFC3339 formatted datetime string

func (GetQueuesQueueCollectionItemOutput) TimeoutInSeconds

The default polling timeout of the messages in the queue, in seconds.

func (GetQueuesQueueCollectionItemOutput) ToGetQueuesQueueCollectionItemOutput

func (o GetQueuesQueueCollectionItemOutput) ToGetQueuesQueueCollectionItemOutput() GetQueuesQueueCollectionItemOutput

func (GetQueuesQueueCollectionItemOutput) ToGetQueuesQueueCollectionItemOutputWithContext

func (o GetQueuesQueueCollectionItemOutput) ToGetQueuesQueueCollectionItemOutputWithContext(ctx context.Context) GetQueuesQueueCollectionItemOutput

func (GetQueuesQueueCollectionItemOutput) VisibilityInSeconds

func (o GetQueuesQueueCollectionItemOutput) VisibilityInSeconds() pulumi.IntOutput

The default visibility of the messages consumed from the queue.

type GetQueuesQueueCollectionOutput

type GetQueuesQueueCollectionOutput struct{ *pulumi.OutputState }

func (GetQueuesQueueCollectionOutput) ElementType

func (GetQueuesQueueCollectionOutput) Items

func (GetQueuesQueueCollectionOutput) ToGetQueuesQueueCollectionOutput

func (o GetQueuesQueueCollectionOutput) ToGetQueuesQueueCollectionOutput() GetQueuesQueueCollectionOutput

func (GetQueuesQueueCollectionOutput) ToGetQueuesQueueCollectionOutputWithContext

func (o GetQueuesQueueCollectionOutput) ToGetQueuesQueueCollectionOutputWithContext(ctx context.Context) GetQueuesQueueCollectionOutput

type GetQueuesResult

type GetQueuesResult struct {
	// Compartment Identifier
	CompartmentId *string `pulumi:"compartmentId"`
	// Queue Identifier, can be renamed
	DisplayName *string           `pulumi:"displayName"`
	Filters     []GetQueuesFilter `pulumi:"filters"`
	// Unique identifier that is immutable on creation
	Id *string `pulumi:"id"`
	// The list of queue_collection.
	QueueCollections []GetQueuesQueueCollection `pulumi:"queueCollections"`
	// The current state of the Queue.
	State *string `pulumi:"state"`
}

A collection of values returned by getQueues.

func GetQueues

func GetQueues(ctx *pulumi.Context, args *GetQueuesArgs, opts ...pulumi.InvokeOption) (*GetQueuesResult, error)

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

Returns a list of Queues.

## Example Usage

```go 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
	})
}

```

type GetQueuesResultOutput

type GetQueuesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getQueues.

func (GetQueuesResultOutput) CompartmentId

func (o GetQueuesResultOutput) CompartmentId() pulumi.StringPtrOutput

Compartment Identifier

func (GetQueuesResultOutput) DisplayName

Queue Identifier, can be renamed

func (GetQueuesResultOutput) ElementType

func (GetQueuesResultOutput) ElementType() reflect.Type

func (GetQueuesResultOutput) Filters

func (GetQueuesResultOutput) Id

Unique identifier that is immutable on creation

func (GetQueuesResultOutput) QueueCollections

The list of queue_collection.

func (GetQueuesResultOutput) State

The current state of the Queue.

func (GetQueuesResultOutput) ToGetQueuesResultOutput

func (o GetQueuesResultOutput) ToGetQueuesResultOutput() GetQueuesResultOutput

func (GetQueuesResultOutput) ToGetQueuesResultOutputWithContext

func (o GetQueuesResultOutput) ToGetQueuesResultOutputWithContext(ctx context.Context) GetQueuesResultOutput

type LookupQueueArgs

type LookupQueueArgs struct {
	// unique Queue identifier
	QueueId string `pulumi:"queueId"`
}

A collection of arguments for invoking getQueue.

type LookupQueueOutputArgs

type LookupQueueOutputArgs struct {
	// unique Queue identifier
	QueueId pulumi.StringInput `pulumi:"queueId"`
}

A collection of arguments for invoking getQueue.

func (LookupQueueOutputArgs) ElementType

func (LookupQueueOutputArgs) ElementType() reflect.Type

type LookupQueueResult

type LookupQueueResult struct {
	// Compartment Identifier
	CompartmentId string `pulumi:"compartmentId"`
	// Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId string `pulumi:"customEncryptionKeyId"`
	// 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.
	DeadLetterQueueDeliveryCount int `pulumi:"deadLetterQueueDeliveryCount"`
	// Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags map[string]interface{} `pulumi:"definedTags"`
	// Queue Identifier, can be renamed
	DisplayName string `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags map[string]interface{} `pulumi:"freeformTags"`
	// Unique identifier that is immutable on creation
	Id string `pulumi:"id"`
	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	LifecycleDetails string `pulumi:"lifecycleDetails"`
	// The endpoint to use to consume or publish messages in the queue.
	MessagesEndpoint string `pulumi:"messagesEndpoint"`
	PurgeQueue       bool   `pulumi:"purgeQueue"`
	PurgeType        string `pulumi:"purgeType"`
	QueueId          string `pulumi:"queueId"`
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds int `pulumi:"retentionInSeconds"`
	// The current state of the Queue.
	State string `pulumi:"state"`
	// Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
	SystemTags map[string]interface{} `pulumi:"systemTags"`
	// The time the the Queue was created. An RFC3339 formatted datetime string
	TimeCreated string `pulumi:"timeCreated"`
	// The time the Queue was updated. An RFC3339 formatted datetime string
	TimeUpdated string `pulumi:"timeUpdated"`
	// The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds int `pulumi:"timeoutInSeconds"`
	// The default visibility of the messages consumed from the queue.
	VisibilityInSeconds int `pulumi:"visibilityInSeconds"`
}

A collection of values returned by getQueue.

func LookupQueue

func LookupQueue(ctx *pulumi.Context, args *LookupQueueArgs, opts ...pulumi.InvokeOption) (*LookupQueueResult, error)

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

Gets a Queue by identifier

## Example Usage

```go 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
	})
}

```

type LookupQueueResultOutput

type LookupQueueResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getQueue.

func (LookupQueueResultOutput) CompartmentId

func (o LookupQueueResultOutput) CompartmentId() pulumi.StringOutput

Compartment Identifier

func (LookupQueueResultOutput) CustomEncryptionKeyId

func (o LookupQueueResultOutput) CustomEncryptionKeyId() pulumi.StringOutput

Id of the custom master encryption key which will be used to encrypt messages content

func (LookupQueueResultOutput) DeadLetterQueueDeliveryCount

func (o LookupQueueResultOutput) DeadLetterQueueDeliveryCount() pulumi.IntOutput

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.

func (LookupQueueResultOutput) DefinedTags

func (o LookupQueueResultOutput) DefinedTags() pulumi.MapOutput

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`

func (LookupQueueResultOutput) DisplayName

Queue Identifier, can be renamed

func (LookupQueueResultOutput) ElementType

func (LookupQueueResultOutput) ElementType() reflect.Type

func (LookupQueueResultOutput) FreeformTags

func (o LookupQueueResultOutput) FreeformTags() pulumi.MapOutput

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

func (LookupQueueResultOutput) Id

Unique identifier that is immutable on creation

func (LookupQueueResultOutput) LifecycleDetails

func (o LookupQueueResultOutput) LifecycleDetails() pulumi.StringOutput

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

func (LookupQueueResultOutput) MessagesEndpoint

func (o LookupQueueResultOutput) MessagesEndpoint() pulumi.StringOutput

The endpoint to use to consume or publish messages in the queue.

func (LookupQueueResultOutput) PurgeQueue

func (o LookupQueueResultOutput) PurgeQueue() pulumi.BoolOutput

func (LookupQueueResultOutput) PurgeType

func (LookupQueueResultOutput) QueueId

func (LookupQueueResultOutput) RetentionInSeconds

func (o LookupQueueResultOutput) RetentionInSeconds() pulumi.IntOutput

The retention period of the messages in the queue, in seconds.

func (LookupQueueResultOutput) State

The current state of the Queue.

func (LookupQueueResultOutput) SystemTags

func (o LookupQueueResultOutput) SystemTags() pulumi.MapOutput

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`

func (LookupQueueResultOutput) TimeCreated

The time the the Queue was created. An RFC3339 formatted datetime string

func (LookupQueueResultOutput) TimeUpdated

The time the Queue was updated. An RFC3339 formatted datetime string

func (LookupQueueResultOutput) TimeoutInSeconds

func (o LookupQueueResultOutput) TimeoutInSeconds() pulumi.IntOutput

The default polling timeout of the messages in the queue, in seconds.

func (LookupQueueResultOutput) ToLookupQueueResultOutput

func (o LookupQueueResultOutput) ToLookupQueueResultOutput() LookupQueueResultOutput

func (LookupQueueResultOutput) ToLookupQueueResultOutputWithContext

func (o LookupQueueResultOutput) ToLookupQueueResultOutputWithContext(ctx context.Context) LookupQueueResultOutput

func (LookupQueueResultOutput) VisibilityInSeconds

func (o LookupQueueResultOutput) VisibilityInSeconds() pulumi.IntOutput

The default visibility of the messages consumed from the queue.

type Queue

type Queue struct {
	pulumi.CustomResourceState

	// (Updatable) Compartment Identifier
	CompartmentId pulumi.StringOutput `pulumi:"compartmentId"`
	// (Updatable) Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId pulumi.StringOutput `pulumi:"customEncryptionKeyId"`
	// (Updatable) 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.
	DeadLetterQueueDeliveryCount pulumi.IntOutput `pulumi:"deadLetterQueueDeliveryCount"`
	// (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags pulumi.MapOutput `pulumi:"definedTags"`
	// (Updatable) Queue Identifier
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags pulumi.MapOutput `pulumi:"freeformTags"`
	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	LifecycleDetails pulumi.StringOutput `pulumi:"lifecycleDetails"`
	// The endpoint to use to consume or publish messages in the queue.
	MessagesEndpoint pulumi.StringOutput    `pulumi:"messagesEndpoint"`
	PurgeQueue       pulumi.BoolPtrOutput   `pulumi:"purgeQueue"`
	PurgeType        pulumi.StringPtrOutput `pulumi:"purgeType"`
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds pulumi.IntOutput `pulumi:"retentionInSeconds"`
	// The current state of the Queue.
	State pulumi.StringOutput `pulumi:"state"`
	// Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
	SystemTags pulumi.MapOutput `pulumi:"systemTags"`
	// The time the the Queue was created. An RFC3339 formatted datetime string
	TimeCreated pulumi.StringOutput `pulumi:"timeCreated"`
	// The time the Queue was updated. An RFC3339 formatted datetime string
	TimeUpdated pulumi.StringOutput `pulumi:"timeUpdated"`
	// (Updatable) The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds pulumi.IntOutput `pulumi:"timeoutInSeconds"`
	// (Updatable) The default visibility of the messages consumed from the queue.
	VisibilityInSeconds pulumi.IntOutput `pulumi:"visibilityInSeconds"`
}

This resource provides the Queue resource in Oracle Cloud Infrastructure Queue service.

Creates a new Queue.

## Example Usage

```go 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.NewQueue(ctx, "testQueue", &Queue.QueueArgs{
			CompartmentId:                pulumi.Any(_var.Compartment_id),
			DisplayName:                  pulumi.Any(_var.Queue_display_name),
			CustomEncryptionKeyId:        pulumi.Any(oci_kms_key.Test_key.Id),
			DeadLetterQueueDeliveryCount: pulumi.Any(_var.Queue_dead_letter_queue_delivery_count),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			RetentionInSeconds:  pulumi.Any(_var.Queue_retention_in_seconds),
			TimeoutInSeconds:    pulumi.Any(_var.Queue_timeout_in_seconds),
			VisibilityInSeconds: pulumi.Any(_var.Queue_visibility_in_seconds),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Queues can be imported using the `id`, e.g.

```sh

$ pulumi import oci:Queue/queue:Queue test_queue "id"

```

func GetQueue

func GetQueue(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueueState, opts ...pulumi.ResourceOption) (*Queue, error)

GetQueue gets an existing Queue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewQueue

func NewQueue(ctx *pulumi.Context,
	name string, args *QueueArgs, opts ...pulumi.ResourceOption) (*Queue, error)

NewQueue registers a new resource with the given unique name, arguments, and options.

func (*Queue) ElementType

func (*Queue) ElementType() reflect.Type

func (*Queue) ToQueueOutput

func (i *Queue) ToQueueOutput() QueueOutput

func (*Queue) ToQueueOutputWithContext

func (i *Queue) ToQueueOutputWithContext(ctx context.Context) QueueOutput

type QueueArgs

type QueueArgs struct {
	// (Updatable) Compartment Identifier
	CompartmentId pulumi.StringInput
	// (Updatable) Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId pulumi.StringPtrInput
	// (Updatable) 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.
	DeadLetterQueueDeliveryCount pulumi.IntPtrInput
	// (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags pulumi.MapInput
	// (Updatable) Queue Identifier
	DisplayName pulumi.StringInput
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags pulumi.MapInput
	PurgeQueue   pulumi.BoolPtrInput
	PurgeType    pulumi.StringPtrInput
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds pulumi.IntPtrInput
	// (Updatable) The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds pulumi.IntPtrInput
	// (Updatable) The default visibility of the messages consumed from the queue.
	VisibilityInSeconds pulumi.IntPtrInput
}

The set of arguments for constructing a Queue resource.

func (QueueArgs) ElementType

func (QueueArgs) ElementType() reflect.Type

type QueueArray

type QueueArray []QueueInput

func (QueueArray) ElementType

func (QueueArray) ElementType() reflect.Type

func (QueueArray) ToQueueArrayOutput

func (i QueueArray) ToQueueArrayOutput() QueueArrayOutput

func (QueueArray) ToQueueArrayOutputWithContext

func (i QueueArray) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueArrayInput

type QueueArrayInput interface {
	pulumi.Input

	ToQueueArrayOutput() QueueArrayOutput
	ToQueueArrayOutputWithContext(context.Context) QueueArrayOutput
}

QueueArrayInput is an input type that accepts QueueArray and QueueArrayOutput values. You can construct a concrete instance of `QueueArrayInput` via:

QueueArray{ QueueArgs{...} }

type QueueArrayOutput

type QueueArrayOutput struct{ *pulumi.OutputState }

func (QueueArrayOutput) ElementType

func (QueueArrayOutput) ElementType() reflect.Type

func (QueueArrayOutput) Index

func (QueueArrayOutput) ToQueueArrayOutput

func (o QueueArrayOutput) ToQueueArrayOutput() QueueArrayOutput

func (QueueArrayOutput) ToQueueArrayOutputWithContext

func (o QueueArrayOutput) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueInput

type QueueInput interface {
	pulumi.Input

	ToQueueOutput() QueueOutput
	ToQueueOutputWithContext(ctx context.Context) QueueOutput
}

type QueueMap

type QueueMap map[string]QueueInput

func (QueueMap) ElementType

func (QueueMap) ElementType() reflect.Type

func (QueueMap) ToQueueMapOutput

func (i QueueMap) ToQueueMapOutput() QueueMapOutput

func (QueueMap) ToQueueMapOutputWithContext

func (i QueueMap) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueMapInput

type QueueMapInput interface {
	pulumi.Input

	ToQueueMapOutput() QueueMapOutput
	ToQueueMapOutputWithContext(context.Context) QueueMapOutput
}

QueueMapInput is an input type that accepts QueueMap and QueueMapOutput values. You can construct a concrete instance of `QueueMapInput` via:

QueueMap{ "key": QueueArgs{...} }

type QueueMapOutput

type QueueMapOutput struct{ *pulumi.OutputState }

func (QueueMapOutput) ElementType

func (QueueMapOutput) ElementType() reflect.Type

func (QueueMapOutput) MapIndex

func (QueueMapOutput) ToQueueMapOutput

func (o QueueMapOutput) ToQueueMapOutput() QueueMapOutput

func (QueueMapOutput) ToQueueMapOutputWithContext

func (o QueueMapOutput) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueOutput

type QueueOutput struct{ *pulumi.OutputState }

func (QueueOutput) CompartmentId

func (o QueueOutput) CompartmentId() pulumi.StringOutput

(Updatable) Compartment Identifier

func (QueueOutput) CustomEncryptionKeyId

func (o QueueOutput) CustomEncryptionKeyId() pulumi.StringOutput

(Updatable) Id of the custom master encryption key which will be used to encrypt messages content

func (QueueOutput) DeadLetterQueueDeliveryCount

func (o QueueOutput) DeadLetterQueueDeliveryCount() pulumi.IntOutput

(Updatable) 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.

func (QueueOutput) DefinedTags

func (o QueueOutput) DefinedTags() pulumi.MapOutput

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`

func (QueueOutput) DisplayName

func (o QueueOutput) DisplayName() pulumi.StringOutput

(Updatable) Queue Identifier

func (QueueOutput) ElementType

func (QueueOutput) ElementType() reflect.Type

func (QueueOutput) FreeformTags

func (o QueueOutput) FreeformTags() pulumi.MapOutput

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

func (QueueOutput) LifecycleDetails

func (o QueueOutput) LifecycleDetails() pulumi.StringOutput

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

func (QueueOutput) MessagesEndpoint

func (o QueueOutput) MessagesEndpoint() pulumi.StringOutput

The endpoint to use to consume or publish messages in the queue.

func (QueueOutput) PurgeQueue

func (o QueueOutput) PurgeQueue() pulumi.BoolPtrOutput

func (QueueOutput) PurgeType

func (o QueueOutput) PurgeType() pulumi.StringPtrOutput

func (QueueOutput) RetentionInSeconds

func (o QueueOutput) RetentionInSeconds() pulumi.IntOutput

The retention period of the messages in the queue, in seconds.

func (QueueOutput) State

func (o QueueOutput) State() pulumi.StringOutput

The current state of the Queue.

func (QueueOutput) SystemTags

func (o QueueOutput) SystemTags() pulumi.MapOutput

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`

func (QueueOutput) TimeCreated

func (o QueueOutput) TimeCreated() pulumi.StringOutput

The time the the Queue was created. An RFC3339 formatted datetime string

func (QueueOutput) TimeUpdated

func (o QueueOutput) TimeUpdated() pulumi.StringOutput

The time the Queue was updated. An RFC3339 formatted datetime string

func (QueueOutput) TimeoutInSeconds

func (o QueueOutput) TimeoutInSeconds() pulumi.IntOutput

(Updatable) The default polling timeout of the messages in the queue, in seconds.

func (QueueOutput) ToQueueOutput

func (o QueueOutput) ToQueueOutput() QueueOutput

func (QueueOutput) ToQueueOutputWithContext

func (o QueueOutput) ToQueueOutputWithContext(ctx context.Context) QueueOutput

func (QueueOutput) VisibilityInSeconds

func (o QueueOutput) VisibilityInSeconds() pulumi.IntOutput

(Updatable) The default visibility of the messages consumed from the queue.

type QueueState

type QueueState struct {
	// (Updatable) Compartment Identifier
	CompartmentId pulumi.StringPtrInput
	// (Updatable) Id of the custom master encryption key which will be used to encrypt messages content
	CustomEncryptionKeyId pulumi.StringPtrInput
	// (Updatable) 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.
	DeadLetterQueueDeliveryCount pulumi.IntPtrInput
	// (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
	DefinedTags pulumi.MapInput
	// (Updatable) Queue Identifier
	DisplayName pulumi.StringPtrInput
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
	FreeformTags pulumi.MapInput
	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	LifecycleDetails pulumi.StringPtrInput
	// The endpoint to use to consume or publish messages in the queue.
	MessagesEndpoint pulumi.StringPtrInput
	PurgeQueue       pulumi.BoolPtrInput
	PurgeType        pulumi.StringPtrInput
	// The retention period of the messages in the queue, in seconds.
	RetentionInSeconds pulumi.IntPtrInput
	// The current state of the Queue.
	State pulumi.StringPtrInput
	// Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
	SystemTags pulumi.MapInput
	// The time the the Queue was created. An RFC3339 formatted datetime string
	TimeCreated pulumi.StringPtrInput
	// The time the Queue was updated. An RFC3339 formatted datetime string
	TimeUpdated pulumi.StringPtrInput
	// (Updatable) The default polling timeout of the messages in the queue, in seconds.
	TimeoutInSeconds pulumi.IntPtrInput
	// (Updatable) The default visibility of the messages consumed from the queue.
	VisibilityInSeconds pulumi.IntPtrInput
}

func (QueueState) ElementType

func (QueueState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL