Package com.azure.resourcemanager.servicebus.fluent.models

Class SBQueueInner

  • public class SBQueueInner
extends com.azure.core.management.Resource
    Description of queue Resource.

    • Constructor Detail

      • SBQueueInner

        public SBQueueInner()

    • Method Detail

      • 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.

      • updatedAt

        public OffsetDateTime updatedAt()
        Get the updatedAt property: The exact time the message was updated.
        Returns:
        the updatedAt value.

      • 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.

      • sizeInBytes

        public Long sizeInBytes()
        Get the sizeInBytes property: The size of the queue, in bytes.
        Returns:
        the sizeInBytes value.

      • messageCount

        public Long messageCount()
        Get the messageCount property: The number of messages in the queue.
        Returns:
        the messageCount 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.

      • 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.

      • 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.

      • 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.

      • requiresDuplicateDetection

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

      • 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.

      • 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 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.

      • 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.

      • 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.

      • 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 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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 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.

      • enableBatchedOperations

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

      • 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.

      • 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.

      • 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.

      • 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 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.

      • 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 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.

      • forwardTo

        public String forwardTo()
        Get the forwardTo property: Queue/Topic name to forward the messages.
        Returns:
        the forwardTo value.

      • 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.

      • forwardDeadLetteredMessagesTo

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

      • 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.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.