Class SearchIndexClientBuilder
- java.lang.Object
-
- com.azure.search.documents.indexes.SearchIndexClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<SearchIndexClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<SearchIndexClientBuilder>
,com.azure.core.client.traits.EndpointTrait<SearchIndexClientBuilder>
,com.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<SearchIndexClientBuilder>
public final class SearchIndexClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<SearchIndexClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SearchIndexClientBuilder>, com.azure.core.client.traits.EndpointTrait<SearchIndexClientBuilder>, com.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SearchIndexClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation ofSearchIndexClients
andSearchIndexAsyncClients
. CallbuildClient
andbuildAsyncClient
respectively to construct an instance of the desired client.The following must be provided to construct a client instance.
- The Azure Cognitive Search service URL.
- An
AzureKeyCredential
that grants access to the Azure Cognitive Search service.
Instantiating an asynchronous Search Index Client
SearchIndexAsyncClient searchIndexAsyncClient = new SearchIndexClientBuilder() .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient();
Instantiating a synchronous Search Index Client
SearchIndexClient searchIndexClient = new SearchIndexClientBuilder() .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient();
- See Also:
SearchIndexClient
,SearchIndexAsyncClient
-
-
Constructor Summary
Constructors Constructor Description SearchIndexClientBuilder()
Creates a builder instance that is able to configure and constructSearchIndexClients
andSearchIndexAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchIndexClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds apipeline policy
to apply on each request sent.SearchIndexAsyncClient
buildAsyncClient()
Creates aSearchIndexAsyncClient
based on options set in the Builder.SearchIndexClient
buildClient()
Creates aSearchIndexClient
based on options set in the Builder.SearchIndexClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.SearchIndexClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.SearchIndexClientBuilder
credential(com.azure.core.credential.AzureKeyCredential credential)
Sets theAzureKeyCredential
used to authenticate HTTP requests.SearchIndexClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.SearchIndexClientBuilder
endpoint(String endpoint)
Sets the service endpoint for the Azure Cognitive Search instance.static com.azure.core.http.policy.HttpLogOptions
getDefaultLogOptions()
Gets the default Azure Search headers and query parameters allow list.SearchIndexClientBuilder
httpClient(com.azure.core.http.HttpClient client)
Sets theHttpClient
to use for sending and receiving requests to and from the service.SearchIndexClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.SearchIndexClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.SearchIndexClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.SearchIndexClientBuilder
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theHttpPipelinePolicy
that will attempt to retry requests when needed.SearchIndexClientBuilder
serializer(com.azure.core.util.serializer.JsonSerializer jsonSerializer)
Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents library.SearchIndexClientBuilder
serviceVersion(SearchServiceVersion serviceVersion)
Sets theSearchServiceVersion
that is used when making API requests.
-
-
-
Constructor Detail
-
SearchIndexClientBuilder
public SearchIndexClientBuilder()
Creates a builder instance that is able to configure and constructSearchIndexClients
andSearchIndexAsyncClients
.
-
-
Method Detail
-
buildClient
public SearchIndexClient buildClient()
Creates aSearchIndexClient
based on options set in the Builder. Every timebuildClient()
is called a new instance ofSearchIndexClient
is created.If
pipeline
is set, then only thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A SearchIndexClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
arenull
.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildAsyncClient
public SearchIndexAsyncClient buildAsyncClient()
Creates aSearchIndexAsyncClient
based on options set in the Builder. Every timebuildAsyncClient()
is called a new instance ofSearchIndexAsyncClient
is created.If
pipeline
is set, then only thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A SearchIndexAsyncClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
arenull
.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
endpoint
public SearchIndexClientBuilder endpoint(String endpoint)
Sets the service endpoint for the Azure Cognitive Search instance.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<SearchIndexClientBuilder>
- Parameters:
endpoint
- The URL of the Azure Cognitive Search instance.- Returns:
- The updated SearchIndexClientBuilder object.
- Throws:
IllegalArgumentException
- Ifendpoint
is null or it cannot be parsed into a valid URL.
-
credential
public SearchIndexClientBuilder credential(com.azure.core.credential.AzureKeyCredential credential)
Sets theAzureKeyCredential
used to authenticate HTTP requests.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureKeyCredentialTrait<SearchIndexClientBuilder>
- Parameters:
credential
- TheAzureKeyCredential
used to authenticate HTTP requests.- Returns:
- The updated SearchIndexClientBuilder object.
-
credential
public SearchIndexClientBuilder credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<SearchIndexClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated SearchIndexClientBuilder object.
-
httpLogOptions
public SearchIndexClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated SearchIndexClientBuilder object.
-
getDefaultLogOptions
public static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()
Gets the default Azure Search headers and query parameters allow list.- Returns:
- The default
HttpLogOptions
allow list.
-
clientOptions
public SearchIndexClientBuilder 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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated SearchIndexClientBuilder object.
- See Also:
HttpClientOptions
-
addPolicy
public SearchIndexClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds apipeline 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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated SearchIndexClientBuilder object.
- Throws:
NullPointerException
- Ifpolicy
isnull
.
-
serializer
public SearchIndexClientBuilder serializer(com.azure.core.util.serializer.JsonSerializer jsonSerializer)
Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents library.- Parameters:
jsonSerializer
- The serializer to serialize user defined models.- Returns:
- The updated SearchIndexClientBuilder object.
-
httpClient
public SearchIndexClientBuilder httpClient(com.azure.core.http.HttpClient client)
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
client
- TheHttpClient
to use for requests.- Returns:
- The updated SearchIndexClientBuilder object.
-
pipeline
public SearchIndexClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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 fromendpoint
when building aSearchIndexClient
orSearchIndexAsyncClient
.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated SearchIndexClientBuilder object.
-
configuration
public SearchIndexClientBuilder 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
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<SearchIndexClientBuilder>
- Parameters:
configuration
- The configuration store that will be used.- Returns:
- The updated SearchIndexClientBuilder object.
-
retryPolicy
public SearchIndexClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theHttpPipelinePolicy
that will attempt to retry requests when needed.A default retry policy will be supplied if one isn't provided.
Setting this is mutually exclusive with using
retryOptions(RetryOptions)
.- Parameters:
retryPolicy
- TheRetryPolicy
that will attempt to retry requests when needed.- Returns:
- The updated SearchIndexClientBuilder object.
-
retryOptions
public SearchIndexClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<SearchIndexClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated SearchIndexClientBuilder object.
-
serviceVersion
public SearchIndexClientBuilder serviceVersion(SearchServiceVersion serviceVersion)
Sets theSearchServiceVersion
that is used when making API requests.If a service version is not provided,
SearchServiceVersion.getLatest()
will be used as a default. When this default is used updating to a newer client library may result in a newer version of the service being used.- Parameters:
serviceVersion
- The version of the service to be used when making requests.- Returns:
- The updated SearchIndexClientBuilder object.
-
-