198 строки
22 KiB
YAML
198 строки
22 KiB
YAML
|
### YamlMime:JavaType
|
||
|
|
uid: "com.azure.search.SearchIndexClientBuilder"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder"
|
||
|
|
name: "SearchIndexClientBuilder"
|
||
|
|
nameWithType: "SearchIndexClientBuilder"
|
||
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>."
|
||
|
|
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 **SearchIndexClientBuilder**"
|
||
|
|
constructors:
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
||
|
|
name: "SearchIndexClientBuilder()"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
||
|
|
summary: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>."
|
||
|
|
syntax: "public SearchIndexClientBuilder()"
|
||
|
|
desc: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>."
|
||
|
|
methods:
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.addPolicy(HttpPipelinePolicy policy)"
|
||
|
|
name: "addPolicy(HttpPipelinePolicy policy)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.addPolicy(HttpPipelinePolicy policy)"
|
||
|
|
summary: "Adds a pipeline policy to apply to each request sent."
|
||
|
|
parameters:
|
||
|
|
- description: "The pipeline policies to added to the policy list."
|
||
|
|
name: "policy"
|
||
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder addPolicy(HttpPipelinePolicy policy)"
|
||
|
|
desc: "Adds a pipeline policy to apply to each request sent.\n\nThis method may be called multiple times, each time it is called the policy will be added to the end of added policy list. All policies will be added after the retry policy."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.buildAsyncClient()"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.buildAsyncClient()"
|
||
|
|
name: "buildAsyncClient()"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.buildAsyncClient()"
|
||
|
|
summary: "Creates a <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> based on options set in the Builder."
|
||
|
|
syntax: "public SearchIndexAsyncClient buildAsyncClient()"
|
||
|
|
desc: "Creates a <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> based on options set in the Builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then only the `pipeline`, <xref uid=\"com.azure.search.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>, and <xref uid=\"com.azure.search.SearchIndexClientBuilder.indexName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"indexName\"></xref> are used to create the <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
||
|
|
returns:
|
||
|
|
description: "A SearchIndexClient with the options set from the builder."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexAsyncClient?alt=com.azure.search.SearchIndexAsyncClient&text=SearchIndexAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.buildClient()"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.buildClient()"
|
||
|
|
name: "buildClient()"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.buildClient()"
|
||
|
|
summary: "Creates a <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> based on options set in the Builder."
|
||
|
|
syntax: "public SearchIndexClient buildClient()"
|
||
|
|
desc: "Creates a <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> based on options set in the Builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then only the `pipeline`, <xref uid=\"com.azure.search.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>, and <xref uid=\"com.azure.search.SearchIndexClientBuilder.indexName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"indexName\"></xref> are used to create the <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
||
|
|
returns:
|
||
|
|
description: "A SearchIndexClient with the options set from the builder."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClient?alt=com.azure.search.SearchIndexClient&text=SearchIndexClient\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.configuration(Configuration configuration)"
|
||
|
|
name: "configuration(Configuration configuration)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.configuration(Configuration configuration)"
|
||
|
|
summary: "Sets the configuration store that is used during construction of the service client."
|
||
|
|
parameters:
|
||
|
|
- description: "The configuration store that will be used."
|
||
|
|
name: "configuration"
|
||
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder configuration(Configuration configuration)"
|
||
|
|
desc: "Sets the configuration store that is used during construction of the service client.\n\nThe default configuration store is a clone of the <xref uid=\"Configuration#getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"global\n configuration store\"></xref>, use <xref uid=\"com.azure.core.util.Configuration.NONE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#NONE\"></xref> to bypass using configuration settings during construction."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.credential(com.azure.search.SearchApiKeyCredential)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.credential(SearchApiKeyCredential searchApiKeyCredential)"
|
||
|
|
name: "credential(SearchApiKeyCredential searchApiKeyCredential)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.credential(SearchApiKeyCredential searchApiKeyCredential)"
|
||
|
|
summary: "Sets the <xref uid=\"com.azure.search.SearchApiKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchApiKeyCredential\"></xref> used to authenticate HTTP requests."
|
||
|
|
parameters:
|
||
|
|
- description: "The <xref uid=\"com.azure.search.SearchApiKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchApiKeyCredential\"></xref> used to authenticate HTTP requests."
|
||
|
|
name: "searchApiKeyCredential"
|
||
|
|
type: "<xref href=\"com.azure.search.SearchApiKeyCredential?alt=com.azure.search.SearchApiKeyCredential&text=SearchApiKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder credential(SearchApiKeyCredential searchApiKeyCredential)"
|
||
|
|
desc: "Sets the <xref uid=\"com.azure.search.SearchApiKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchApiKeyCredential\"></xref> used to authenticate HTTP requests."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.endpoint(java.lang.String)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.endpoint(String endpoint)"
|
||
|
|
name: "endpoint(String endpoint)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.endpoint(String endpoint)"
|
||
|
|
summary: "Sets the service endpoint for the Azure Search instance."
|
||
|
|
parameters:
|
||
|
|
- description: "The URL of the Azure Search instance."
|
||
|
|
name: "endpoint"
|
||
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||
|
|
syntax: "public SearchIndexClientBuilder endpoint(String endpoint)"
|
||
|
|
desc: "Sets the service endpoint for the Azure Search instance."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.httpClient(HttpClient client)"
|
||
|
|
name: "httpClient(HttpClient client)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.httpClient(HttpClient client)"
|
||
|
|
summary: "Sets the HTTP client to use for sending requests and receiving responses."
|
||
|
|
parameters:
|
||
|
|
- description: "The HTTP client that will handle sending requests and receiving responses."
|
||
|
|
name: "client"
|
||
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder httpClient(HttpClient client)"
|
||
|
|
desc: "Sets the HTTP client to use for sending requests and receiving responses."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
||
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
||
|
|
summary: "Sets the logging configuration for HTTP requests and responses."
|
||
|
|
parameters:
|
||
|
|
- description: "The logging configuration for HTTP requests and responses."
|
||
|
|
name: "logOptions"
|
||
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder httpLogOptions(HttpLogOptions logOptions)"
|
||
|
|
desc: "Sets the logging configuration for HTTP requests and responses.\n\nIf logging configurations aren't provided HTTP requests and responses won't be logged."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.indexName(java.lang.String)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.indexName(String indexName)"
|
||
|
|
name: "indexName(String indexName)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.indexName(String indexName)"
|
||
|
|
summary: "Sets the name of the index."
|
||
|
|
parameters:
|
||
|
|
- description: "Name of the index."
|
||
|
|
name: "indexName"
|
||
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||
|
|
syntax: "public SearchIndexClientBuilder indexName(String indexName)"
|
||
|
|
desc: "Sets the name of the index."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
||
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
||
|
|
summary: "Sets the HTTP pipeline to use for the service client."
|
||
|
|
parameters:
|
||
|
|
- description: "The HTTP pipeline to use for sending service requests and receiving responses."
|
||
|
|
name: "httpPipeline"
|
||
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder pipeline(HttpPipeline httpPipeline)"
|
||
|
|
desc: "Sets the HTTP pipeline to use for the service client.\n\nIf `pipeline` is set, all other settings are ignored, aside from <xref uid=\"com.azure.search.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> and <xref uid=\"com.azure.search.SearchIndexClientBuilder.indexName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"index\"></xref> when building a <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref>."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that will attempt to retry requests when needed."
|
||
|
|
parameters:
|
||
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> that will attempt to retry requests when needed."
|
||
|
|
name: "retryPolicy"
|
||
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that will attempt to retry requests when needed.\n\nA default retry policy will be supplied if one isn't provided."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
- uid: "com.azure.search.SearchIndexClientBuilder.serviceVersion(com.azure.search.SearchServiceVersion)"
|
||
|
|
fullName: "com.azure.search.SearchIndexClientBuilder.serviceVersion(SearchServiceVersion serviceVersion)"
|
||
|
|
name: "serviceVersion(SearchServiceVersion serviceVersion)"
|
||
|
|
nameWithType: "SearchIndexClientBuilder.serviceVersion(SearchServiceVersion serviceVersion)"
|
||
|
|
summary: "Sets the <xref uid=\"com.azure.search.SearchServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchServiceVersion\"></xref> that is used when making API requests."
|
||
|
|
parameters:
|
||
|
|
- description: "The version of the service to be used when making requests."
|
||
|
|
name: "serviceVersion"
|
||
|
|
type: "<xref href=\"com.azure.search.SearchServiceVersion?alt=com.azure.search.SearchServiceVersion&text=SearchServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
syntax: "public SearchIndexClientBuilder serviceVersion(SearchServiceVersion serviceVersion)"
|
||
|
|
desc: "Sets the <xref uid=\"com.azure.search.SearchServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchServiceVersion\"></xref> that is used when making API requests.\n\nIf a service version is not provided, <xref uid=\"com.azure.search.SearchServiceVersion.getLatest()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchServiceVersion#getLatest()\"></xref> 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."
|
||
|
|
returns:
|
||
|
|
description: "The updated SearchIndexClientBuilder object."
|
||
|
|
type: "<xref href=\"com.azure.search.SearchIndexClientBuilder?alt=com.azure.search.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||
|
|
type: "class"
|
||
|
|
desc: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.search.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>. Call <xref uid=\"com.azure.search.SearchIndexClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.search.SearchIndexClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe following information must be provided to successfully create a client.\n\n * <xref uid=\"com.azure.search.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#endpoint(String)\"></xref>\n * <xref uid=\"com.azure.search.SearchIndexClientBuilder.indexName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#indexName(String)\"></xref>\n * <xref uid=\"com.azure.search.SearchIndexClientBuilder.credential(com.azure.search.SearchApiKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(SearchApiKeyCredential)\"></xref> or <xref uid=\"com.azure.search.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#pipeline(HttpPipeline)\"></xref>"
|
||
|
|
metadata: {}
|
||
|
|
package: "com.azure.search"
|
||
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|