com.azure.resourcemanager.servicebus.fluent.models

Class QueueResourceInner

java.lang.Object

com.azure.core.management.ProxyResource

com.azure.core.management.Resource

com.azure.resourcemanager.servicebus.fluent.models.QueueResourceInner

public class QueueResourceInner
extends com.azure.core.management.Resource

Description of queue Resource.

Constructor Summary

Constructors

Constructor and Description
QueueResourceInner()

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.
String	autoDeleteOnIdle() Get the autoDeleteOnIdle property: the 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.
String	defaultMessageTimeToLive() Get the defaultMessageTimeToLive property: The default message time to live value.
String	duplicateDetectionHistoryTimeWindow() Get the duplicateDetectionHistoryTimeWindow property: TimeSpan structure that defines the duration of the duplicate detection history.
Boolean	enableBatchedOperations() Get the enableBatchedOperations property: A 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.
EntityAvailabilityStatus	entityAvailabilityStatus() Get the entityAvailabilityStatus property: Entity availability status for the queue.
Boolean	isAnonymousAccessible() Get the isAnonymousAccessible property: A value that indicates whether the message is accessible anonymously.
String	location() Get the location property: Resource location.
String	lockDuration() Get the lockDuration property: The 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	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.
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.
Boolean	supportOrdering() Get the supportOrdering property: A value that indicates whether the queue supports ordering.
OffsetDateTime	updatedAt() Get the updatedAt property: The exact time the message was updated.
void	validate() Validates the instance.
QueueResourceInner	withAutoDeleteOnIdle(String autoDeleteOnIdle) Set the autoDeleteOnIdle property: the TimeSpan idle interval after which the queue is automatically deleted.
QueueResourceInner	withDeadLetteringOnMessageExpiration(Boolean deadLetteringOnMessageExpiration) Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.
QueueResourceInner	withDefaultMessageTimeToLive(String defaultMessageTimeToLive) Set the defaultMessageTimeToLive property: The default message time to live value.
QueueResourceInner	withDuplicateDetectionHistoryTimeWindow(String duplicateDetectionHistoryTimeWindow) Set the duplicateDetectionHistoryTimeWindow property: TimeSpan structure that defines the duration of the duplicate detection history.
QueueResourceInner	withEnableBatchedOperations(Boolean enableBatchedOperations) Set the enableBatchedOperations property: A value that indicates whether server-side batched operations are enabled.
QueueResourceInner	withEnableExpress(Boolean enableExpress) Set the enableExpress property: A value that indicates whether Express Entities are enabled.
QueueResourceInner	withEnablePartitioning(Boolean enablePartitioning) Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.
QueueResourceInner	withEntityAvailabilityStatus(EntityAvailabilityStatus entityAvailabilityStatus) Set the entityAvailabilityStatus property: Entity availability status for the queue.
QueueResourceInner	withIsAnonymousAccessible(Boolean isAnonymousAccessible) Set the isAnonymousAccessible property: A value that indicates whether the message is accessible anonymously.
QueueResourceInner	withLocation(String location) Set the location property: Resource location.
QueueResourceInner	withLockDuration(String lockDuration) Set the lockDuration property: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers.
QueueResourceInner	withMaxDeliveryCount(Integer maxDeliveryCount) Set the maxDeliveryCount property: The maximum delivery count.
QueueResourceInner	withMaxSizeInMegabytes(Long maxSizeInMegabytes) Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
QueueResourceInner	withRequiresDuplicateDetection(Boolean requiresDuplicateDetection) Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
QueueResourceInner	withRequiresSession(Boolean requiresSession) Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
QueueResourceInner	withStatus(EntityStatus status) Set the status property: Enumerates the possible values for the status of a messaging entity.
QueueResourceInner	withSupportOrdering(Boolean supportOrdering) Set the supportOrdering property: A value that indicates whether the queue supports ordering.

Methods inherited from class com.azure.core.management.Resource

tags, withTags

Methods inherited from class com.azure.core.management.ProxyResource

id, name, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueueResourceInner

public QueueResourceInner()

Method Detail

lockDuration

public String lockDuration()

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

withLockDuration

public QueueResourceInner withLockDuration(String lockDuration)

Set the lockDuration property: The 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 QueueResourceInner object itself.

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 String autoDeleteOnIdle()

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

Returns:

the autoDeleteOnIdle value.

withAutoDeleteOnIdle

public QueueResourceInner withAutoDeleteOnIdle(String autoDeleteOnIdle)

Set the autoDeleteOnIdle property: the 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 QueueResourceInner object itself.

entityAvailabilityStatus

public EntityAvailabilityStatus entityAvailabilityStatus()

Get the entityAvailabilityStatus property: Entity availability status for the queue.

Returns:

the entityAvailabilityStatus value.

withEntityAvailabilityStatus

public QueueResourceInner withEntityAvailabilityStatus(EntityAvailabilityStatus entityAvailabilityStatus)

Set the entityAvailabilityStatus property: Entity availability status for the queue.

Parameters:

entityAvailabilityStatus - the entityAvailabilityStatus value to set.

Returns:

the QueueResourceInner object itself.

createdAt

public OffsetDateTime createdAt()

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

Returns:

the createdAt value.

defaultMessageTimeToLive

public String defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: The default message time 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.

withDefaultMessageTimeToLive

public QueueResourceInner withDefaultMessageTimeToLive(String defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: The default message time 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 QueueResourceInner object itself.

duplicateDetectionHistoryTimeWindow

public String duplicateDetectionHistoryTimeWindow()

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

Returns:

the duplicateDetectionHistoryTimeWindow value.

withDuplicateDetectionHistoryTimeWindow

public QueueResourceInner withDuplicateDetectionHistoryTimeWindow(String duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: 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 QueueResourceInner object itself.

enableBatchedOperations

public Boolean enableBatchedOperations()

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

Returns:

the enableBatchedOperations value.

withEnableBatchedOperations

public QueueResourceInner withEnableBatchedOperations(Boolean enableBatchedOperations)

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

Parameters:

enableBatchedOperations - the enableBatchedOperations value to set.

Returns:

the QueueResourceInner object itself.

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.

withDeadLetteringOnMessageExpiration

public QueueResourceInner 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 QueueResourceInner object itself.

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.

withEnableExpress

public QueueResourceInner 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 QueueResourceInner object itself.

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.

withEnablePartitioning

public QueueResourceInner 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 QueueResourceInner object itself.

isAnonymousAccessible

public Boolean isAnonymousAccessible()

Get the isAnonymousAccessible property: A value that indicates whether the message is accessible anonymously.

Returns:

the isAnonymousAccessible value.

withIsAnonymousAccessible

public QueueResourceInner withIsAnonymousAccessible(Boolean isAnonymousAccessible)

Set the isAnonymousAccessible property: A value that indicates whether the message is accessible anonymously.

Parameters:

isAnonymousAccessible - the isAnonymousAccessible value to set.

Returns:

the QueueResourceInner object itself.

maxDeliveryCount

public Integer maxDeliveryCount()

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

Returns:

the maxDeliveryCount value.

withMaxDeliveryCount

public QueueResourceInner withMaxDeliveryCount(Integer maxDeliveryCount)

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

Parameters:

maxDeliveryCount - the maxDeliveryCount value to set.

Returns:

the QueueResourceInner object itself.

maxSizeInMegabytes

public Long maxSizeInMegabytes()

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

Returns:

the maxSizeInMegabytes value.

withMaxSizeInMegabytes

public QueueResourceInner withMaxSizeInMegabytes(Long maxSizeInMegabytes)

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

Parameters:

maxSizeInMegabytes - the maxSizeInMegabytes value to set.

Returns:

the QueueResourceInner object itself.

messageCount

public Long messageCount()

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

Returns:

the messageCount value.

countDetails

public MessageCountDetails countDetails()

Get the countDetails property: Message Count Details.

Returns:

the countDetails value.

requiresDuplicateDetection

public Boolean requiresDuplicateDetection()

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

Returns:

the requiresDuplicateDetection value.

withRequiresDuplicateDetection

public QueueResourceInner 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 QueueResourceInner object itself.

requiresSession

public Boolean requiresSession()

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

Returns:

the requiresSession value.

withRequiresSession

public QueueResourceInner 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 QueueResourceInner object itself.

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.

withStatus

public QueueResourceInner 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 QueueResourceInner object itself.

supportOrdering

public Boolean supportOrdering()

Get the supportOrdering property: A value that indicates whether the queue supports ordering.

Returns:

the supportOrdering value.

withSupportOrdering

public QueueResourceInner withSupportOrdering(Boolean supportOrdering)

Set the supportOrdering property: A value that indicates whether the queue supports ordering.

Parameters:

supportOrdering - the supportOrdering value to set.

Returns:

the QueueResourceInner object itself.

updatedAt

public OffsetDateTime updatedAt()

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

Returns:

the updatedAt value.

location

public String location()

Get the location property: Resource location.

Overrides:

location in class com.azure.core.management.Resource

Returns:

the location value.

withLocation

public QueueResourceInner withLocation(String location)

Set the location property: Resource location.

Overrides:

withLocation in class com.azure.core.management.Resource

Parameters:

location - the location value to set.

Returns:

the QueueResourceInner object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.