SubscriptionDescription Class
- java.
lang. Object - com.
microsoft. azure. servicebus. management. UnknownPropertiesHolder - com.
microsoft. azure. servicebus. management. SubscriptionDescription
- com.
- com.
public class SubscriptionDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
Represents the metadata description of the subscription.
Constructor Summary
Constructor | Description |
---|---|
SubscriptionDescription(String topicPath, String subscriptionName) |
Initializes a new instance of Subscription |
Method Summary
Methods inherited from java.lang.Object
Constructor Details
SubscriptionDescription
public SubscriptionDescription(String topicPath, String subscriptionName)
Initializes a new instance of SubscriptionDescription with the specified relative path.
Parameters:
- Path of the topic Max length is 260 chars. Cannot start or end with a slash. Cannot have restricted characters: '@','?','#','*'
- Name of the subscription Max length is 50 chars. Cannot have restricted characters: '@','?','#','*','/'
Method Details
equals
public boolean equals(Object o)
Overrides:
SubscriptionDescription.equals(Object o)Parameters:
getAutoDeleteOnIdle
public Duration getAutoDeleteOnIdle()
Returns:
getDefaultMessageTimeToLive
public Duration getDefaultMessageTimeToLive()
Time-To-Live 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 getTimeToLive() is not set on a message itself. Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.
Returns:
getEntityStatus
public EntityStatus getEntityStatus()
Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages.
Returns:
getForwardDeadLetteredMessagesTo
public String getForwardDeadLetteredMessagesTo()
Returns:
getForwardTo
public String getForwardTo()
Returns:
getLockDuration
public Duration getLockDuration()
The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.
Returns:
getMaxDeliveryCount
public int getMaxDeliveryCount()
The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired.
Returns:
getPath
public String getPath()
Returns:
getSubscriptionName
public String getSubscriptionName()
Returns:
getTopicPath
public String getTopicPath()
Returns:
getUserMetadata
public String getUserMetadata()
Returns:
hashCode
public int hashCode()
Overrides:
SubscriptionDescription.hashCode()isEnableBatchedOperations
public boolean isEnableBatchedOperations()
Returns:
isEnableDeadLetteringOnFilterEvaluationException
public boolean isEnableDeadLetteringOnFilterEvaluationException()
Returns:
isEnableDeadLetteringOnMessageExpiration
public boolean isEnableDeadLetteringOnMessageExpiration()
Indicates whether this subscription has dead letter support when a message expires.
Returns:
isRequiresSession
public boolean isRequiresSession()
Returns:
setAutoDeleteOnIdle
public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Parameters:
- The idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.
setDefaultMessageTimeToLive
public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Parameters:
- Sets the default message time to live value. Value cannot be lower than 1 second. See getDefaultMessageTimeToLive()
setEnableBatchedOperations
public void setEnableBatchedOperations(boolean enableBatchedOperations)
Parameters:
- Indicates whether server-side batched operations are enabled.
setEnableDeadLetteringOnFilterEvaluationException
public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)
Parameters:
- True if messages should be dead-lettered on filter evaluation exception. See isEnableDeadLetteringOnFilterEvaluationException()
setEnableDeadLetteringOnMessageExpiration
public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
Parameters:
- True if messages should be dead-lettered on expiration. See isEnableDeadLetteringOnMessageExpiration()
setEntityStatus
public void setEntityStatus(EntityStatus status)
Parameters:
- the status of the queue (Enabled / Disabled). When an entity is disabled, that entity cannot send or receive messages.
setForwardDeadLetteredMessagesTo
public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
Parameters:
- The path of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to. If set, user cannot manually receive dead-lettered messages from this subscription. The destination entity must already exist.
setForwardTo
public void setForwardTo(String forwardTo)
Parameters:
- The path of the recipient entity to which all the messages sent to the subscription are forwarded to. If set, user cannot manually receive messages from this subscription. The destination entity must be an already existing entity.
setLockDuration
public void setLockDuration(Duration lockDuration)
Sets The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.
Parameters:
- The duration of a peek lock. Max value is 5 minutes.
setMaxDeliveryCount
public void setMaxDeliveryCount(int maxDeliveryCount)
The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired.
Parameters:
- Minimum value is 1.
setRequiresSession
public void setRequiresSession(boolean requiresSession)
Parameters:
- Set to true if subscription should support sessions.
setUserMetadata
public void setUserMetadata(String userMetadata)
Parameters:
- Custom metdata that user can associate with the description. Cannot be null. Max length is 1024 chars
Applies to
Azure SDK for Java