public final class ServiceBusAdministrationClientBuilder extends Object
ServiceBusAdministrationClient
and ServiceBusAdministrationAsyncClient
. Call
buildClient()
and buildAsyncClient()
respectively to construct an
instance of the desired client.
Create the sync client using a connection string
// Retrieve 'connectionString' from your configuration. HttpLogOptions logOptions = new HttpLogOptions() .setLogLevel(HttpLogDetailLevel.HEADERS); ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder() .connectionString(connectionString) .httpLogOptions(logOptions) .buildClient();
Create the async client using Azure Identity
// DefaultAzureCredential creates a credential based on the environment it is executed in. TokenCredential credential = new DefaultAzureCredentialBuilder().build(); ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder() .connectionString("<< Service Bus NAMESPACE connection string>>") .credential("<< my-sb-namespace.servicebus.windows.net >>", credential) .buildAsyncClient();
Constructor and Description |
---|
ServiceBusAdministrationClientBuilder()
Constructs a builder with the default parameters.
|
Modifier and Type | Method and Description |
---|---|
ServiceBusAdministrationClientBuilder |
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a policy to the set of existing policies that are executed after required policies.
|
ServiceBusAdministrationAsyncClient |
buildAsyncClient()
Creates a
ServiceBusAdministrationAsyncClient based on options set in the builder. |
ServiceBusAdministrationClient |
buildClient()
Creates a
ServiceBusAdministrationClient based on options set in the builder. |
ServiceBusAdministrationClientBuilder |
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the
ClientOptions which enables various options to be set on the client. |
ServiceBusAdministrationClientBuilder |
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
ServiceBusAdministrationClientBuilder |
connectionString(String connectionString)
Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
|
ServiceBusAdministrationClientBuilder |
credential(String fullyQualifiedNamespace,
com.azure.core.credential.TokenCredential credential)
Sets the credential used to authenticate HTTP requests to the Service Bus namespace.
|
ServiceBusAdministrationClientBuilder |
endpoint(String endpoint)
Sets the service endpoint for the Service Bus namespace.
|
ServiceBusAdministrationClientBuilder |
httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.
|
ServiceBusAdministrationClientBuilder |
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
ServiceBusAdministrationClientBuilder |
pipeline(com.azure.core.http.HttpPipeline pipeline)
Sets the HTTP pipeline to use for the service client.
|
ServiceBusAdministrationClientBuilder |
retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy retryPolicy)
Sets the
HttpPipelinePolicy that is used when each request is sent. |
ServiceBusAdministrationClientBuilder |
serviceVersion(ServiceBusServiceVersion serviceVersion)
Sets the
ServiceBusServiceVersion that is used. |
public ServiceBusAdministrationClientBuilder()
public ServiceBusAdministrationAsyncClient buildAsyncClient()
ServiceBusAdministrationAsyncClient
based on options set in the builder. Every time buildAsyncClient
is invoked, a new instance of the client is created.
If pipeline
is set, then the pipeline
and
endpoint
are used to create the client
. All
other builder settings are ignored.
ServiceBusAdministrationAsyncClient
with the options set in the builder.NullPointerException
- if endpoint
has not been set. This is automatically set when connectionString
is set. Explicitly through ServiceBusAdministrationClientBuilder.endpoint(String)
, or through
ServiceBusAdministrationClientBuilder.credential(String, TokenCredential)
.IllegalStateException
- If applicationId if set in both httpLogOptions
and clientOptions
and not same.public ServiceBusAdministrationClient buildClient()
ServiceBusAdministrationClient
based on options set in the builder. Every time buildClient
is invoked, a new instance of the client is created.
If pipeline
is set, then the pipeline
and
endpoint
are used to create the client
. All
other builder settings are ignored.
ServiceBusAdministrationClient
with the options set in the builder.NullPointerException
- if endpoint
has not been set. This is automatically set when connectionString
is set. Explicitly through ServiceBusAdministrationClientBuilder.endpoint(String)
, or through
ServiceBusAdministrationClientBuilder.credential(String, TokenCredential)
.IllegalStateException
- If applicationId if set in both httpLogOptions
and clientOptions
and not same.public ServiceBusAdministrationClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
policy
- The retry policy for service requests.ServiceBusAdministrationClientBuilder
object.NullPointerException
- If policy
is null
.public ServiceBusAdministrationClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Service Bus namespace.ServiceBusAdministrationClientBuilder
object.NullPointerException
- if endpoint
is null.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public ServiceBusAdministrationClientBuilder configuration(com.azure.core.util.Configuration configuration)
global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.configuration
- The configuration store used toServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder connectionString(String connectionString)
connectionString
- Connection string for a Service Bus namespace or a specific Service Bus resource.ServiceBusAdministrationClientBuilder
object.NullPointerException
- If connectionString
is null
.IllegalArgumentException
- If connectionString
is an entity specific connection string, and not
a connectionString
for the Service Bus namespace.public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, com.azure.core.credential.TokenCredential credential)
fullyQualifiedNamespace
- for the Service Bus.credential
- TokenCredential
to be used for authentication.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder httpClient(com.azure.core.http.HttpClient client)
client
- The HTTP client to use for requests.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
If logLevel is not provided, default value of HttpLogDetailLevel.NONE
is set.
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
ClientOptions
which enables various options to be set on the client. For example setting
applicationId
using ClientOptions.setApplicationId(String)
to configure UserAgentPolicy
for telemetry/monitoring purpose.
clientOptions
- to be set on the client.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
pipeline
is set, all other settings are ignored, aside from endpoint
to build ServiceBusAdministrationClient
or ServiceBusAdministrationAsyncClient
.pipeline
- The HTTP pipeline to use for sending service requests and receiving responses.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy retryPolicy)
HttpPipelinePolicy
that is used when each request is sent.
The default retry policy will be used if not provided ServiceBusAdministrationClientBuilder.buildAsyncClient()
to build ServiceBusAdministrationClient
or ServiceBusAdministrationAsyncClient
.retryPolicy
- The user's retry policy applied to each request.ServiceBusAdministrationClientBuilder
object.public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)
ServiceBusServiceVersion
that is used. By default ServiceBusServiceVersion.getLatest()
is used when none is specified.serviceVersion
- Service version to use.ServiceBusAdministrationClientBuilder
object.Copyright © 2021 Microsoft Corporation. All rights reserved.