Package com.azure.messaging.webpubsub

Class WebPubSubServiceClientBuilder

java.lang.Object

com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder

All Implemented Interfaces:

com.azure.core.client.traits.AzureKeyCredentialTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.EndpointTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<WebPubSubServiceClientBuilder>

public final class WebPubSubServiceClientBuilder
extends Object
implements com.azure.core.client.traits.AzureKeyCredentialTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.EndpointTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<WebPubSubServiceClientBuilder>

This class provides a fluent builder API to aid the configuration and instantiation of sync and async Azure Web Pub Sub clients, using the buildClient and buildAsyncClient methods respectively.

To fully configure a Azure Web Pub Sub client, it is necessary to supply a connection string retrieved from the Azure Portal, or else a combination of credential and endpoint.

An Azure Web Pub Sub client is required to connect to a specific hub. An exception will be thrown when the build methods are called if the hub value is null or an empty String.

Code Samples

 WebPubSubServiceAsyncClient client = new WebPubSubServiceClientBuilder()
     .connectionString("<Insert connection string from Azure Portal>")
     .buildAsyncClient();
 

This demonstrates using the connection string provided by the Azure Portal. Another approach is to use the combination of credential and endpoint details, as shown below:

 WebPubSubServiceAsyncClient client = new WebPubSubServiceClientBuilder()
     .credential(new AzureKeyCredential("<Insert key from Azure Portal>"))
     .endpoint("<Insert endpoint from Azure Portal>")
     .buildAsyncClient();
 

Of course, synchronous clients may also be instantiated, by calling buildClient rather than buildAsyncClient.

 WebPubSubServiceClient client = new WebPubSubServiceClientBuilder()
     .connectionString("<Insert connection string from Azure Portal>")
     .buildClient();
 

See Also:

WebPubSubServiceAsyncClient, WebPubSubServiceClient

Constructor Summary

Constructors

Constructor	Description
WebPubSubServiceClientBuilder()	Creates a new builder instance with all values set to their default value.

Method Summary

Modifier and Type	Method	Description
WebPubSubServiceClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)	Adds a pipeline policy to apply on each request sent.
WebPubSubServiceAsyncClient	buildAsyncClient()	Builds an instance of WebPubSubAsyncServiceClient with the provided parameters.
WebPubSubServiceClient	buildClient()	Builds an instance of WebPubSubServiceClient with the provided parameters.
WebPubSubServiceClientBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
WebPubSubServiceClientBuilder	configuration(com.azure.core.util.Configuration configuration)	Sets the configuration store that is used during construction of the service client.
WebPubSubServiceClientBuilder	connectionString(String connectionString)	Sets the credential to use when authenticating HTTP requests.
WebPubSubServiceClientBuilder	credential(com.azure.core.credential.AzureKeyCredential credential)	Sets the AzureKeyCredential used to authenticate HTTP requests.
WebPubSubServiceClientBuilder	credential(com.azure.core.credential.TokenCredential credential)	Sets the TokenCredential used to authorize requests sent to the service.
WebPubSubServiceClientBuilder	endpoint(String endpoint)	Sets the service endpoint for the Azure Web Pub Sub instance.
WebPubSubServiceClientBuilder	httpClient(com.azure.core.http.HttpClient client)	Sets the HttpClient to use for sending and receiving requests to and from the service.
WebPubSubServiceClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
WebPubSubServiceClientBuilder	hub(String hub)	Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
WebPubSubServiceClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline)	Sets the HttpPipeline to use for the service client.
WebPubSubServiceClientBuilder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
WebPubSubServiceClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)	Sets the HttpPipelinePolicy that is used when each request is sent.
WebPubSubServiceClientBuilder	reverseProxyEndpoint(String reverseProxyEndpoint)	Sets the reverse proxy endpoint.
WebPubSubServiceClientBuilder	serviceVersion(WebPubSubServiceVersion version)	Sets the WebPubSubServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebPubSubServiceClientBuilder

public WebPubSubServiceClientBuilder()

Creates a new builder instance with all values set to their default value.

Method Detail

clientOptions

public WebPubSubServiceClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Specified by:

clientOptions in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated WebPubSubServiceClientBuilder object.

See Also:

HttpClientOptions

connectionString

public WebPubSubServiceClientBuilder connectionString(String connectionString)

Sets the credential to use when authenticating HTTP requests.

Specified by:

connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<WebPubSubServiceClientBuilder>

Parameters:

connectionString - Connection string in the format "endpoint={endpoint_value};accesskey={accesskey_value}"

Returns:

The updated WebPubSubServiceClientBuilder object.

Throws:

NullPointerException - If connectionString is null.

endpoint

public WebPubSubServiceClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Web Pub Sub instance.

Specified by:

endpoint in interface com.azure.core.client.traits.EndpointTrait<WebPubSubServiceClientBuilder>

Parameters:

endpoint - The URL of the Azure Web Pub Sub instance to send service requests to, and receive responses from.

Returns:

The updated WebPubSubServiceClientBuilder object.

Throws:

IllegalArgumentException - if endpoint is null.

credential

public WebPubSubServiceClientBuilder credential(com.azure.core.credential.AzureKeyCredential credential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Specified by:

credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<WebPubSubServiceClientBuilder>

Parameters:

credential - AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated WebPubSubServiceClientBuilder object.

credential

public WebPubSubServiceClientBuilder credential(com.azure.core.credential.TokenCredential credential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Specified by:

credential in interface com.azure.core.client.traits.TokenCredentialTrait<WebPubSubServiceClientBuilder>

Parameters:

credential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated WebPubSubServiceClientBuilder object.

reverseProxyEndpoint

public WebPubSubServiceClientBuilder reverseProxyEndpoint(String reverseProxyEndpoint)

Sets the reverse proxy endpoint.

Parameters:

reverseProxyEndpoint - The reverse proxy endpoint.

Returns:

The updated WebPubSubServiceClientBuilder object.

hub

public WebPubSubServiceClientBuilder hub(String hub)

Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.

Parameters:

hub - Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.

Returns:

The updated WebPubSubServiceClientBuilder object.

Throws:

NullPointerException - If hub is null.

httpLogOptions

public WebPubSubServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Specified by:

httpLogOptions in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

logOptions - The logging configuration to use when sending and receiving requests to and from the service.

Returns:

The updated WebPubSubServiceClientBuilder object.

addPolicy

public WebPubSubServiceClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Adds a pipeline policy to apply on each request sent.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Specified by:

addPolicy in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

policy - A pipeline policy.

Returns:

The updated WebPubSubServiceClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public WebPubSubServiceClientBuilder httpClient(com.azure.core.http.HttpClient client)

Sets the HttpClient to use for sending and receiving requests to and from the service.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Specified by:

httpClient in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated WebPubSubServiceClientBuilder object.

pipeline

public WebPubSubServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Sets the HttpPipeline to use for the service client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

If pipeline is set, all other settings are ignored, aside from connectionString to build WebPubSubServiceAsyncClient or WebPubSubServiceClient.

Specified by:

pipeline in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

pipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated WebPubSubServiceClientBuilder object.

configuration

public WebPubSubServiceClientBuilder configuration(com.azure.core.util.Configuration configuration)

Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

Specified by:

configuration in interface com.azure.core.client.traits.ConfigurationTrait<WebPubSubServiceClientBuilder>

Parameters:

configuration - The configuration store used to

Returns:

The updated WebPubSubServiceClientBuilder object.

retryPolicy

public WebPubSubServiceClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)

Sets the HttpPipelinePolicy that is used when each request is sent. The default retry policy will be used if not provided.

Setting this is mutually exclusive with using retryOptions(RetryOptions).

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated WebPubSubServiceClientBuilder object.

retryOptions

public WebPubSubServiceClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

Specified by:

retryOptions in interface com.azure.core.client.traits.HttpTrait<WebPubSubServiceClientBuilder>

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated WebPubSubServiceClientBuilder object.

serviceVersion

public WebPubSubServiceClientBuilder serviceVersion(WebPubSubServiceVersion version)

Sets the WebPubSubServiceVersion that is used when making API requests.

If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.

Parameters:

version - WebPubSubServiceVersion of the service to be used when making requests.

Returns:

The updated WebPubSubServiceClientBuilder object.

buildAsyncClient

public WebPubSubServiceAsyncClient buildAsyncClient()

Builds an instance of WebPubSubAsyncServiceClient with the provided parameters.

Returns:

an instance of WebPubSubAsyncServiceClient.

Throws:

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

buildClient

public WebPubSubServiceClient buildClient()

Builds an instance of WebPubSubServiceClient with the provided parameters.

Returns:

an instance of WebPubSubServiceClient.

Throws:

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.