119 строки
10 KiB
YAML
119 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.ClientSettings"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings"
|
|
name: "ClientSettings"
|
|
nameWithType: "ClientSettings"
|
|
summary: "Class encapsulating common client level settings like Token<wbr>Provider, Retry<wbr>Policy, Operation<wbr>Timeout."
|
|
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 class **ClientSettings**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(com.microsoft.azure.servicebus.security.TokenProvider)"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(TokenProvider tokenProvider)"
|
|
name: "ClientSettings(TokenProvider tokenProvider)"
|
|
nameWithType: "ClientSettings.ClientSettings(TokenProvider tokenProvider)"
|
|
summary: "Creates a new instance with the given token provider, default retry policy and default operation timeout."
|
|
parameters:
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.security.TokenProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenProvider\"></xref> instance"
|
|
name: "tokenProvider"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.security.TokenProvider?alt=com.microsoft.azure.servicebus.security.TokenProvider&text=TokenProvider\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ClientSettings(TokenProvider tokenProvider)"
|
|
desc: "Creates a new instance with the given token provider, default retry policy and default operation timeout."
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(com.microsoft.azure.servicebus.security.TokenProvider,com.microsoft.azure.servicebus.primitives.RetryPolicy,java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)"
|
|
name: "ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)"
|
|
nameWithType: "ClientSettings.ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)"
|
|
summary: "Creates a new instance with the given token provider, retry policy and operation timeout."
|
|
parameters:
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.security.TokenProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenProvider\"></xref> instance"
|
|
name: "tokenProvider"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.security.TokenProvider?alt=com.microsoft.azure.servicebus.security.TokenProvider&text=TokenProvider\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.primitives.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> instance"
|
|
name: "retryPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.RetryPolicy?alt=com.microsoft.azure.servicebus.primitives.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "default operation timeout to be used for all client operations. Client can override this value by explicitly specifying a timeout in the operation."
|
|
name: "operationTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)"
|
|
desc: "Creates a new instance with the given token provider, retry policy and operation timeout."
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(com.microsoft.azure.servicebus.security.TokenProvider,com.microsoft.azure.servicebus.primitives.RetryPolicy,java.time.Duration,com.microsoft.azure.servicebus.primitives.TransportType)"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)"
|
|
name: "ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)"
|
|
nameWithType: "ClientSettings.ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)"
|
|
summary: "Creates a new instance with the given token provider, retry policy and operation timeout."
|
|
parameters:
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.security.TokenProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenProvider\"></xref> instance"
|
|
name: "tokenProvider"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.security.TokenProvider?alt=com.microsoft.azure.servicebus.security.TokenProvider&text=TokenProvider\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.primitives.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> instance"
|
|
name: "retryPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.RetryPolicy?alt=com.microsoft.azure.servicebus.primitives.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "default operation timeout to be used for all client operations. Client can override this value by explicitly specifying a timeout in the operation."
|
|
name: "operationTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "<xref uid=\"com.microsoft.azure.servicebus.primitives.TransportType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TransportType\"></xref> instance"
|
|
name: "transportType"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.TransportType?alt=com.microsoft.azure.servicebus.primitives.TransportType&text=TransportType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)"
|
|
desc: "Creates a new instance with the given token provider, retry policy and operation timeout."
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.getOperationTimeout()"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.getOperationTimeout()"
|
|
name: "getOperationTimeout()"
|
|
nameWithType: "ClientSettings.getOperationTimeout()"
|
|
summary: "Gets the operation timeout contained in this instance."
|
|
syntax: "public Duration getOperationTimeout()"
|
|
desc: "Gets the operation timeout contained in this instance."
|
|
returns:
|
|
description: "operation timeout contained in this instance"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.getRetryPolicy()"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.getRetryPolicy()"
|
|
name: "getRetryPolicy()"
|
|
nameWithType: "ClientSettings.getRetryPolicy()"
|
|
summary: "Gets the retry policy contained in this instance."
|
|
syntax: "public RetryPolicy getRetryPolicy()"
|
|
desc: "Gets the retry policy contained in this instance."
|
|
returns:
|
|
description: "RetryPolicy contained in this instance"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.RetryPolicy?alt=com.microsoft.azure.servicebus.primitives.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.getTokenProvider()"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.getTokenProvider()"
|
|
name: "getTokenProvider()"
|
|
nameWithType: "ClientSettings.getTokenProvider()"
|
|
summary: "Gets the token provider contained in this instance."
|
|
syntax: "public TokenProvider getTokenProvider()"
|
|
desc: "Gets the token provider contained in this instance."
|
|
returns:
|
|
description: "TokenProvider contained in this instance"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.security.TokenProvider?alt=com.microsoft.azure.servicebus.security.TokenProvider&text=TokenProvider\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.ClientSettings.getTransportType()"
|
|
fullName: "com.microsoft.azure.servicebus.ClientSettings.getTransportType()"
|
|
name: "getTransportType()"
|
|
nameWithType: "ClientSettings.getTransportType()"
|
|
summary: "Gets the transport type for this instance"
|
|
syntax: "public TransportType getTransportType()"
|
|
desc: "Gets the transport type for this instance"
|
|
returns:
|
|
description: "transport type for the instance"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.TransportType?alt=com.microsoft.azure.servicebus.primitives.TransportType&text=TransportType\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Class encapsulating common client level settings like TokenProvider, RetryPolicy, OperationTimeout."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|