123 строки
10 KiB
YAML
123 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.MessageHandlerOptions"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions"
|
|
name: "MessageHandlerOptions"
|
|
nameWithType: "MessageHandlerOptions"
|
|
summary: "The On<wbr>Message handler processing options."
|
|
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 **MessageHandlerOptions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions()"
|
|
name: "MessageHandlerOptions()"
|
|
nameWithType: "MessageHandlerOptions.MessageHandlerOptions()"
|
|
summary: "Default constructor for create <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref> with default settings."
|
|
syntax: "public MessageHandlerOptions()"
|
|
desc: "Default constructor for create <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref> with default settings. <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions#getMaxConcurrentCalls()\"></xref> default value is 1. <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions#getMaxAutoRenewDuration()\"></xref> default value is 5 minutes. <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions#isAutoComplete()\"></xref> default is true."
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int,boolean,java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)"
|
|
name: "MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)"
|
|
nameWithType: "MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)"
|
|
summary: "Create a instance of <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref>."
|
|
parameters:
|
|
- description: "maximum number of concurrent calls to the onMessage handler"
|
|
name: "maxConcurrentCalls"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise."
|
|
name: "autoComplete"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- Maximum duration within which the client keeps renewing the message lock if the processing of the message is not completed by the handler."
|
|
name: "maxAutoRenewDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)"
|
|
desc: "Create a instance of <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref>."
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int,boolean,java.time.Duration,java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)"
|
|
name: "MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)"
|
|
nameWithType: "MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)"
|
|
summary: "Create a instance of <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref>."
|
|
parameters:
|
|
- description: "maximum number of concurrent calls to the onMessage handler"
|
|
name: "maxConcurrentCalls"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise."
|
|
name: "autoComplete"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- Maximum duration within which the client keeps renewing the message lock if the processing of the message is not completed by the handler."
|
|
name: "maxAutoRenewDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "duration to wait for receiving the message"
|
|
name: "messageWaitDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)"
|
|
desc: "Create a instance of <xref uid=\"com.microsoft.azure.servicebus.MessageHandlerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessageHandlerOptions\"></xref>."
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()"
|
|
name: "getMaxAutoRenewDuration()"
|
|
nameWithType: "MessageHandlerOptions.getMaxAutoRenewDuration()"
|
|
summary: "Gets the maximum duration within which the lock will be renewed automatically."
|
|
syntax: "public Duration getMaxAutoRenewDuration()"
|
|
desc: "Gets the maximum duration within which the lock will be renewed automatically. This value should be greater than the longest message lock duration; for example, the LockDuration Property."
|
|
returns:
|
|
description: "The maximum duration during which locks are automatically renewed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()"
|
|
name: "getMaxConcurrentCalls()"
|
|
nameWithType: "MessageHandlerOptions.getMaxConcurrentCalls()"
|
|
summary: "Gets the maximum number of concurrent calls to the callback the message pump should initiate."
|
|
syntax: "public int getMaxConcurrentCalls()"
|
|
desc: "Gets the maximum number of concurrent calls to the callback the message pump should initiate."
|
|
returns:
|
|
description: "The maximum number of concurrent calls to the callback."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMessageWaitDuration()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.getMessageWaitDuration()"
|
|
name: "getMessageWaitDuration()"
|
|
nameWithType: "MessageHandlerOptions.getMessageWaitDuration()"
|
|
summary: "Gets the time to wait for receiving a message."
|
|
syntax: "public Duration getMessageWaitDuration()"
|
|
desc: "Gets the time to wait for receiving a message. Defaults to 1 minute."
|
|
returns:
|
|
description: "The wait duration for receive calls."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()"
|
|
name: "isAutoComplete()"
|
|
nameWithType: "MessageHandlerOptions.isAutoComplete()"
|
|
summary: "Whether the auto complete is set to true."
|
|
syntax: "public boolean isAutoComplete()"
|
|
desc: "Whether the auto complete is set to true."
|
|
returns:
|
|
description: "true to complete the message processing automatically on successful execution of the operation; otherwise, false."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.MessageHandlerOptions.toString()"
|
|
fullName: "com.microsoft.azure.servicebus.MessageHandlerOptions.toString()"
|
|
name: "toString()"
|
|
nameWithType: "MessageHandlerOptions.toString()"
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "The OnMessage handler processing options."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|