public final class SubscriptionProperties extends Object
Modifier and Type | Method and Description |
---|---|
Duration |
getAutoDeleteOnIdle()
Get the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the subscription is automatically
deleted.
|
Duration |
getDefaultMessageTimeToLive()
Get the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
String |
getForwardDeadLetteredMessagesTo()
Get the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the messages sent
to the subscription are forwarded to.
|
String |
getForwardTo()
Get the forwardTo property: The name of the recipient entity to which all the messages sent to the subscription
are forwarded to.
|
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.
|
int |
getMaxDeliveryCount()
Get the maxDeliveryCount property: The maximum delivery count.
|
EntityStatus |
getStatus()
Get the status property: Status of a Service Bus resource.
|
String |
getSubscriptionName()
Gets the name of the subscription.
|
String |
getTopicName()
Gets the name of the topic under which subscription exists.
|
String |
getUserMetadata()
Get the userMetadata property: Metadata associated with the subscription.
|
boolean |
isBatchedOperationsEnabled()
Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
boolean |
isDeadLetteringOnFilterEvaluationExceptions()
Get the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has
dead letter support when a message expires.
|
boolean |
isDeadLetteringOnMessageExpiration()
Get the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead
letter support when a message expires.
|
boolean |
isSessionRequired()
Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
|
SubscriptionProperties |
setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the subscription is automatically
deleted.
|
SubscriptionProperties |
setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
SubscriptionProperties |
setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
Set the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead
letter support when a message expires.
|
SubscriptionProperties |
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
SubscriptionProperties |
setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)
Set the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has
dead letter support when a message expires.
|
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.
|
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.
|
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.
|
SubscriptionProperties |
setMaxDeliveryCount(int maxDeliveryCount)
Set the maxDeliveryCount property: The maximum delivery count.
|
SubscriptionProperties |
setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource.
|
SubscriptionProperties |
setUserMetadata(String userMetadata)
Set the userMetadata property: Metadata associated with the subscription.
|
public String getTopicName()
public String getSubscriptionName()
public Duration getLockDuration()
public SubscriptionProperties setLockDuration(Duration lockDuration)
lockDuration
- the lockDuration value to set.public boolean isSessionRequired()
public Duration getDefaultMessageTimeToLive()
public SubscriptionProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
defaultMessageTimeToLive
- the defaultMessageTimeToLive value to set.public boolean isDeadLetteringOnMessageExpiration()
public SubscriptionProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
deadLetteringOnMessageExpiration
- the deadLetteringOnMessageExpiration value to set.public boolean isDeadLetteringOnFilterEvaluationExceptions()
public SubscriptionProperties setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)
deadLetteringOnFilterEvaluationExceptions
- the deadLetteringOnFilterEvaluationExceptions value to set.public int getMaxDeliveryCount()
public SubscriptionProperties setMaxDeliveryCount(int maxDeliveryCount)
maxDeliveryCount
- the maxDeliveryCount value to set.public boolean isBatchedOperationsEnabled()
public SubscriptionProperties setBatchedOperationsEnabled(boolean enableBatchedOperations)
enableBatchedOperations
- the enableBatchedOperations value to set.public EntityStatus getStatus()
public SubscriptionProperties setStatus(EntityStatus status)
status
- the status value to set.public String getForwardTo()
public SubscriptionProperties setForwardTo(String forwardTo)
forwardTo
- the forwardTo value to set.public String getUserMetadata()
public SubscriptionProperties setUserMetadata(String userMetadata)
userMetadata
- the userMetadata value to set.public String getForwardDeadLetteredMessagesTo()
public SubscriptionProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
forwardDeadLetteredMessagesTo
- the forwardDeadLetteredMessagesTo value to set.public Duration getAutoDeleteOnIdle()
public SubscriptionProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
autoDeleteOnIdle
- the autoDeleteOnIdle value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.