CreateSubscriptionOptions Class
- java.
lang. Object - com.
azure. messaging. servicebus. administration. models. CreateSubscriptionOptions
- com.
public final class CreateSubscriptionOptions
Options to set when creating a subscription.
Constructor Summary
Constructor | Description |
---|---|
CreateSubscriptionOptions() |
Creates an instance. |
CreateSubscriptionOptions(SubscriptionProperties subscription) |
Initializes a new instance based on the specified SubscriptionProperties instance. |
Method Summary
Modifier and Type | Method and Description |
---|---|
Duration |
getAutoDeleteOnIdle()
Get the auto |
Duration |
getDefaultMessageTimeToLive()
Get the default |
Rule |
getDefaultRule()
Get the rule that the subscription was created with, if any. |
String |
getForwardDeadLetteredMessagesTo()
Get the forward |
String |
getForwardTo()
Get the forward |
Duration |
getLockDuration()
Get the lock |
int |
getMaxDeliveryCount()
Get the max |
Entity |
getStatus()
Get the status property: Status of a Service Bus resource. |
String |
getUserMetadata()
Get the user |
boolean |
isBatchedOperationsEnabled()
Get the enable |
boolean |
isDeadLetteringOnFilterEvaluationExceptions()
Get the dead |
boolean |
isDeadLetteringOnMessageExpiration()
Get the dead |
boolean |
isSessionRequired()
Get the requires |
Create |
setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Set the auto |
Create |
setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enable |
Create |
setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
Set the dead |
Create |
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Set the default |
Create |
setDefaultRule(RuleProperties ruleProperties)
Set the rule that the subscriptions should be created with, if any. |
Create |
setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)
Set the dead |
Create |
setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
Set the forward |
Create |
setForwardTo(String forwardTo)
Set the forward |
Create |
setLockDuration(Duration lockDuration)
Set the lock |
Create |
setMaxDeliveryCount(int maxDeliveryCount)
Set the max |
Create |
setSessionRequired(boolean requiresSession)
Set the requires |
Create |
setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource. |
Create |
setUserMetadata(String userMetadata)
Set the user |
Methods inherited from java.lang.Object
Constructor Details
CreateSubscriptionOptions
public CreateSubscriptionOptions()
Creates an instance. Default values for the subscription are populated. The properties populated with defaults are:
- setAutoDeleteOnIdle(Duration autoDeleteOnIdle) is max duration value.
- setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration) is false.
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) is max duration value.
- setBatchedOperationsEnabled(boolean enableBatchedOperations) is true.
- setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions) is true.
- setLockDuration(Duration lockDuration) is 1 minute.
- setMaxDeliveryCount(int maxDeliveryCount) is 10.
- setSessionRequired(boolean requiresSession) is false.
- setStatus(EntityStatus status) is ACTIVE.
CreateSubscriptionOptions
public CreateSubscriptionOptions(SubscriptionProperties subscription)
Initializes a new instance based on the specified SubscriptionProperties instance. This is useful for creating a new subscription based on the properties of an existing subscription.
Parameters:
Method Details
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:
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:
getDefaultRule
public RuleProperties getDefaultRule()
Get the rule that the subscription was created with, if any.
Returns:
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:
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:
getLockDuration
public Duration getLockDuration()
Get the lockDuration property: ISO 8601 time-span 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:
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:
getStatus
public EntityStatus getStatus()
Get the status property: Status of a Service Bus resource.
Returns:
getUserMetadata
public String getUserMetadata()
Get the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024.
Returns:
isBatchedOperationsEnabled
public boolean isBatchedOperationsEnabled()
Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
Returns:
isDeadLetteringOnFilterEvaluationExceptions
public boolean isDeadLetteringOnFilterEvaluationExceptions()
Get the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires.
Returns:
isDeadLetteringOnMessageExpiration
public boolean isDeadLetteringOnMessageExpiration()
Get the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires.
Returns:
isSessionRequired
public boolean isSessionRequired()
Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
Returns:
setAutoDeleteOnIdle
public CreateSubscriptionOptions 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:
Returns:
setBatchedOperationsEnabled
public CreateSubscriptionOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
Parameters:
Returns:
setDeadLetteringOnMessageExpiration
public CreateSubscriptionOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
Set the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires.
Parameters:
Returns:
setDefaultMessageTimeToLive
public CreateSubscriptionOptions 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:
Returns:
setDefaultRule
public CreateSubscriptionOptions setDefaultRule(RuleProperties ruleProperties)
Set the rule that the subscriptions should be created with, if any.
Parameters:
Returns:
setEnableDeadLetteringOnFilterEvaluationExceptions
public CreateSubscriptionOptions setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)
Set the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires.
Parameters:
Returns:
setForwardDeadLetteredMessagesTo
public CreateSubscriptionOptions 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:
Returns:
setForwardTo
public CreateSubscriptionOptions 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:
Returns:
setLockDuration
public CreateSubscriptionOptions setLockDuration(Duration lockDuration)
Set the lockDuration property: ISO 8601 time-span 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:
Returns:
setMaxDeliveryCount
public CreateSubscriptionOptions 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:
Returns:
setSessionRequired
public CreateSubscriptionOptions setSessionRequired(boolean requiresSession)
Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
Parameters:
Returns:
setStatus
public CreateSubscriptionOptions setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource.
Parameters:
Returns:
setUserMetadata
public CreateSubscriptionOptions setUserMetadata(String userMetadata)
Set the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024.
Parameters:
Returns: