307 строки
26 KiB
YAML
307 строки
26 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription"
|
|
name: "SubscriptionDescription"
|
|
nameWithType: "SubscriptionDescription"
|
|
summary: "Represents the metadata description of the subscription."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.management.UnknownPropertiesHolder?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **SubscriptionDescription**</br> extends <xref href=\"com.microsoft.azure.servicebus.management.UnknownPropertiesHolder?alt=com.microsoft.azure.servicebus.management.UnknownPropertiesHolder&text=UnknownPropertiesHolder\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.SubscriptionDescription(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.SubscriptionDescription(String topicPath, String subscriptionName)"
|
|
name: "SubscriptionDescription(String topicPath, String subscriptionName)"
|
|
nameWithType: "SubscriptionDescription.SubscriptionDescription(String topicPath, String subscriptionName)"
|
|
summary: "Initializes a new instance of Subscription<wbr>Description with the specified relative path."
|
|
parameters:
|
|
- description: "- Path of the topic\n Max length is 260 chars. Cannot start or end with a slash.\n Cannot have restricted characters: '@','?','#','*'"
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the subscription\n Max length is 50 chars. Cannot have restricted characters: '@','?','#','*','/'"
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SubscriptionDescription(String topicPath, String subscriptionName)"
|
|
desc: "Initializes a new instance of SubscriptionDescription with the specified relative path."
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.equals(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.equals(Object o)"
|
|
name: "equals(Object o)"
|
|
nameWithType: "SubscriptionDescription.equals(Object o)"
|
|
overridden: "java.lang.Object.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "o"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public boolean equals(Object o)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getAutoDeleteOnIdle()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getAutoDeleteOnIdle()"
|
|
name: "getAutoDeleteOnIdle()"
|
|
nameWithType: "SubscriptionDescription.getAutoDeleteOnIdle()"
|
|
syntax: "public Duration getAutoDeleteOnIdle()"
|
|
returns:
|
|
description: "The idle interval after which the subscription is automatically deleted.\n Default value is <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientConstants.MAX_DURATION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientConstants#MAX_DURATION\"></xref>"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getDefaultMessageTimeToLive()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getDefaultMessageTimeToLive()"
|
|
name: "getDefaultMessageTimeToLive()"
|
|
nameWithType: "SubscriptionDescription.getDefaultMessageTimeToLive()"
|
|
summary: "Time-To-Live is the duration after which the message expires, starting from when the message is sent to Service Bus."
|
|
syntax: "public Duration getDefaultMessageTimeToLive()"
|
|
desc: "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 <xref uid=\"com.microsoft.azure.servicebus.IMessage.getTimeToLive()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessage#getTimeToLive()\"></xref> 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:
|
|
description: "The default time to live value for the messages. Default value is <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientConstants.MAX_DURATION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientConstants#MAX_DURATION\"></xref>"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getEntityStatus()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getEntityStatus()"
|
|
name: "getEntityStatus()"
|
|
nameWithType: "SubscriptionDescription.getEntityStatus()"
|
|
summary: "Gets the status of the entity."
|
|
syntax: "public EntityStatus getEntityStatus()"
|
|
desc: "Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages."
|
|
returns:
|
|
description: "The current status of the queue (Enabled / Disabled).\n The default value is Enabled."
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.EntityStatus?alt=com.microsoft.azure.servicebus.management.EntityStatus&text=EntityStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getForwardDeadLetteredMessagesTo()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getForwardDeadLetteredMessagesTo()"
|
|
name: "getForwardDeadLetteredMessagesTo()"
|
|
nameWithType: "SubscriptionDescription.getForwardDeadLetteredMessagesTo()"
|
|
syntax: "public String getForwardDeadLetteredMessagesTo()"
|
|
returns:
|
|
description: "The path of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.\n If set, user cannot manually receive dead-lettered messages from this subscription. The destination\n entity must already exist."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getForwardTo()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getForwardTo()"
|
|
name: "getForwardTo()"
|
|
nameWithType: "SubscriptionDescription.getForwardTo()"
|
|
syntax: "public String getForwardTo()"
|
|
returns:
|
|
description: "The path of the recipient entity to which all the messages sent to the subscription are forwarded to.\n If set, user cannot manually receive messages from this subscription. The destination entity\n must be an already existing entity."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getLockDuration()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getLockDuration()"
|
|
name: "getLockDuration()"
|
|
nameWithType: "SubscriptionDescription.getLockDuration()"
|
|
summary: "The amount of time that the message is locked by a given receiver so that no other receiver receives the same message."
|
|
syntax: "public Duration getLockDuration()"
|
|
desc: "The amount of time that the message is locked by a given receiver so that no other receiver receives the same message."
|
|
returns:
|
|
description: "The duration of a peek lock. Default value is 60 seconds."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getMaxDeliveryCount()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getMaxDeliveryCount()"
|
|
name: "getMaxDeliveryCount()"
|
|
nameWithType: "SubscriptionDescription.getMaxDeliveryCount()"
|
|
summary: "The maximum delivery count of a message before it is dead-lettered."
|
|
syntax: "public int getMaxDeliveryCount()"
|
|
desc: "The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.microsoft.azure.servicebus.ReceiveMode#PEEKLOCK\"></xref> mode and didn't complete the message before the message lock expired."
|
|
returns:
|
|
description: "Default value is 10."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getPath()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getPath()"
|
|
name: "getPath()"
|
|
nameWithType: "SubscriptionDescription.getPath()"
|
|
syntax: "public String getPath()"
|
|
returns:
|
|
description: "the path of the subscription, including the topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getSubscriptionName()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getSubscriptionName()"
|
|
name: "getSubscriptionName()"
|
|
nameWithType: "SubscriptionDescription.getSubscriptionName()"
|
|
syntax: "public String getSubscriptionName()"
|
|
returns:
|
|
description: "the subscription name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getTopicPath()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getTopicPath()"
|
|
name: "getTopicPath()"
|
|
nameWithType: "SubscriptionDescription.getTopicPath()"
|
|
syntax: "public String getTopicPath()"
|
|
returns:
|
|
description: "the path of the topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getUserMetadata()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.getUserMetadata()"
|
|
name: "getUserMetadata()"
|
|
nameWithType: "SubscriptionDescription.getUserMetadata()"
|
|
syntax: "public String getUserMetadata()"
|
|
returns:
|
|
description: "Custom metdata that user can associate with the description."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.hashCode()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "SubscriptionDescription.hashCode()"
|
|
overridden: "java.lang.Object.hashCode()"
|
|
syntax: "public int hashCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableBatchedOperations()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableBatchedOperations()"
|
|
name: "isEnableBatchedOperations()"
|
|
nameWithType: "SubscriptionDescription.isEnableBatchedOperations()"
|
|
syntax: "public boolean isEnableBatchedOperations()"
|
|
returns:
|
|
description: "Indicates whether server-side batched operations are enabled.\n Defaults to true."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnFilterEvaluationException()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnFilterEvaluationException()"
|
|
name: "isEnableDeadLetteringOnFilterEvaluationException()"
|
|
nameWithType: "SubscriptionDescription.isEnableDeadLetteringOnFilterEvaluationException()"
|
|
syntax: "public boolean isEnableDeadLetteringOnFilterEvaluationException()"
|
|
returns:
|
|
description: "boolean indicating whether messages need to be forwarded to dead-letter subqueue when subscription rule evaluation fails.\n Default value is true."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnMessageExpiration()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnMessageExpiration()"
|
|
name: "isEnableDeadLetteringOnMessageExpiration()"
|
|
nameWithType: "SubscriptionDescription.isEnableDeadLetteringOnMessageExpiration()"
|
|
summary: "Indicates whether this subscription has dead letter support when a message expires."
|
|
syntax: "public boolean isEnableDeadLetteringOnMessageExpiration()"
|
|
desc: "Indicates whether this subscription has dead letter support when a message expires."
|
|
returns:
|
|
description: "If true, the expired messages are moved to dead-letter subqueue.\n Default value is false."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isRequiresSession()"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.isRequiresSession()"
|
|
name: "isRequiresSession()"
|
|
nameWithType: "SubscriptionDescription.isRequiresSession()"
|
|
syntax: "public boolean isRequiresSession()"
|
|
returns:
|
|
description: "This indicates whether the subscription supports the concept of session. Sessionful-messages follow FIFO ordering."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setAutoDeleteOnIdle(java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
|
|
name: "setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
|
|
nameWithType: "SubscriptionDescription.setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
|
|
parameters:
|
|
- description: "- The idle interval after which the subscription is automatically deleted.\n The minimum duration is 5 minutes."
|
|
name: "autoDeleteOnIdle"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setDefaultMessageTimeToLive(java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
|
|
name: "setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
|
|
nameWithType: "SubscriptionDescription.setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
|
|
parameters:
|
|
- description: "- Sets the default message time to live value.\n Value cannot be lower than 1 second.\n See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription.getDefaultMessageTimeToLive()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getDefaultMessageTimeToLive()\"></xref>"
|
|
name: "defaultMessageTimeToLive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableBatchedOperations(boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableBatchedOperations(boolean enableBatchedOperations)"
|
|
name: "setEnableBatchedOperations(boolean enableBatchedOperations)"
|
|
nameWithType: "SubscriptionDescription.setEnableBatchedOperations(boolean enableBatchedOperations)"
|
|
parameters:
|
|
- description: "- Indicates whether server-side batched operations are enabled."
|
|
name: "enableBatchedOperations"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setEnableBatchedOperations(boolean enableBatchedOperations)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableDeadLetteringOnFilterEvaluationException(boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)"
|
|
name: "setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)"
|
|
nameWithType: "SubscriptionDescription.setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)"
|
|
parameters:
|
|
- description: "- True if messages should be dead-lettered on filter evaluation exception.\n See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnFilterEvaluationException()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#isEnableDeadLetteringOnFilterEvaluationException()\"></xref>"
|
|
name: "enableDeadLetteringOnFilterEvaluationException"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableDeadLetteringOnMessageExpiration(boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)"
|
|
name: "setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)"
|
|
nameWithType: "SubscriptionDescription.setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)"
|
|
parameters:
|
|
- description: "- True if messages should be dead-lettered on expiration.\n See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription.isEnableDeadLetteringOnMessageExpiration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#isEnableDeadLetteringOnMessageExpiration()\"></xref>"
|
|
name: "enableDeadLetteringOnMessageExpiration"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEntityStatus(com.microsoft.azure.servicebus.management.EntityStatus)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setEntityStatus(EntityStatus status)"
|
|
name: "setEntityStatus(EntityStatus status)"
|
|
nameWithType: "SubscriptionDescription.setEntityStatus(EntityStatus status)"
|
|
parameters:
|
|
- description: "- the status of the queue (Enabled / Disabled).\n When an entity is disabled, that entity cannot send or receive messages."
|
|
name: "status"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.EntityStatus?alt=com.microsoft.azure.servicebus.management.EntityStatus&text=EntityStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setEntityStatus(EntityStatus status)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setForwardDeadLetteredMessagesTo(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
|
|
name: "setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
|
|
nameWithType: "SubscriptionDescription.setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
|
|
parameters:
|
|
- description: "- The path of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.\n If set, user cannot manually receive dead-lettered messages from this subscription. The destination\n entity must already exist."
|
|
name: "forwardDeadLetteredMessagesTo"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setForwardTo(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setForwardTo(String forwardTo)"
|
|
name: "setForwardTo(String forwardTo)"
|
|
nameWithType: "SubscriptionDescription.setForwardTo(String forwardTo)"
|
|
parameters:
|
|
- description: "- The path of the recipient entity to which all the messages sent to the subscription are forwarded to.\n If set, user cannot manually receive messages from this subscription. The destination entity\n must be an already existing entity."
|
|
name: "forwardTo"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void setForwardTo(String forwardTo)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setLockDuration(java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setLockDuration(Duration lockDuration)"
|
|
name: "setLockDuration(Duration lockDuration)"
|
|
nameWithType: "SubscriptionDescription.setLockDuration(Duration lockDuration)"
|
|
summary: "Sets The amount of time that the message is locked by a given receiver so that no other receiver receives the same message."
|
|
parameters:
|
|
- description: "- The duration of a peek lock. Max value is 5 minutes."
|
|
name: "lockDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public void setLockDuration(Duration lockDuration)"
|
|
desc: "Sets The amount of time that the message is locked by a given receiver so that no other receiver receives the same message."
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setMaxDeliveryCount(int)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setMaxDeliveryCount(int maxDeliveryCount)"
|
|
name: "setMaxDeliveryCount(int maxDeliveryCount)"
|
|
nameWithType: "SubscriptionDescription.setMaxDeliveryCount(int maxDeliveryCount)"
|
|
summary: "The maximum delivery count of a message before it is dead-lettered."
|
|
parameters:
|
|
- description: "- Minimum value is 1."
|
|
name: "maxDeliveryCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMaxDeliveryCount(int maxDeliveryCount)"
|
|
desc: "The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.microsoft.azure.servicebus.ReceiveMode#PEEKLOCK\"></xref> mode and didn't complete the message before the message lock expired."
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setRequiresSession(boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setRequiresSession(boolean requiresSession)"
|
|
name: "setRequiresSession(boolean requiresSession)"
|
|
nameWithType: "SubscriptionDescription.setRequiresSession(boolean requiresSession)"
|
|
parameters:
|
|
- description: "- Set to true if subscription should support sessions."
|
|
name: "requiresSession"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setRequiresSession(boolean requiresSession)"
|
|
- uid: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setUserMetadata(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.SubscriptionDescription.setUserMetadata(String userMetadata)"
|
|
name: "setUserMetadata(String userMetadata)"
|
|
nameWithType: "SubscriptionDescription.setUserMetadata(String userMetadata)"
|
|
parameters:
|
|
- description: "- Custom metdata that user can associate with the description.\n Cannot be null. Max length is 1024 chars"
|
|
name: "userMetadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void setUserMetadata(String userMetadata)"
|
|
type: "class"
|
|
desc: "Represents the metadata description of the subscription."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus.management"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|