com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.yml

### YamlMime:JavaType
uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions"
fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions"
name: "CreateSubscriptionOptions"
nameWithType: "CreateSubscriptionOptions"
summary: "Options to set when creating a subscription."
inheritances:
- "<xref href=\"java.lang.Object?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 final class **CreateSubscriptionOptions**"
constructors:
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.CreateSubscriptionOptions()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.CreateSubscriptionOptions()"
  name: "CreateSubscriptionOptions()"
  nameWithType: "CreateSubscriptionOptions.CreateSubscriptionOptions()"
  summary: "Creates an instance."
  syntax: "public CreateSubscriptionOptions()"
  desc: "Creates an instance. Default values for the subscription are populated. The properties populated with defaults are:\n\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setAutoDeleteOnIdle(java.time.Duration)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setAutoDeleteOnIdle(Duration)\"></xref> is max duration value.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDeadLetteringOnMessageExpiration(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setDeadLetteringOnMessageExpiration(boolean)\"></xref> is false.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDefaultMessageTimeToLive(java.time.Duration)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setDefaultMessageTimeToLive(Duration)\"></xref> is max duration value.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setBatchedOperationsEnabled(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setBatchedOperationsEnabled(boolean)\"></xref> is true.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setEnableDeadLetteringOnFilterEvaluationExceptions(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setEnableDeadLetteringOnFilterEvaluationExceptions(boolean)\"></xref> is true.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setLockDuration(java.time.Duration)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setLockDuration(Duration)\"></xref> is 1 minute.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setMaxDeliveryCount(int)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setMaxDeliveryCount(int)\"></xref> is 10.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setSessionRequired(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setSessionRequired(boolean)\"></xref> is false.\n *  <xref uid=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setStatus(com.azure.messaging.servicebus.administration.models.EntityStatus)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setStatus(EntityStatus)\"></xref> is <xref uid=\"com.azure.messaging.servicebus.administration.models.EntityStatus.ACTIVE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityStatus#ACTIVE\"></xref>."
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.CreateSubscriptionOptions(com.azure.messaging.servicebus.administration.models.SubscriptionProperties)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.CreateSubscriptionOptions(SubscriptionProperties subscription)"
  name: "CreateSubscriptionOptions(SubscriptionProperties subscription)"
  nameWithType: "CreateSubscriptionOptions.CreateSubscriptionOptions(SubscriptionProperties subscription)"
  summary: "Initializes a new instance based on the specified <xref uid=\"com.azure.messaging.servicebus.administration.models.SubscriptionProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionProperties\"></xref> instance."
  parameters:
  - description: "Existing subscription to create options with."
    name: "subscription"
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.SubscriptionProperties?alt=com.azure.messaging.servicebus.administration.models.SubscriptionProperties&text=SubscriptionProperties\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions(SubscriptionProperties subscription)"
  desc: "Initializes a new instance based on the specified <xref uid=\"com.azure.messaging.servicebus.administration.models.SubscriptionProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionProperties\"></xref> instance. This is useful for creating a new subscription based on the properties of an existing subscription."
methods:
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getAutoDeleteOnIdle()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getAutoDeleteOnIdle()"
  name: "getAutoDeleteOnIdle()"
  nameWithType: "CreateSubscriptionOptions.getAutoDeleteOnIdle()"
  summary: "Get the auto<wbr>Delete<wbr>OnIdle property: ISO 8601 time<wbr>Span idle interval after which the subscription is automatically deleted."
  syntax: "public Duration getAutoDeleteOnIdle()"
  desc: "Get the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes."
  returns:
    description: "the autoDeleteOnIdle value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getDefaultMessageTimeToLive()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getDefaultMessageTimeToLive()"
  name: "getDefaultMessageTimeToLive()"
  nameWithType: "CreateSubscriptionOptions.getDefaultMessageTimeToLive()"
  summary: "Get the default<wbr>Message<wbr>Time<wbr>ToLive property: ISO 8601 default message timespan to live value."
  syntax: "public Duration getDefaultMessageTimeToLive()"
  desc: "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:
    description: "the defaultMessageTimeToLive value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getDefaultRule()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getDefaultRule()"
  name: "getDefaultRule()"
  nameWithType: "CreateSubscriptionOptions.getDefaultRule()"
  summary: "Get the rule that the subscription was created with, if any."
  syntax: "public RuleProperties getDefaultRule()"
  desc: "Get the rule that the subscription was created with, if any."
  returns:
    description: "the Rule description"
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.RuleProperties?alt=com.azure.messaging.servicebus.administration.models.RuleProperties&text=RuleProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getForwardDeadLetteredMessagesTo()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getForwardDeadLetteredMessagesTo()"
  name: "getForwardDeadLetteredMessagesTo()"
  nameWithType: "CreateSubscriptionOptions.getForwardDeadLetteredMessagesTo()"
  summary: "Get the forward<wbr>Dead<wbr>Lettered<wbr>Messages<wbr>To property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  syntax: "public String getForwardDeadLetteredMessagesTo()"
  desc: "Get the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  returns:
    description: "the forwardDeadLetteredMessagesTo value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getForwardTo()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getForwardTo()"
  name: "getForwardTo()"
  nameWithType: "CreateSubscriptionOptions.getForwardTo()"
  summary: "Get the forward<wbr>To property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  syntax: "public String getForwardTo()"
  desc: "Get the forwardTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  returns:
    description: "the forwardTo value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getLockDuration()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getLockDuration()"
  name: "getLockDuration()"
  nameWithType: "CreateSubscriptionOptions.getLockDuration()"
  summary: "Get the lock<wbr>Duration property: ISO 8601 time-span duration of a peek-lock; that is, the amount of time that the message is locked for other receivers."
  syntax: "public Duration getLockDuration()"
  desc: "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:
    description: "the lockDuration value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getMaxDeliveryCount()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getMaxDeliveryCount()"
  name: "getMaxDeliveryCount()"
  nameWithType: "CreateSubscriptionOptions.getMaxDeliveryCount()"
  summary: "Get the max<wbr>Delivery<wbr>Count property: The maximum delivery count."
  syntax: "public int getMaxDeliveryCount()"
  desc: "Get the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10."
  returns:
    description: "the maxDeliveryCount value."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getStatus()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getStatus()"
  name: "getStatus()"
  nameWithType: "CreateSubscriptionOptions.getStatus()"
  summary: "Get the status property: Status of a Service Bus resource."
  syntax: "public EntityStatus getStatus()"
  desc: "Get the status property: Status of a Service Bus resource."
  returns:
    description: "the status value."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.EntityStatus?alt=com.azure.messaging.servicebus.administration.models.EntityStatus&text=EntityStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getUserMetadata()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.getUserMetadata()"
  name: "getUserMetadata()"
  nameWithType: "CreateSubscriptionOptions.getUserMetadata()"
  summary: "Get the user<wbr>Metadata property: Metadata associated with the subscription."
  syntax: "public String getUserMetadata()"
  desc: "Get the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024."
  returns:
    description: "the userMetadata value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isBatchedOperationsEnabled()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isBatchedOperationsEnabled()"
  name: "isBatchedOperationsEnabled()"
  nameWithType: "CreateSubscriptionOptions.isBatchedOperationsEnabled()"
  summary: "Get the enable<wbr>Batched<wbr>Operations property: Value that indicates whether server-side batched operations are enabled."
  syntax: "public boolean isBatchedOperationsEnabled()"
  desc: "Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled."
  returns:
    description: "the enableBatchedOperations value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isDeadLetteringOnFilterEvaluationExceptions()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isDeadLetteringOnFilterEvaluationExceptions()"
  name: "isDeadLetteringOnFilterEvaluationExceptions()"
  nameWithType: "CreateSubscriptionOptions.isDeadLetteringOnFilterEvaluationExceptions()"
  summary: "Get the dead<wbr>Lettering<wbr>OnFilter<wbr>Evaluation<wbr>Exceptions property: A value that indicates whether this subscription has dead letter support when a message expires."
  syntax: "public boolean isDeadLetteringOnFilterEvaluationExceptions()"
  desc: "Get the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires."
  returns:
    description: "the deadLetteringOnFilterEvaluationExceptions value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isDeadLetteringOnMessageExpiration()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isDeadLetteringOnMessageExpiration()"
  name: "isDeadLetteringOnMessageExpiration()"
  nameWithType: "CreateSubscriptionOptions.isDeadLetteringOnMessageExpiration()"
  summary: "Get the dead<wbr>Lettering<wbr>OnMessage<wbr>Expiration property: A value that indicates whether this subscription has dead letter support when a message expires."
  syntax: "public boolean isDeadLetteringOnMessageExpiration()"
  desc: "Get the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires."
  returns:
    description: "the deadLetteringOnMessageExpiration value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isSessionRequired()"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.isSessionRequired()"
  name: "isSessionRequired()"
  nameWithType: "CreateSubscriptionOptions.isSessionRequired()"
  summary: "Get the requires<wbr>Session property: A value that indicates whether the queue supports the concept of sessions."
  syntax: "public boolean isSessionRequired()"
  desc: "Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions."
  returns:
    description: "the requiresSession value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setAutoDeleteOnIdle(java.time.Duration)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
  name: "setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
  nameWithType: "CreateSubscriptionOptions.setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
  summary: "Set the auto<wbr>Delete<wbr>OnIdle property: ISO 8601 time<wbr>Span idle interval after which the subscription is automatically deleted."
  parameters:
  - description: "the autoDeleteOnIdle value to set."
    name: "autoDeleteOnIdle"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public CreateSubscriptionOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)"
  desc: "Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setBatchedOperationsEnabled(boolean)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setBatchedOperationsEnabled(boolean enableBatchedOperations)"
  name: "setBatchedOperationsEnabled(boolean enableBatchedOperations)"
  nameWithType: "CreateSubscriptionOptions.setBatchedOperationsEnabled(boolean enableBatchedOperations)"
  summary: "Set the enable<wbr>Batched<wbr>Operations property: Value that indicates whether server-side batched operations are enabled."
  parameters:
  - description: "the enableBatchedOperations value to set."
    name: "enableBatchedOperations"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)"
  desc: "Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDeadLetteringOnMessageExpiration(boolean)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)"
  name: "setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)"
  nameWithType: "CreateSubscriptionOptions.setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)"
  summary: "Set the dead<wbr>Lettering<wbr>OnMessage<wbr>Expiration property: A value that indicates whether this subscription has dead letter support when a message expires."
  parameters:
  - description: "the deadLetteringOnMessageExpiration value to set."
    name: "deadLetteringOnMessageExpiration"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)"
  desc: "Set the deadLetteringOnMessageExpiration property: A value that indicates whether this subscription has dead letter support when a message expires."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDefaultMessageTimeToLive(java.time.Duration)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
  name: "setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
  nameWithType: "CreateSubscriptionOptions.setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
  summary: "Set the default<wbr>Message<wbr>Time<wbr>ToLive property: ISO 8601 default message timespan to live value."
  parameters:
  - description: "the defaultMessageTimeToLive value to set."
    name: "defaultMessageTimeToLive"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public CreateSubscriptionOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)"
  desc: "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."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDefaultRule(com.azure.messaging.servicebus.administration.models.RuleProperties)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setDefaultRule(RuleProperties ruleProperties)"
  name: "setDefaultRule(RuleProperties ruleProperties)"
  nameWithType: "CreateSubscriptionOptions.setDefaultRule(RuleProperties ruleProperties)"
  summary: "Set the rule that the subscriptions should be created with, if any."
  parameters:
  - description: "the rule description (name, action, filter)"
    name: "ruleProperties"
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.RuleProperties?alt=com.azure.messaging.servicebus.administration.models.RuleProperties&text=RuleProperties\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setDefaultRule(RuleProperties ruleProperties)"
  desc: "Set the rule that the subscriptions should be created with, if any."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setEnableDeadLetteringOnFilterEvaluationExceptions(boolean)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)"
  name: "setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)"
  nameWithType: "CreateSubscriptionOptions.setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)"
  summary: "Set the dead<wbr>Lettering<wbr>OnFilter<wbr>Evaluation<wbr>Exceptions property: A value that indicates whether this subscription has dead letter support when a message expires."
  parameters:
  - description: "the deadLetteringOnFilterEvaluationExceptions value to set."
    name: "deadLetteringOnFilterEvaluationExceptions"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)"
  desc: "Set the deadLetteringOnFilterEvaluationExceptions property: A value that indicates whether this subscription has dead letter support when a message expires."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setForwardDeadLetteredMessagesTo(java.lang.String)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
  name: "setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
  nameWithType: "CreateSubscriptionOptions.setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
  summary: "Set the forward<wbr>Dead<wbr>Lettered<wbr>Messages<wbr>To property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  parameters:
  - description: "the forwardDeadLetteredMessagesTo value to set."
    name: "forwardDeadLetteredMessagesTo"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CreateSubscriptionOptions setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)"
  desc: "Set the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setForwardTo(java.lang.String)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setForwardTo(String forwardTo)"
  name: "setForwardTo(String forwardTo)"
  nameWithType: "CreateSubscriptionOptions.setForwardTo(String forwardTo)"
  summary: "Set the forward<wbr>To property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  parameters:
  - description: "the forwardTo value to set."
    name: "forwardTo"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CreateSubscriptionOptions setForwardTo(String forwardTo)"
  desc: "Set the forwardTo property: The name of the recipient entity to which all the messages sent to the subscription are forwarded to."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setLockDuration(java.time.Duration)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setLockDuration(Duration lockDuration)"
  name: "setLockDuration(Duration lockDuration)"
  nameWithType: "CreateSubscriptionOptions.setLockDuration(Duration lockDuration)"
  summary: "Set the lock<wbr>Duration property: ISO 8601 time-span duration of a peek-lock; that is, the amount of time that the message is locked for other receivers."
  parameters:
  - description: "the lockDuration value to set."
    name: "lockDuration"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public CreateSubscriptionOptions setLockDuration(Duration lockDuration)"
  desc: "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."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setMaxDeliveryCount(int)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setMaxDeliveryCount(int maxDeliveryCount)"
  name: "setMaxDeliveryCount(int maxDeliveryCount)"
  nameWithType: "CreateSubscriptionOptions.setMaxDeliveryCount(int maxDeliveryCount)"
  summary: "Set the max<wbr>Delivery<wbr>Count property: The maximum delivery count."
  parameters:
  - description: "the maxDeliveryCount value to set."
    name: "maxDeliveryCount"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setMaxDeliveryCount(int maxDeliveryCount)"
  desc: "Set the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setSessionRequired(boolean)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setSessionRequired(boolean requiresSession)"
  name: "setSessionRequired(boolean requiresSession)"
  nameWithType: "CreateSubscriptionOptions.setSessionRequired(boolean requiresSession)"
  summary: "Set the requires<wbr>Session property: A value that indicates whether the queue supports the concept of sessions."
  parameters:
  - description: "the requiresSession value to set."
    name: "requiresSession"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setSessionRequired(boolean requiresSession)"
  desc: "Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setStatus(com.azure.messaging.servicebus.administration.models.EntityStatus)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setStatus(EntityStatus status)"
  name: "setStatus(EntityStatus status)"
  nameWithType: "CreateSubscriptionOptions.setStatus(EntityStatus status)"
  summary: "Set the status property: Status of a Service Bus resource."
  parameters:
  - description: "the status value to set."
    name: "status"
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.EntityStatus?alt=com.azure.messaging.servicebus.administration.models.EntityStatus&text=EntityStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CreateSubscriptionOptions setStatus(EntityStatus status)"
  desc: "Set the status property: Status of a Service Bus resource."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setUserMetadata(java.lang.String)"
  fullName: "com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions.setUserMetadata(String userMetadata)"
  name: "setUserMetadata(String userMetadata)"
  nameWithType: "CreateSubscriptionOptions.setUserMetadata(String userMetadata)"
  summary: "Set the user<wbr>Metadata property: Metadata associated with the subscription."
  parameters:
  - description: "the userMetadata value to set."
    name: "userMetadata"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CreateSubscriptionOptions setUserMetadata(String userMetadata)"
  desc: "Set the userMetadata property: Metadata associated with the subscription. Maximum number of characters is 1024."
  returns:
    description: "the CreateSubscriptionOptions object itself."
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions?alt=com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions&text=CreateSubscriptionOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Options to set when creating a subscription."
metadata: {}
package: "com.azure.messaging.servicebus.administration.models"
artifact: com.azure:azure-messaging-servicebus:7.17.1