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

Class SBSubscriptionInner

  • public class SBSubscriptionInner
extends com.azure.core.management.Resource
    Description of subscription resource.

    • Constructor Detail

      • SBSubscriptionInner

        public SBSubscriptionInner()

    • Method Detail

      • messageCount

        public Long messageCount()
        Get the messageCount property: Number of messages.
        Returns:
        the messageCount value.

      • createdAt

        public OffsetDateTime createdAt()
        Get the createdAt property: Exact time the message was created.
        Returns:
        the createdAt value.

      • accessedAt

        public OffsetDateTime accessedAt()
        Get the accessedAt property: Last time there was a receive request to this subscription.
        Returns:
        the accessedAt value.

      • updatedAt

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

      • countDetails

        public MessageCountDetails countDetails()
        Get the countDetails property: Message count details.
        Returns:
        the countDetails value.

      • lockDuration

        public Duration lockDuration()
        Get the lockDuration property: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
        Returns:
        the lockDuration value.

      • withLockDuration

        public SBSubscriptionInner withLockDuration​(Duration lockDuration)
        Set the lockDuration property: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
        Parameters:
        lockDuration - the lockDuration value to set.
        Returns:
        the SBSubscriptionInner object itself.

      • requiresSession

        public Boolean requiresSession()
        Get the requiresSession property: Value indicating if a subscription supports the concept of sessions.
        Returns:
        the requiresSession value.

      • withRequiresSession

        public SBSubscriptionInner withRequiresSession​(Boolean requiresSession)
        Set the requiresSession property: Value indicating if a subscription supports the concept of sessions.
        Parameters:
        requiresSession - the requiresSession value to set.
        Returns:
        the SBSubscriptionInner object itself.

      • defaultMessageTimeToLive

        public Duration defaultMessageTimeToLive()
        Get the defaultMessageTimeToLive property: ISO 8061 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 SBSubscriptionInner withDefaultMessageTimeToLive​(Duration defaultMessageTimeToLive)
        Set the defaultMessageTimeToLive property: ISO 8061 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 SBSubscriptionInner object itself.

      • deadLetteringOnFilterEvaluationExceptions

        public Boolean deadLetteringOnFilterEvaluationExceptions()
        Get the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
        Returns:
        the deadLetteringOnFilterEvaluationExceptions value.

      • withDeadLetteringOnFilterEvaluationExceptions

        public SBSubscriptionInner withDeadLetteringOnFilterEvaluationExceptions​(Boolean deadLetteringOnFilterEvaluationExceptions)
        Set the deadLetteringOnFilterEvaluationExceptions property: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
        Parameters:
        deadLetteringOnFilterEvaluationExceptions - the deadLetteringOnFilterEvaluationExceptions value to set.
        Returns:
        the SBSubscriptionInner object itself.

      • deadLetteringOnMessageExpiration

        public Boolean deadLetteringOnMessageExpiration()
        Get the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.
        Returns:
        the deadLetteringOnMessageExpiration value.

      • withDeadLetteringOnMessageExpiration

        public SBSubscriptionInner withDeadLetteringOnMessageExpiration​(Boolean deadLetteringOnMessageExpiration)
        Set the deadLetteringOnMessageExpiration property: Value that indicates whether a subscription has dead letter support when a message expires.
        Parameters:
        deadLetteringOnMessageExpiration - the deadLetteringOnMessageExpiration value to set.
        Returns:
        the SBSubscriptionInner 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 SBSubscriptionInner 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 SBSubscriptionInner object itself.

      • maxDeliveryCount

        public Integer maxDeliveryCount()
        Get the maxDeliveryCount property: Number of maximum deliveries.
        Returns:
        the maxDeliveryCount value.

      • withMaxDeliveryCount

        public SBSubscriptionInner withMaxDeliveryCount​(Integer maxDeliveryCount)
        Set the maxDeliveryCount property: Number of maximum deliveries.
        Parameters:
        maxDeliveryCount - the maxDeliveryCount value to set.
        Returns:
        the SBSubscriptionInner 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 SBSubscriptionInner 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 SBSubscriptionInner 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 SBSubscriptionInner 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 SBSubscriptionInner object itself.

      • autoDeleteOnIdle

        public Duration autoDeleteOnIdle()
        Get the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
        Returns:
        the autoDeleteOnIdle value.

      • withAutoDeleteOnIdle

        public SBSubscriptionInner withAutoDeleteOnIdle​(Duration autoDeleteOnIdle)
        Set the autoDeleteOnIdle property: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
        Parameters:
        autoDeleteOnIdle - the autoDeleteOnIdle value to set.
        Returns:
        the SBSubscriptionInner object itself.

      • forwardTo

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

      • withForwardTo

        public SBSubscriptionInner withForwardTo​(String forwardTo)
        Set the forwardTo property: Queue/Topic name to forward the messages.
        Parameters:
        forwardTo - the forwardTo value to set.
        Returns:
        the SBSubscriptionInner 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 SBSubscriptionInner 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 SBSubscriptionInner object itself.

      • validate

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