309 строки
27 KiB
YAML
309 строки
27 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder"
|
|
name: "ConnectionStringBuilder"
|
|
nameWithType: "ConnectionStringBuilder"
|
|
summary: "This class can be used to construct a connection string which can establish communication with Service<wbr>Bus entities."
|
|
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 **ConnectionStringBuilder**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(String connectionString)"
|
|
name: "ConnectionStringBuilder(String connectionString)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(String connectionString)"
|
|
summary: "Creates a new instance from the given connection string."
|
|
parameters:
|
|
- description: "ServiceBus ConnectionString"
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(String connectionString)"
|
|
desc: "Creates a new instance from the given connection string. ConnectionString format: Endpoint=sb://namespace\\_DNS\\_Name;EntityPath=EVENT\\_HUB\\_NAME;SharedAccessKeyName=SHARED\\_ACCESS\\_KEY\\_NAME;SharedAccessKey=SHARED\\_ACCESS\\_KEY or Endpoint=sb://namespace\\_DNS\\_Name;EntityPath=EVENT\\_HUB\\_NAME;SharedAccessSignatureToken=SHARED\\_ACCESS\\_SIGNATURE\\_TOKEN"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(String namespaceConnectionString, String entityPath)"
|
|
name: "ConnectionStringBuilder(String namespaceConnectionString, String entityPath)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(String namespaceConnectionString, String entityPath)"
|
|
summary: "Creates a new instance from the given connection string and entity path."
|
|
parameters:
|
|
- description: "connections string of the ServiceBus namespace. This doesn't include the entity path."
|
|
name: "namespaceConnectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "path to the entity within the namespace"
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(String namespaceConnectionString, String entityPath)"
|
|
desc: "Creates a new instance from the given connection string and entity path. A connection string may or may not include the entity path. ConnectionString format: Endpoint=sb://namespace\\_DNS\\_Name;EntityPath=EVENT\\_HUB\\_NAME;SharedAccessKeyName=SHARED\\_ACCESS\\_KEY\\_NAME;SharedAccessKey=SHARED\\_ACCESS\\_KEY or Endpoint=sb://namespace\\_DNS\\_Name;EntityPath=EVENT\\_HUB\\_NAME;SharedAccessSignatureToken=SHARED\\_ACCESS\\_SIGNATURE\\_TOKEN"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)"
|
|
name: "ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)"
|
|
summary: "Creates a new instance from namespace, entity path and already generated SAS token."
|
|
parameters:
|
|
- description: "Namespace name (dns suffix - ex: .servicebus.windows.net is not required)"
|
|
name: "namespaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>"
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Signature already generated"
|
|
name: "sharedAccessSingature"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)"
|
|
desc: "Creates a new instance from namespace, entity path and already generated SAS token."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
name: "ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
summary: "Creates a new instance from namespace, entity path and SAS Key name and value."
|
|
parameters:
|
|
- description: "Namespace name (dns suffix - ex: .servicebus.windows.net is not required)"
|
|
name: "namespaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>"
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Key name"
|
|
name: "sharedAccessKeyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Key"
|
|
name: "sharedAccessKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
desc: "Creates a new instance from namespace, entity path and SAS Key name and value."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.net.URI,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)"
|
|
name: "ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)"
|
|
summary: "Creates a new instance from endpoint address of the namesapce, entity path and already generated SAS token."
|
|
parameters:
|
|
- description: "namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName"
|
|
name: "endpointAddress"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>"
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Signature already generated"
|
|
name: "sharedAccessSingature"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)"
|
|
desc: "Creates a new instance from endpoint address of the namesapce, entity path and already generated SAS token."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(java.net.URI,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
name: "ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
nameWithType: "ConnectionStringBuilder.ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
summary: "Creates a new instance from endpoint address of the namesapce, entity path and SAS Key name and value"
|
|
parameters:
|
|
- description: "namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName"
|
|
name: "endpointAddress"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>"
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Key name"
|
|
name: "sharedAccessKeyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Shared Access Key"
|
|
name: "sharedAccessKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)"
|
|
desc: "Creates a new instance from endpoint address of the namesapce, entity path and SAS Key name and value"
|
|
fields:
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.DefaultOperationTimeout"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.DefaultOperationTimeout"
|
|
name: "DefaultOperationTimeout"
|
|
nameWithType: "ConnectionStringBuilder.DefaultOperationTimeout"
|
|
summary: "Default operation timeout if timeout is not specified in the connection string."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public static final Duration DefaultOperationTimeout"
|
|
desc: "Default operation timeout if timeout is not specified in the connection string. 30 seconds."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE"
|
|
name: "MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE"
|
|
nameWithType: "ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE"
|
|
summary: "Connection string value used for the Authentication field which indicates that Managed Identity Token<wbr>Provider will be used for authentication purposes."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "ManagedIdentity"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE"
|
|
desc: "Connection string value used for the Authentication field which indicates that Managed Identity TokenProvider will be used for authentication purposes."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE"
|
|
name: "MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE"
|
|
nameWithType: "ConnectionStringBuilder.MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "Managed Identity"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE"
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getAuthentication()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getAuthentication()"
|
|
name: "getAuthentication()"
|
|
nameWithType: "ConnectionStringBuilder.getAuthentication()"
|
|
syntax: "public String getAuthentication()"
|
|
returns:
|
|
description: "Returns the authentication method."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getEndpoint()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getEndpoint()"
|
|
name: "getEndpoint()"
|
|
nameWithType: "ConnectionStringBuilder.getEndpoint()"
|
|
summary: "Get the endpoint which can be used to connect to the Service<wbr>Bus Namespace"
|
|
syntax: "public URI getEndpoint()"
|
|
desc: "Get the endpoint which can be used to connect to the ServiceBus Namespace"
|
|
returns:
|
|
description: "Endpoint representing the service bus namespace"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getEntityPath()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getEntityPath()"
|
|
name: "getEntityPath()"
|
|
nameWithType: "ConnectionStringBuilder.getEntityPath()"
|
|
summary: "Get the entity path value from the connection string"
|
|
syntax: "public String getEntityPath()"
|
|
desc: "Get the entity path value from the connection string"
|
|
returns:
|
|
description: "Entity Path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getOperationTimeout()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getOperationTimeout()"
|
|
name: "getOperationTimeout()"
|
|
nameWithType: "ConnectionStringBuilder.getOperationTimeout()"
|
|
summary: "Gets the duration after which a pending operation like Send or RECEIVE will time out."
|
|
syntax: "public Duration getOperationTimeout()"
|
|
desc: "Gets the duration after which a pending operation like Send or RECEIVE will time out. If a timeout is not specified, it defaults to <xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.DefaultOperationTimeout\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#DefaultOperationTimeout\"></xref> This value will be used by all operations which uses this <xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder\"></xref>, unless explicitly over-ridden."
|
|
returns:
|
|
description: "operationTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getRetryPolicy()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getRetryPolicy()"
|
|
name: "getRetryPolicy()"
|
|
nameWithType: "ConnectionStringBuilder.getRetryPolicy()"
|
|
summary: "Get the retry policy instance that was created as part of this builder's creation."
|
|
syntax: "public RetryPolicy getRetryPolicy()"
|
|
desc: "Get the retry policy instance that was created as part of this builder's creation."
|
|
returns:
|
|
description: "RetryPolicy applied for any operation performed using this ConnectionString"
|
|
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.primitives.ConnectionStringBuilder.getSasKey()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getSasKey()"
|
|
name: "getSasKey()"
|
|
nameWithType: "ConnectionStringBuilder.getSasKey()"
|
|
summary: "Get the shared access policy key value from the connection string or null."
|
|
syntax: "public String getSasKey()"
|
|
desc: "Get the shared access policy key value from the connection string or null."
|
|
returns:
|
|
description: "Shared Access Signature key value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getSasKeyName()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getSasKeyName()"
|
|
name: "getSasKeyName()"
|
|
nameWithType: "ConnectionStringBuilder.getSasKeyName()"
|
|
summary: "Get the shared access policy owner name from the connection string or null."
|
|
syntax: "public String getSasKeyName()"
|
|
desc: "Get the shared access policy owner name from the connection string or null."
|
|
returns:
|
|
description: "Shared Access Signature key name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getSharedAccessSignatureToken()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getSharedAccessSignatureToken()"
|
|
name: "getSharedAccessSignatureToken()"
|
|
nameWithType: "ConnectionStringBuilder.getSharedAccessSignatureToken()"
|
|
summary: "Returns the shared access signature token from the connection string or null."
|
|
syntax: "public String getSharedAccessSignatureToken()"
|
|
desc: "Returns the shared access signature token from the connection string or null."
|
|
returns:
|
|
description: "Shared Access Signature Token"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getTransportType()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.getTransportType()"
|
|
name: "getTransportType()"
|
|
nameWithType: "ConnectionStringBuilder.getTransportType()"
|
|
summary: "Transport<wbr>Type on which all the communication for the Service Bus created using this Connection<wbr>String."
|
|
syntax: "public TransportType getTransportType()"
|
|
desc: "TransportType on which all the communication for the Service Bus created using this ConnectionString. Default value is <xref uid=\"com.microsoft.azure.servicebus.primitives.TransportType.AMQP\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TransportType#AMQP\"></xref>."
|
|
returns:
|
|
description: "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\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setOperationTimeout(java.time.Duration)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setOperationTimeout(Duration operationTimeout)"
|
|
name: "setOperationTimeout(Duration operationTimeout)"
|
|
nameWithType: "ConnectionStringBuilder.setOperationTimeout(Duration operationTimeout)"
|
|
summary: "Set the Operation<wbr>Timeout value in the Connection String."
|
|
parameters:
|
|
- description: "Operation Timeout"
|
|
name: "operationTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public void setOperationTimeout(Duration operationTimeout)"
|
|
desc: "Set the OperationTimeout value in the Connection String. This value will be used by all operations which uses this <xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder\"></xref>, unless explicitly over-ridden.\n\nConnectionString with operationTimeout is not inter-operable between java and clients in other platforms."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setRetryPolicy(com.microsoft.azure.servicebus.primitives.RetryPolicy)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setRetryPolicy(RetryPolicy retryPolicy)"
|
|
name: "setRetryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "ConnectionStringBuilder.setRetryPolicy(RetryPolicy retryPolicy)"
|
|
summary: "Set the retry policy."
|
|
parameters:
|
|
- description: "RetryPolicy applied for any operation performed using this ConnectionString"
|
|
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\" />"
|
|
syntax: "public void setRetryPolicy(RetryPolicy retryPolicy)"
|
|
desc: "Set the retry policy.\n\nRetryPolicy is not Serialized as part of <xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.toString()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder#toString()\"></xref> and is not interoperable with ServiceBus clients in other platforms."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setTransportType(com.microsoft.azure.servicebus.primitives.TransportType)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.setTransportType(TransportType transportType)"
|
|
name: "setTransportType(TransportType transportType)"
|
|
nameWithType: "ConnectionStringBuilder.setTransportType(TransportType transportType)"
|
|
summary: "Set the Transport<wbr>Type value in the Connection String."
|
|
parameters:
|
|
- description: "Transport Type"
|
|
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 ConnectionStringBuilder setTransportType(TransportType transportType)"
|
|
desc: "Set the TransportType value in the Connection String. If no TransportType is set, this defaults to <xref uid=\"com.microsoft.azure.servicebus.primitives.TransportType.AMQP\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TransportType#AMQP\"></xref>."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder\"></xref> instance being set."
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.toLoggableString()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.toLoggableString()"
|
|
name: "toLoggableString()"
|
|
nameWithType: "ConnectionStringBuilder.toLoggableString()"
|
|
syntax: "public String toLoggableString()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.toString()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder.toString()"
|
|
name: "toString()"
|
|
nameWithType: "ConnectionStringBuilder.toString()"
|
|
summary: "Returns an inter-operable connection string that can be used to connect to Service<wbr>Bus Namespace"
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
desc: "Returns an inter-operable connection string that can be used to connect to ServiceBus Namespace"
|
|
returns:
|
|
description: "connection string"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "This class can be used to construct a connection string which can establish communication with ServiceBus entities. It can also be used to perform basic validation on an existing connection string.\n\nSample Code:\n\n```java\nConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(\n \"ServiceBusNamespaceName\", \n \"ServiceBusEntityName\", // QueueName or TopicName or SubscriptionPath\n \"SharedAccessSignatureKeyName\", \n \"SharedAccessSignatureKey\");\n \n String connectionString = connectionStringBuilder.toString();\n```\n\nA connection string is basically a string consisted of key-value pair separated by \";\". Basic format is \\{=\\[;=\\]\\} where supported key name are as follow:\n\n * Endpoint - URL that points to the servicebus namespace\n * EntityPath - Path to the service bus entity (queue/topic/subscription/). For queues and topics, it is just the entity name. For subscriptions, path is <topicName>/subscriptions/<subscriptionName>\n * SharedAccessKeyName - Key name to the corresponding shared access policy rule for the namespace, or entity.\n * SharedAccessKey - Key value for the corresponding shared access policy rule of the namespace or entity.\n * SharedAccessSignatureToken - Instead of a key name and key value, clients can provide an already generated SAS Token.\n * OperationTimeout - Default timeout to be used for all senders, receiver and clients created from this connection string.\n * RetryPolicy - Name of the retry policy."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus.primitives"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|