Share via

SBQueueInner Class

  • Reference
Package:
com.azure.resourcemanager.servicebus.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-servicebus:2.44.0

public final class SBQueueInner
extends Resource

Description of queue Resource.

Constructor Summary

Constructor Description
SBQueueInner()

Creates an instance of SBQueueInner class.

Method Summary

Modifier and Type Method and Description
OffsetDateTime accessedAt()

Get the accessedAt property: Last time a message was sent, or the last time there was a receive request to this queue.
Duration autoDeleteOnIdle()

Get the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the queue is automatically deleted.
MessageCountDetails countDetails()

Get the countDetails property: Message Count Details.
OffsetDateTime createdAt()

Get the createdAt property: The exact time the message was created.
Boolean deadLetteringOnMessageExpiration()

Get the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.
Duration defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
Duration duplicateDetectionHistoryTimeWindow()

Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history.
Boolean enableBatchedOperations()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
Boolean enableExpress()

Get the enableExpress property: A value that indicates whether Express Entities are enabled.
Boolean enablePartitioning()

Get the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.
String forwardDeadLetteredMessagesTo()

Get the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.
String forwardTo()

Get the forwardTo property: Queue/Topic name to forward the messages.
static SBQueueInner fromJson(JsonReader jsonReader)

Reads an instance of SBQueueInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
String location()

Get the location property: The geo-location where the resource lives.
Duration lockDuration()

Get the lockDuration property: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers.
Integer maxDeliveryCount()

Get the maxDeliveryCount property: The maximum delivery count.
Long maxMessageSizeInKilobytes()

Get the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the queue.
Integer maxSizeInMegabytes()

Get the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
Long messageCount()

Get the messageCount property: The number of messages in the queue.
String name()

Get the name property: The name of the resource.
Boolean requiresDuplicateDetection()

Get the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
Boolean requiresSession()

Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
Long sizeInBytes()

Get the sizeInBytes property: The size of the queue, in bytes.
EntityStatus status()

Get the status property: Enumerates the possible values for the status of a messaging entity.
SystemData systemData()

Get the systemData property: The system meta data relating to this resource.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
OffsetDateTime updatedAt()

Get the updatedAt property: The exact time the message was updated.
void validate()

Validates the instance.
SBQueueInner withAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Set the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the queue is automatically deleted.
SBQueueInner withDeadLetteringOnMessageExpiration(Boolean deadLetteringOnMessageExpiration)

Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.
SBQueueInner withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
SBQueueInner withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history.
SBQueueInner withEnableBatchedOperations(Boolean enableBatchedOperations)

Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
SBQueueInner withEnableExpress(Boolean enableExpress)

Set the enableExpress property: A value that indicates whether Express Entities are enabled.
SBQueueInner withEnablePartitioning(Boolean enablePartitioning)

Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.
SBQueueInner withForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Set the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.
SBQueueInner withForwardTo(String forwardTo)

Set the forwardTo property: Queue/Topic name to forward the messages.
SBQueueInner withLockDuration(Duration lockDuration)

Set the lockDuration property: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers.
SBQueueInner withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: The maximum delivery count.
SBQueueInner withMaxMessageSizeInKilobytes(Long maxMessageSizeInKilobytes)

Set the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the queue.
SBQueueInner withMaxSizeInMegabytes(Integer maxSizeInMegabytes)

Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
SBQueueInner withRequiresDuplicateDetection(Boolean requiresDuplicateDetection)

Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
SBQueueInner withRequiresSession(Boolean requiresSession)

Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
SBQueueInner withStatus(EntityStatus status)

Set the status property: Enumerates the possible values for the status of a messaging entity.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SBQueueInner

public SBQueueInner()

Creates an instance of SBQueueInner class.

Method Details

accessedAt

public OffsetDateTime accessedAt()

Get the accessedAt property: Last time a message was sent, or the last time there was a receive request to this queue.

Returns:

the accessedAt value.

autoDeleteOnIdle

public Duration autoDeleteOnIdle()

Get the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

Returns:

the autoDeleteOnIdle value.

countDetails

public MessageCountDetails countDetails()

Get the countDetails property: Message Count Details.

Returns:

the countDetails value.

createdAt

public OffsetDateTime createdAt()

Get the createdAt property: The exact time the message was created.

Returns:

the createdAt value.

deadLetteringOnMessageExpiration

public Boolean deadLetteringOnMessageExpiration()

Get the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.

Returns:

the deadLetteringOnMessageExpiration value.

defaultMessageTimeToLive

public Duration defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: 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.

Returns:

the defaultMessageTimeToLive value.

duplicateDetectionHistoryTimeWindow

public Duration duplicateDetectionHistoryTimeWindow()

Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Returns:

the duplicateDetectionHistoryTimeWindow value.

enableBatchedOperations

public Boolean enableBatchedOperations()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Returns:

the enableBatchedOperations value.

enableExpress

public Boolean enableExpress()

Get the enableExpress property: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

Returns:

the enableExpress value.

enablePartitioning

public Boolean enablePartitioning()

Get the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.

Returns:

the enablePartitioning value.

forwardDeadLetteredMessagesTo

public String forwardDeadLetteredMessagesTo()

Get the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.

Returns:

the forwardDeadLetteredMessagesTo value.

forwardTo

public String forwardTo()

Get the forwardTo property: Queue/Topic name to forward the messages.

Returns:

the forwardTo value.

fromJson

public static SBQueueInner fromJson(JsonReader jsonReader)

Reads an instance of SBQueueInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SBQueueInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SBQueueInner.id()

Returns:

the id value.

location

public String location()

Get the location property: The geo-location where the resource lives.

Overrides:

SBQueueInner.location()

Returns:

the location value.

lockDuration

public Duration lockDuration()

Get the lockDuration property: 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.

Returns:

the lockDuration value.

maxDeliveryCount

public Integer maxDeliveryCount()

Get the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

Returns:

the maxDeliveryCount value.

maxMessageSizeInKilobytes

public Long maxMessageSizeInKilobytes()

Get the maxMessageSizeInKilobytes property: 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.

Returns:

the maxMessageSizeInKilobytes value.

maxSizeInMegabytes

public Integer maxSizeInMegabytes()

Get the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

Returns:

the maxSizeInMegabytes value.

messageCount

public Long messageCount()

Get the messageCount property: The number of messages in the queue.

Returns:

the messageCount value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SBQueueInner.name()

Returns:

the name value.

requiresDuplicateDetection

public Boolean requiresDuplicateDetection()

Get the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.

Returns:

the requiresDuplicateDetection value.

requiresSession

public Boolean requiresSession()

Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.

Returns:

the requiresSession value.

sizeInBytes

public Long sizeInBytes()

Get the sizeInBytes property: The size of the queue, in bytes.

Returns:

the sizeInBytes value.

status

public EntityStatus status()

Get the status property: Enumerates the possible values for the status of a messaging entity.

Returns:

the status value.

systemData

public SystemData systemData()

Get the systemData property: The system meta data relating to this resource.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SBQueueInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

SBQueueInner.type()

Returns:

the type value.

updatedAt

public OffsetDateTime updatedAt()

Get the updatedAt property: The exact time the message was updated.

Returns:

the updatedAt value.

validate

public void validate()

Validates the instance.

withAutoDeleteOnIdle

public SBQueueInner withAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Set the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

Parameters:

autoDeleteOnIdle - the autoDeleteOnIdle value to set.

Returns:

the SBQueueInner object itself.

withDeadLetteringOnMessageExpiration

public SBQueueInner withDeadLetteringOnMessageExpiration(Boolean deadLetteringOnMessageExpiration)

Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.

Parameters:

deadLetteringOnMessageExpiration - the deadLetteringOnMessageExpiration value to set.

Returns:

the SBQueueInner object itself.

withDefaultMessageTimeToLive

public SBQueueInner withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: 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.

Parameters:

defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.

Returns:

the SBQueueInner object itself.

withDuplicateDetectionHistoryTimeWindow

public SBQueueInner withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Parameters:

duplicateDetectionHistoryTimeWindow - the duplicateDetectionHistoryTimeWindow value to set.

Returns:

the SBQueueInner object itself.

withEnableBatchedOperations

public SBQueueInner withEnableBatchedOperations(Boolean enableBatchedOperations)

Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Parameters:

enableBatchedOperations - the enableBatchedOperations value to set.

Returns:

the SBQueueInner object itself.

withEnableExpress

public SBQueueInner withEnableExpress(Boolean enableExpress)

Set the enableExpress property: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

Parameters:

enableExpress - the enableExpress value to set.

Returns:

the SBQueueInner object itself.

withEnablePartitioning

public SBQueueInner withEnablePartitioning(Boolean enablePartitioning)

Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.

Parameters:

enablePartitioning - the enablePartitioning value to set.

Returns:

the SBQueueInner object itself.

withForwardDeadLetteredMessagesTo

public SBQueueInner withForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Set the forwardDeadLetteredMessagesTo property: Queue/Topic name to forward the Dead Letter message.

Parameters:

forwardDeadLetteredMessagesTo - the forwardDeadLetteredMessagesTo value to set.

Returns:

the SBQueueInner object itself.

withForwardTo

public SBQueueInner withForwardTo(String forwardTo)

Set the forwardTo property: Queue/Topic name to forward the messages.

Parameters:

forwardTo - the forwardTo value to set.

Returns:

the SBQueueInner object itself.

withLockDuration

public SBQueueInner withLockDuration(Duration lockDuration)

Set the lockDuration property: 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.

Parameters:

lockDuration - the lockDuration value to set.

Returns:

the SBQueueInner object itself.

withMaxDeliveryCount

public SBQueueInner withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

Parameters:

maxDeliveryCount - the maxDeliveryCount value to set.

Returns:

the SBQueueInner object itself.

withMaxMessageSizeInKilobytes

public SBQueueInner withMaxMessageSizeInKilobytes(Long maxMessageSizeInKilobytes)

Set the maxMessageSizeInKilobytes property: 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.

Parameters:

maxMessageSizeInKilobytes - the maxMessageSizeInKilobytes value to set.

Returns:

the SBQueueInner object itself.

withMaxSizeInMegabytes

public SBQueueInner withMaxSizeInMegabytes(Integer maxSizeInMegabytes)

Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

Parameters:

maxSizeInMegabytes - the maxSizeInMegabytes value to set.

Returns:

the SBQueueInner object itself.

withRequiresDuplicateDetection

public SBQueueInner withRequiresDuplicateDetection(Boolean requiresDuplicateDetection)

Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.

Parameters:

requiresDuplicateDetection - the requiresDuplicateDetection value to set.

Returns:

the SBQueueInner object itself.

withRequiresSession

public SBQueueInner withRequiresSession(Boolean requiresSession)

Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.

Parameters:

requiresSession - the requiresSession value to set.

Returns:

the SBQueueInner object itself.

withStatus

public SBQueueInner withStatus(EntityStatus status)

Set the status property: Enumerates the possible values for the status of a messaging entity.

Parameters:

status - the status value to set.

Returns:

the SBQueueInner object itself.

Applies to