azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.service...

1274 строки
131 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.servicebus.ClientFactory"
fullName: "com.microsoft.azure.servicebus.ClientFactory"
name: "ClientFactory"
nameWithType: "ClientFactory"
summary: "Utility class for creating message senders and receivers."
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 **ClientFactory**"
methods:
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionString(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionString(String amqpConnectionString, String sessionId)"
name: "acceptSessionFromConnectionString(String amqpConnectionString, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromConnectionString(String amqpConnectionString, String sessionId)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with specified session id."
modifiers:
- "static"
parameters:
- description: "connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSession acceptSessionFromConnectionString(String amqpConnectionString, String sessionId)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionString(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionString(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromConnectionString(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromConnectionString(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus connection string with specified session id."
modifiers:
- "static"
parameters:
- description: "connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromConnectionString(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus connection string with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringAsync(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId)"
name: "acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from service bus connection string with specified session id."
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId)"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from service bus connection string with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> asynchronously from service bus connection string with specified session id."
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromConnectionStringAsync(String amqpConnectionString, String sessionId, ReceiveMode receiveMode)"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> asynchronously from service bus connection string with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
name: "acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string builder with specified session id."
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSession acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string builder with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus connection string builder with specified session id."
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus connection string builder with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
name: "acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from service bus connection string builder with specified session id."
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId)"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from service bus connection string builder with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> asynchronously from service bus connection string builder with specified session id."
modifiers:
- "static"
parameters:
- description: "connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, String sessionId, ReceiveMode receiveMode)"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> asynchronously from service bus connection string builder with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId)"
name: "acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which the session receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSession acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which the session receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromEntityPath(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
name: "acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id in Peek<wbr>Lock mode."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id in PeekLock mode. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromEntityPath(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(java.net.URI,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
name: "acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id in Peek<wbr>Lock mode."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id in PeekLock mode. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(java.net.URI,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSession acceptSessionFromEntityPath(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Accept a <xref uid=\"com.microsoft.azure.servicebus.IMessageSession\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSession\"></xref> from service bus using the client settings with specified session id. Session Id can be null, if null, service will return the first available session."
returns:
description: "IMessageSession instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId)"
name: "acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId)"
summary: "Asynchronously accepts a session from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which the session receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId)"
desc: "Asynchronously accepts a session from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
summary: "Asynchronously accepts a session from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which the session receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String sessionId, ReceiveMode receiveMode)"
desc: "Asynchronously accepts a session from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
name: "acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
summary: "Asynchronously accepts a session in Peek<wbr>Lock mode from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings)"
desc: "Asynchronously accepts a session in PeekLock mode from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Asynchronously accepts a session from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(String namespaceName, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
desc: "Asynchronously accepts a session from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(java.net.URI,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
name: "acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
summary: "Asynchronously accepts a session in Peek<wbr>Lock mode from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings)"
desc: "Asynchronously accepts a session in PeekLock mode from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(java.net.URI,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Asynchronously accepts a session from service bus using the client settings."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "session id, if null, service will return the first available session, otherwise, service will return specified session"
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSession> acceptSessionFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, String sessionId, ClientSettings clientSettings, ReceiveMode receiveMode)"
desc: "Asynchronously accepts a session from service bus using the client settings. Session Id can be null, if null, service will return the first available session."
returns:
description: "a CompletableFuture representing the pending session accepting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSession?alt=com.microsoft.azure.servicebus.IMessageSession&text=IMessageSession\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionString(java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionString(String amqpConnectionString)"
name: "createMessageReceiverFromConnectionString(String amqpConnectionString)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionString(String amqpConnectionString)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageReceiver createMessageReceiverFromConnectionString(String amqpConnectionString)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionString(java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionString(String amqpConnectionString, ReceiveMode receiveMode)"
name: "createMessageReceiverFromConnectionString(String amqpConnectionString, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionString(String amqpConnectionString, ReceiveMode receiveMode)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromConnectionString(String amqpConnectionString, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringAsync(java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringAsync(String amqpConnectionString)"
name: "createMessageReceiverFromConnectionStringAsync(String amqpConnectionString)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringAsync(String amqpConnectionString)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromConnectionStringAsync(String amqpConnectionString)"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "a CompletableFuture representing the pending creating"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringAsync(java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringAsync(String amqpConnectionString, ReceiveMode receiveMode)"
name: "createMessageReceiverFromConnectionStringAsync(String amqpConnectionString, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringAsync(String amqpConnectionString, ReceiveMode receiveMode)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromConnectionStringAsync(String amqpConnectionString, ReceiveMode receiveMode)"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "a CompletableFuture representing the pending creating"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
name: "createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "<xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder\"></xref>"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode from ConnectionStringBuilder\n\n```java\nIMessageReceiver messageReceiver = ClientFactory.createMessageReceiverFromConnectionStringBuilder(new ConnectionStringBuilder(connectionString, queueName));\n```"
returns:
description: "The <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
name: "createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "<xref uid=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionStringBuilder\"></xref>"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> from ConnectionStringBuilder\n\n```java\nIMessageReceiver messageReceiver = ClientFactory.createMessageReceiverFromConnectionStringBuilder(new ConnectionStringBuilder(connectionString, queueName), ReceiveMode.PEEKLOCK);\n```"
returns:
description: "The <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
name: "createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> in default <xref uid=\"com.microsoft.azure.servicebus.ReceiveMode.PEEKLOCK\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode#PEEKLOCK\"></xref> mode asynchronously from ConnectionStringBuilder"
returns:
description: "a CompletableFuture representing the pending creating"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
name: "createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
summary: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> asynchronously from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.microsoft.azure.servicebus.ReceiveMode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ReceiveMode\"></xref> PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)"
desc: "Create <xref uid=\"com.microsoft.azure.servicebus.IMessageReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageReceiver\"></xref> asynchronously from ConnectionStringBuilder"
returns:
description: "a CompletableFuture representing the pending creating"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
name: "createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
summary: "Creates a message receiver to the entity."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which receiver needs to be created"
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity."
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
summary: "Creates a message receiver to the entity."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which receiver needs to be created"
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity."
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
name: "createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message receiver to the entity using the client settings in Peek<wbr>Lock mode"
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity using the client settings in PeekLock mode"
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Creates a message receiver to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity using the client settings."
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
name: "createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message receiver to the entity using the client settings in Peek<wbr>Lock mode"
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity using the client settings in PeekLock mode"
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Creates a message receiver to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of the entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageReceiver createMessageReceiverFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message receiver to the entity using the client settings."
returns:
description: "IMessageReceiver instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
name: "createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
summary: "Asynchronously creates a new message receiver to the entity on the messaging<wbr>Factory."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
desc: "Asynchronously creates a new message receiver to the entity on the messagingFactory."
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
summary: "Asynchronously creates a new message receiver to the entity on the messaging<wbr>Factory."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which receiver needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, ReceiveMode receiveMode)"
desc: "Asynchronously creates a new message receiver to the entity on the messagingFactory."
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
name: "createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
summary: "Asynchronously creates a message receiver to the entity using the client settings in Peek<wbr>Lock mode"
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
desc: "Asynchronously creates a message receiver to the entity using the client settings in PeekLock mode"
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Asynchronously creates a message receiver to the entity using the client settings"
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
desc: "Asynchronously creates a message receiver to the entity using the client settings"
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
name: "createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
summary: "Asynchronously creates a message receiver to the entity using the client settings in Peek<wbr>Lock mode"
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
desc: "Asynchronously creates a message receiver to the entity using the client settings in PeekLock mode"
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings,com.microsoft.azure.servicebus.ReceiveMode)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
name: "createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
nameWithType: "ClientFactory.createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
summary: "Asynchronously creates a message receiver to the entity using the client settings"
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
- description: "PeekLock or ReceiveAndDelete"
name: "receiveMode"
type: "<xref href=\"com.microsoft.azure.servicebus.ReceiveMode?alt=com.microsoft.azure.servicebus.ReceiveMode&text=ReceiveMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode)"
desc: "Asynchronously creates a message receiver to the entity using the client settings"
returns:
description: "a CompletableFuture representing the pending creation of message receiver"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageReceiver?alt=com.microsoft.azure.servicebus.IMessageReceiver&text=IMessageReceiver\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionString(java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionString(String amqpConnectionString)"
name: "createMessageSenderFromConnectionString(String amqpConnectionString)"
nameWithType: "ClientFactory.createMessageSenderFromConnectionString(String amqpConnectionString)"
summary: "Create message sender from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSender createMessageSenderFromConnectionString(String amqpConnectionString)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create message sender from service bus connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSender\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringAsync(java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringAsync(String amqpConnectionString)"
name: "createMessageSenderFromConnectionStringAsync(String amqpConnectionString)"
nameWithType: "ClientFactory.createMessageSenderFromConnectionStringAsync(String amqpConnectionString)"
summary: "Create message sender asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
modifiers:
- "static"
parameters:
- description: "the connection string"
name: "amqpConnectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSender> createMessageSenderFromConnectionStringAsync(String amqpConnectionString)"
desc: "Create message sender asynchronously from connection string with [Shared Access Signatures][]\n\n\n[Shared Access Signatures]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas"
returns:
description: "a CompletableFuture representing the pending creating of <xref uid=\"com.microsoft.azure.servicebus.IMessageSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSender\"></xref> instance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
name: "createMessageSenderFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
nameWithType: "ClientFactory.createMessageSenderFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
summary: "Create message sender from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSender createMessageSenderFromConnectionStringBuilder(ConnectionStringBuilder amqpConnectionStringBuilder)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Create message sender from ConnectionStringBuilder\n\n```java\nIMessageSender messageSender = ClientFactory.createMessageSenderFromConnectionStringBuilder(new ConnectionStringBuilder(connectionString, queueName));\n```"
returns:
description: "<xref uid=\"com.microsoft.azure.servicebus.IMessageSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSender\"></xref> instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
name: "createMessageSenderFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
nameWithType: "ClientFactory.createMessageSenderFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
summary: "Create message sender asynchronously from Connection<wbr>String<wbr>Builder"
modifiers:
- "static"
parameters:
- description: "the connection string builder"
name: "amqpConnectionStringBuilder"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSender> createMessageSenderFromConnectionStringBuilderAsync(ConnectionStringBuilder amqpConnectionStringBuilder)"
desc: "Create message sender asynchronously from ConnectionStringBuilder"
returns:
description: "a CompletableFuture representing the pending creating of <xref uid=\"com.microsoft.azure.servicebus.IMessageSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IMessageSender\"></xref> instance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
name: "createMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
summary: "Creates a message sender to the entity."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which sender needs to be created"
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSender createMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message sender to the entity."
returns:
description: "IMessageSender instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
name: "createMessageSenderFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message sender to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "namespace of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSender createMessageSenderFromEntityPath(String namespaceName, String entityPath, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message sender to the entity using the client settings."
returns:
description: "IMessageSender instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
name: "createMessageSenderFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message sender to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IMessageSender createMessageSenderFromEntityPath(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a message sender to the entity using the client settings."
returns:
description: "IMessageSender instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
name: "createMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
summary: "Creates a message sender asynchronously to the entity using the <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory\"></xref>"
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which sender needs to be created"
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSender> createMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath)"
desc: "Creates a message sender asynchronously to the entity using the <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory\"></xref>"
returns:
description: "a CompletableFuture representing the pending creating of IMessageSender instance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
name: "createMessageSenderFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message sender asynchronously to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "namespace name of entity"
name: "namespaceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSender> createMessageSenderFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings)"
desc: "Creates a message sender asynchronously to the entity using the client settings."
returns:
description: "a CompletableFuture representing the pending creating of IMessageSender instance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(java.net.URI,java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createMessageSenderFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
name: "createMessageSenderFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
nameWithType: "ClientFactory.createMessageSenderFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
summary: "Creates a message sender asynchronously to the entity using the client settings."
modifiers:
- "static"
parameters:
- description: "endpoint uri of entity namespace"
name: "namespaceEndpointURI"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
- description: "path of entity"
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "client settings"
name: "clientSettings"
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CompletableFuture<IMessageSender> createMessageSenderFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings)"
desc: "Creates a message sender asynchronously to the entity using the client settings."
returns:
description: "a CompletableFuture representing the pending creating of IMessageSender instance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createTransferMessageSenderFromEntityPath(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createTransferMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
name: "createTransferMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
nameWithType: "ClientFactory.createTransferMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
summary: "Creates a transfer message sender."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which sender needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of the final destination of the message."
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The initial destination of the message."
name: "viaEntityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static IMessageSender createTransferMessageSenderFromEntityPath(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
- description: "if the current thread was interrupted while waiting"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a transfer message sender. This sender sends message to destination entity via another entity. This is mainly to be used when sending messages in a transaction. When messages need to be sent across entities in a single transaction, this can be used to ensure all the messages land initially in the same entity/partition for local transactions, and then let service bus handle transferring the message to the actual destination."
returns:
description: "IMessageSender instance"
type: "<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.ClientFactory.createTransferMessageSenderFromEntityPathAsync(com.microsoft.azure.servicebus.primitives.MessagingFactory,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.ClientFactory.createTransferMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
name: "createTransferMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
nameWithType: "ClientFactory.createTransferMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
summary: "Creates a transfer message sender asynchronously."
modifiers:
- "static"
parameters:
- description: "messaging factory (which represents a connection) on which sender needs to be created."
name: "messagingFactory"
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
- description: "path of the final destination of the message."
name: "entityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The initial destination of the message."
name: "viaEntityPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static CompletableFuture<IMessageSender> createTransferMessageSenderFromEntityPathAsync(MessagingFactory messagingFactory, String entityPath, String viaEntityPath)"
desc: "Creates a transfer message sender asynchronously. This sender sends message to destination entity via another entity. This is mainly to be used when sending messages in a transaction. When messages need to be sent across entities in a single transaction, this can be used to ensure all the messages land initially in the same entity/partition for local transactions, and then let service bus handle transferring the message to the actual destination."
returns:
description: "a CompletableFuture representing the pending creating of IMessageSender instance."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a>&lt;<xref href=\"com.microsoft.azure.servicebus.IMessageSender?alt=com.microsoft.azure.servicebus.IMessageSender&text=IMessageSender\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "Utility class for creating message senders and receivers."
metadata: {}
package: "com.microsoft.azure.servicebus"
artifact: com.microsoft.azure:azure-servicebus:3.6.7