Package com.azure.messaging.servicebus.administration.models

Class SubscriptionProperties

java.lang.Object
com.azure.messaging.servicebus.administration.models.SubscriptionProperties
public final class SubscriptionProperties extends Object
Properties on a subscription.
See Also:

  • Method Details

    • getTopicName

      public String getTopicName()
      Gets the name of the topic under which subscription exists.
      Returns:
      The name of the topic under which subscription exists.

    • getSubscriptionName

      public String getSubscriptionName()
      Gets the name of the subscription.
      Returns:
      The name of the subscription.

    • getLockDuration

      public Duration getLockDuration()
      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.

    • setLockDuration

      public SubscriptionProperties setLockDuration(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 SubscriptionProperties object itself.

    • isSessionRequired

      public boolean isSessionRequired()
      Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
      Returns:
      the requiresSession value.

    • getDefaultMessageTimeToLive

      public Duration getDefaultMessageTimeToLive()
      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.

    • setDefaultMessageTimeToLive

      public SubscriptionProperties setDefaultMessageTimeToLive(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 SubscriptionProperties object itself.

    • isDeadLetteringOnMessageExpiration

      public boolean isDeadLetteringOnMessageExpiration()
      Get the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires.
      Returns:
      the deadLetteringOnMessageExpiration value.

    • setDeadLetteringOnMessageExpiration

      public SubscriptionProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
      Set the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires.
      Parameters:
      deadLetteringOnMessageExpiration - the deadLetteringOnMessageExpiration value to set.
      Returns:
      the SubscriptionProperties object itself.

    • isDeadLetteringOnFilterEvaluationExceptions

      public boolean isDeadLetteringOnFilterEvaluationExceptions()
      Get the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires.
      Returns:
      the deadLetteringOnFilterEvaluationExceptions value.

    • setEnableDeadLetteringOnFilterEvaluationExceptions

      public SubscriptionProperties setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)
      Set the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires.
      Parameters:
      deadLetteringOnFilterEvaluationExceptions - the deadLetteringOnFilterEvaluationExceptions value to set.
      Returns:
      the SubscriptionProperties object itself.

    • getMaxDeliveryCount

      public int getMaxDeliveryCount()
      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.

    • setMaxDeliveryCount

      public SubscriptionProperties setMaxDeliveryCount(int 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 SubscriptionProperties object itself.

    • isBatchedOperationsEnabled

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

    • setBatchedOperationsEnabled

      public SubscriptionProperties setBatchedOperationsEnabled(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 SubscriptionProperties object itself.

    • getStatus

      public EntityStatus getStatus()
      Get the status property: Status of a Service Bus resource.
      Returns:
      the status value.

    • setStatus

      public SubscriptionProperties setStatus(EntityStatus status)
      Set the status property: Status of a Service Bus resource.
      Parameters:
      status - the status value to set.
      Returns:
      the SubscriptionProperties object itself.

    • getForwardTo

      public String getForwardTo()
      Get the forwardTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to.
      Returns:
      the forwardTo value.

    • setForwardTo

      public SubscriptionProperties setForwardTo(String forwardTo)
      Set the forwardTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to.
      Parameters:
      forwardTo - the forwardTo value to set.
      Returns:
      the SubscriptionProperties object itself.

    • getUserMetadata

      public String getUserMetadata()
      Get the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024.
      Returns:
      the userMetadata value.

    • setUserMetadata

      public SubscriptionProperties setUserMetadata(String userMetadata)
      Set the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024.
      Parameters:
      userMetadata - the userMetadata value to set.
      Returns:
      the SubscriptionProperties object itself.

    • getForwardDeadLetteredMessagesTo

      public String getForwardDeadLetteredMessagesTo()
      Get the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to.
      Returns:
      the forwardDeadLetteredMessagesTo value.

    • setForwardDeadLetteredMessagesTo

      public SubscriptionProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
      Set the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to.
      Parameters:
      forwardDeadLetteredMessagesTo - the forwardDeadLetteredMessagesTo value to set.
      Returns:
      the SubscriptionProperties object itself.

    • getAutoDeleteOnIdle

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

    • setAutoDeleteOnIdle

      public SubscriptionProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
      Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.
      Parameters:
      autoDeleteOnIdle - the autoDeleteOnIdle value to set.
      Returns:
      the SubscriptionProperties object itself.