com.pulumi.azurenative.servicebus.kotlin.QueueArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-native-kotlin Show documentation
Show all versions of pulumi-azure-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azurenative.servicebus.kotlin
import com.pulumi.azurenative.servicebus.QueueArgs.builder
import com.pulumi.azurenative.servicebus.kotlin.enums.EntityStatus
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Description of queue Resource.
* Azure REST API version: 2022-01-01-preview. Prior API version in Azure Native 1.x: 2017-04-01.
* Other available API versions: 2015-08-01, 2022-10-01-preview, 2023-01-01-preview.
* ## Example Usage
* ### QueueCreate
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var queue = new AzureNative.ServiceBus.Queue("queue", new()
* {
* EnablePartitioning = true,
* NamespaceName = "sdk-Namespace-3174",
* QueueName = "sdk-Queues-5647",
* ResourceGroupName = "ArunMonocle",
* });
* });
* ```
* ```go
* package main
* import (
* servicebus "github.com/pulumi/pulumi-azure-native-sdk/servicebus/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := servicebus.NewQueue(ctx, "queue", &servicebus.QueueArgs{
* EnablePartitioning: pulumi.Bool(true),
* NamespaceName: pulumi.String("sdk-Namespace-3174"),
* QueueName: pulumi.String("sdk-Queues-5647"),
* ResourceGroupName: pulumi.String("ArunMonocle"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.servicebus.Queue;
* import com.pulumi.azurenative.servicebus.QueueArgs;
* 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) {
* var queue = new Queue("queue", QueueArgs.builder()
* .enablePartitioning(true)
* .namespaceName("sdk-Namespace-3174")
* .queueName("sdk-Queues-5647")
* .resourceGroupName("ArunMonocle")
* .build());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:servicebus:Queue sdk-Queues-5647 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
* ```
* @property autoDeleteOnIdle ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
* @property deadLetteringOnMessageExpiration A value that indicates whether this queue has dead letter support when a message expires.
* @property defaultMessageTimeToLive ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
* @property duplicateDetectionHistoryTimeWindow ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
* @property enableBatchedOperations Value that indicates whether server-side batched operations are enabled.
* @property enableExpress A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
* @property enablePartitioning A value that indicates whether the queue is to be partitioned across multiple message brokers.
* @property forwardDeadLetteredMessagesTo Queue/Topic name to forward the Dead Letter message
* @property forwardTo Queue/Topic name to forward the messages
* @property lockDuration ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
* @property maxDeliveryCount The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
* @property maxMessageSizeInKilobytes Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
* @property maxSizeInMegabytes The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
* @property namespaceName The namespace name
* @property queueName The queue name.
* @property requiresDuplicateDetection A value indicating if this queue requires duplicate detection.
* @property requiresSession A value that indicates whether the queue supports the concept of sessions.
* @property resourceGroupName Name of the Resource group within the Azure subscription.
* @property status Enumerates the possible values for the status of a messaging entity.
*/
public data class QueueArgs(
public val autoDeleteOnIdle: Output? = null,
public val deadLetteringOnMessageExpiration: Output? = null,
public val defaultMessageTimeToLive: Output? = null,
public val duplicateDetectionHistoryTimeWindow: Output? = null,
public val enableBatchedOperations: Output? = null,
public val enableExpress: Output? = null,
public val enablePartitioning: Output? = null,
public val forwardDeadLetteredMessagesTo: Output? = null,
public val forwardTo: Output? = null,
public val lockDuration: Output? = null,
public val maxDeliveryCount: Output? = null,
public val maxMessageSizeInKilobytes: Output? = null,
public val maxSizeInMegabytes: Output? = null,
public val namespaceName: Output? = null,
public val queueName: Output? = null,
public val requiresDuplicateDetection: Output? = null,
public val requiresSession: Output? = null,
public val resourceGroupName: Output? = null,
public val status: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azurenative.servicebus.QueueArgs =
com.pulumi.azurenative.servicebus.QueueArgs.builder()
.autoDeleteOnIdle(autoDeleteOnIdle?.applyValue({ args0 -> args0 }))
.deadLetteringOnMessageExpiration(deadLetteringOnMessageExpiration?.applyValue({ args0 -> args0 }))
.defaultMessageTimeToLive(defaultMessageTimeToLive?.applyValue({ args0 -> args0 }))
.duplicateDetectionHistoryTimeWindow(
duplicateDetectionHistoryTimeWindow?.applyValue({ args0 ->
args0
}),
)
.enableBatchedOperations(enableBatchedOperations?.applyValue({ args0 -> args0 }))
.enableExpress(enableExpress?.applyValue({ args0 -> args0 }))
.enablePartitioning(enablePartitioning?.applyValue({ args0 -> args0 }))
.forwardDeadLetteredMessagesTo(forwardDeadLetteredMessagesTo?.applyValue({ args0 -> args0 }))
.forwardTo(forwardTo?.applyValue({ args0 -> args0 }))
.lockDuration(lockDuration?.applyValue({ args0 -> args0 }))
.maxDeliveryCount(maxDeliveryCount?.applyValue({ args0 -> args0 }))
.maxMessageSizeInKilobytes(maxMessageSizeInKilobytes?.applyValue({ args0 -> args0 }))
.maxSizeInMegabytes(maxSizeInMegabytes?.applyValue({ args0 -> args0 }))
.namespaceName(namespaceName?.applyValue({ args0 -> args0 }))
.queueName(queueName?.applyValue({ args0 -> args0 }))
.requiresDuplicateDetection(requiresDuplicateDetection?.applyValue({ args0 -> args0 }))
.requiresSession(requiresSession?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.status(status?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}
/**
* Builder for [QueueArgs].
*/
@PulumiTagMarker
public class QueueArgsBuilder internal constructor() {
private var autoDeleteOnIdle: Output? = null
private var deadLetteringOnMessageExpiration: Output? = null
private var defaultMessageTimeToLive: Output? = null
private var duplicateDetectionHistoryTimeWindow: Output? = null
private var enableBatchedOperations: Output? = null
private var enableExpress: Output? = null
private var enablePartitioning: Output? = null
private var forwardDeadLetteredMessagesTo: Output? = null
private var forwardTo: Output? = null
private var lockDuration: Output? = null
private var maxDeliveryCount: Output? = null
private var maxMessageSizeInKilobytes: Output? = null
private var maxSizeInMegabytes: Output? = null
private var namespaceName: Output? = null
private var queueName: Output? = null
private var requiresDuplicateDetection: Output? = null
private var requiresSession: Output? = null
private var resourceGroupName: Output? = null
private var status: Output? = null
/**
* @param value ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
*/
@JvmName("dtxgagufsdcuellv")
public suspend fun autoDeleteOnIdle(`value`: Output) {
this.autoDeleteOnIdle = value
}
/**
* @param value A value that indicates whether this queue has dead letter support when a message expires.
*/
@JvmName("uubavmyqxsprofca")
public suspend fun deadLetteringOnMessageExpiration(`value`: Output) {
this.deadLetteringOnMessageExpiration = value
}
/**
* @param value ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
*/
@JvmName("xpihhdexxncnplwi")
public suspend fun defaultMessageTimeToLive(`value`: Output) {
this.defaultMessageTimeToLive = value
}
/**
* @param value ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
*/
@JvmName("bbneowivetkysmtx")
public suspend fun duplicateDetectionHistoryTimeWindow(`value`: Output) {
this.duplicateDetectionHistoryTimeWindow = value
}
/**
* @param value Value that indicates whether server-side batched operations are enabled.
*/
@JvmName("dsevcltghgnvsxub")
public suspend fun enableBatchedOperations(`value`: Output) {
this.enableBatchedOperations = value
}
/**
* @param value A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
*/
@JvmName("hfiwuhbvjcqvvkbw")
public suspend fun enableExpress(`value`: Output) {
this.enableExpress = value
}
/**
* @param value A value that indicates whether the queue is to be partitioned across multiple message brokers.
*/
@JvmName("uglrlhojtuhwunkx")
public suspend fun enablePartitioning(`value`: Output) {
this.enablePartitioning = value
}
/**
* @param value Queue/Topic name to forward the Dead Letter message
*/
@JvmName("vyadifpopobdppum")
public suspend fun forwardDeadLetteredMessagesTo(`value`: Output) {
this.forwardDeadLetteredMessagesTo = value
}
/**
* @param value Queue/Topic name to forward the messages
*/
@JvmName("ttciftqxdmeouisk")
public suspend fun forwardTo(`value`: Output) {
this.forwardTo = value
}
/**
* @param value ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
*/
@JvmName("frxvjwaidlonxgjk")
public suspend fun lockDuration(`value`: Output) {
this.lockDuration = value
}
/**
* @param value The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
*/
@JvmName("qqdqxaymiqffqoik")
public suspend fun maxDeliveryCount(`value`: Output) {
this.maxDeliveryCount = value
}
/**
* @param value Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
*/
@JvmName("tlvkppsupnkaojot")
public suspend fun maxMessageSizeInKilobytes(`value`: Output) {
this.maxMessageSizeInKilobytes = value
}
/**
* @param value The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
*/
@JvmName("prrwsmtvufbnbtno")
public suspend fun maxSizeInMegabytes(`value`: Output) {
this.maxSizeInMegabytes = value
}
/**
* @param value The namespace name
*/
@JvmName("pwsmgiulwfkebjuu")
public suspend fun namespaceName(`value`: Output) {
this.namespaceName = value
}
/**
* @param value The queue name.
*/
@JvmName("fkvbxbkiobrkehtf")
public suspend fun queueName(`value`: Output) {
this.queueName = value
}
/**
* @param value A value indicating if this queue requires duplicate detection.
*/
@JvmName("xnlhqcutvqwpnfex")
public suspend fun requiresDuplicateDetection(`value`: Output) {
this.requiresDuplicateDetection = value
}
/**
* @param value A value that indicates whether the queue supports the concept of sessions.
*/
@JvmName("dycvsbdktbrygskw")
public suspend fun requiresSession(`value`: Output) {
this.requiresSession = value
}
/**
* @param value Name of the Resource group within the Azure subscription.
*/
@JvmName("fsybhrelgupxhkbg")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value Enumerates the possible values for the status of a messaging entity.
*/
@JvmName("gseidnfqmphmetpn")
public suspend fun status(`value`: Output) {
this.status = value
}
/**
* @param value ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
*/
@JvmName("icitfijyjvudjyen")
public suspend fun autoDeleteOnIdle(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.autoDeleteOnIdle = mapped
}
/**
* @param value A value that indicates whether this queue has dead letter support when a message expires.
*/
@JvmName("hwrkoytlisnusskc")
public suspend fun deadLetteringOnMessageExpiration(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.deadLetteringOnMessageExpiration = mapped
}
/**
* @param value ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
*/
@JvmName("tryoswgkdwcxmntc")
public suspend fun defaultMessageTimeToLive(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultMessageTimeToLive = mapped
}
/**
* @param value ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
*/
@JvmName("wetrphuyrntigjdu")
public suspend fun duplicateDetectionHistoryTimeWindow(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.duplicateDetectionHistoryTimeWindow = mapped
}
/**
* @param value Value that indicates whether server-side batched operations are enabled.
*/
@JvmName("stculupwdncihank")
public suspend fun enableBatchedOperations(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableBatchedOperations = mapped
}
/**
* @param value A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
*/
@JvmName("hwhlffaxfngxdvex")
public suspend fun enableExpress(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableExpress = mapped
}
/**
* @param value A value that indicates whether the queue is to be partitioned across multiple message brokers.
*/
@JvmName("pjrioyahuspdfrsm")
public suspend fun enablePartitioning(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enablePartitioning = mapped
}
/**
* @param value Queue/Topic name to forward the Dead Letter message
*/
@JvmName("tqhwvirgiccrwsmw")
public suspend fun forwardDeadLetteredMessagesTo(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.forwardDeadLetteredMessagesTo = mapped
}
/**
* @param value Queue/Topic name to forward the messages
*/
@JvmName("tujbupbpqmjajywa")
public suspend fun forwardTo(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.forwardTo = mapped
}
/**
* @param value ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
*/
@JvmName("ejuswhjibmiqtdqo")
public suspend fun lockDuration(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.lockDuration = mapped
}
/**
* @param value The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
*/
@JvmName("gafpmyfkhnfokmvk")
public suspend fun maxDeliveryCount(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxDeliveryCount = mapped
}
/**
* @param value Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
*/
@JvmName("eaodowrvdvtigmil")
public suspend fun maxMessageSizeInKilobytes(`value`: Double?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxMessageSizeInKilobytes = mapped
}
/**
* @param value The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
*/
@JvmName("brkytbytkvrkmvwy")
public suspend fun maxSizeInMegabytes(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxSizeInMegabytes = mapped
}
/**
* @param value The namespace name
*/
@JvmName("xhfnpeeifhqvylkj")
public suspend fun namespaceName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.namespaceName = mapped
}
/**
* @param value The queue name.
*/
@JvmName("cbxjprrvhjrmgfbh")
public suspend fun queueName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.queueName = mapped
}
/**
* @param value A value indicating if this queue requires duplicate detection.
*/
@JvmName("lrdnchhuhjysrvaj")
public suspend fun requiresDuplicateDetection(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requiresDuplicateDetection = mapped
}
/**
* @param value A value that indicates whether the queue supports the concept of sessions.
*/
@JvmName("mqunkdunlwfqqtdx")
public suspend fun requiresSession(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requiresSession = mapped
}
/**
* @param value Name of the Resource group within the Azure subscription.
*/
@JvmName("inopfvoqddgcwfsi")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value Enumerates the possible values for the status of a messaging entity.
*/
@JvmName("rakapltshdbrbseg")
public suspend fun status(`value`: EntityStatus?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.status = mapped
}
internal fun build(): QueueArgs = QueueArgs(
autoDeleteOnIdle = autoDeleteOnIdle,
deadLetteringOnMessageExpiration = deadLetteringOnMessageExpiration,
defaultMessageTimeToLive = defaultMessageTimeToLive,
duplicateDetectionHistoryTimeWindow = duplicateDetectionHistoryTimeWindow,
enableBatchedOperations = enableBatchedOperations,
enableExpress = enableExpress,
enablePartitioning = enablePartitioning,
forwardDeadLetteredMessagesTo = forwardDeadLetteredMessagesTo,
forwardTo = forwardTo,
lockDuration = lockDuration,
maxDeliveryCount = maxDeliveryCount,
maxMessageSizeInKilobytes = maxMessageSizeInKilobytes,
maxSizeInMegabytes = maxSizeInMegabytes,
namespaceName = namespaceName,
queueName = queueName,
requiresDuplicateDetection = requiresDuplicateDetection,
requiresSession = requiresSession,
resourceGroupName = resourceGroupName,
status = status,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy