272 строки
46 KiB
YAML
272 строки
46 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder"
|
|
fullName: "com.azure.search.documents.indexes.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.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.documents.indexes.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**</br> implements <xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
|
name: "SearchIndexClientBuilder()"
|
|
nameWithType: "SearchIndexClientBuilder.SearchIndexClientBuilder()"
|
|
summary: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.documents.indexes.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.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.addPolicy(HttpPipelinePolicy policy)"
|
|
name: "addPolicy(HttpPipelinePolicy policy)"
|
|
nameWithType: "SearchIndexClientBuilder.addPolicy(HttpPipelinePolicy policy)"
|
|
summary: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref>."
|
|
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 <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.audience(com.azure.search.documents.models.SearchAudience)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.audience(SearchAudience audience)"
|
|
name: "audience(SearchAudience audience)"
|
|
nameWithType: "SearchIndexClientBuilder.audience(SearchAudience audience)"
|
|
summary: "Sets the Audience to use for authentication with Microsoft Entra ID."
|
|
parameters:
|
|
- description: "The Audience to use for authentication with Microsoft Entra ID."
|
|
name: "audience"
|
|
type: "<xref href=\"com.azure.search.documents.models.SearchAudience?alt=com.azure.search.documents.models.SearchAudience&text=SearchAudience\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder audience(SearchAudience audience)"
|
|
desc: "Sets the Audience to use for authentication with Microsoft Entra ID.\n\nThe audience is not considered when using a <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"shared key\"></xref>.\n\nIf `audience` is null the public cloud audience will be assumed."
|
|
returns:
|
|
description: "The updated SearchClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "SearchIndexClientBuilder.buildAsyncClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.search.documents.indexes.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.documents.indexes.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.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then only the `pipeline` and <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
|
returns:
|
|
description: "A SearchIndexAsyncClient with the options set from the builder."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexAsyncClient?alt=com.azure.search.documents.indexes.SearchIndexAsyncClient&text=SearchIndexAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.buildClient()"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "SearchIndexClientBuilder.buildClient()"
|
|
summary: "Creates a <xref uid=\"com.azure.search.documents.indexes.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.documents.indexes.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.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then only the `pipeline` and <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.search.documents.indexes.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.documents.indexes.SearchIndexClient?alt=com.azure.search.documents.indexes.SearchIndexClient&text=SearchIndexClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "SearchIndexClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc."
|
|
parameters:
|
|
- description: "A configured instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>."
|
|
name: "clientOptions"
|
|
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder clientOptions(ClientOptions clientOptions)"
|
|
desc: "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 <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.search.documents.indexes.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.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.credential(AzureKeyCredential credential)"
|
|
name: "credential(AzureKeyCredential credential)"
|
|
nameWithType: "SearchIndexClientBuilder.credential(AzureKeyCredential credential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder credential(AzureKeyCredential credential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.credential(TokenCredential credential)"
|
|
name: "credential(TokenCredential credential)"
|
|
nameWithType: "SearchIndexClientBuilder.credential(TokenCredential credential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder credential(TokenCredential credential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> 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 <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "SearchIndexClientBuilder.endpoint(String endpoint)"
|
|
summary: "Sets the service endpoint for the Azure AI Search instance."
|
|
parameters:
|
|
- description: "The URL of the Azure AI 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 AI Search instance."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.getDefaultLogOptions()"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.getDefaultLogOptions()"
|
|
name: "getDefaultLogOptions()"
|
|
nameWithType: "SearchIndexClientBuilder.getDefaultLogOptions()"
|
|
summary: "Gets the default Azure Search headers and query parameters allow list."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static HttpLogOptions getDefaultLogOptions()"
|
|
desc: "Gets the default Azure Search headers and query parameters allow list."
|
|
returns:
|
|
description: "The default <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogOptions\"></xref> allow list."
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.httpClient(HttpClient client)"
|
|
name: "httpClient(HttpClient client)"
|
|
nameWithType: "SearchIndexClientBuilder.httpClient(HttpClient client)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for requests."
|
|
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 <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "SearchIndexClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to\n and from the service."
|
|
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 <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogDetailLevel#NONE\"></xref> is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "SearchIndexClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nIf `pipeline` is set, all other settings are ignored, aside from <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> when building a <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref>."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "SearchIndexClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> to use for all the requests made through the client."
|
|
name: "retryOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder retryOptions(RetryOptions retryOptions)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.search.documents.indexes.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.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.serializer(com.azure.core.util.serializer.JsonSerializer)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.serializer(JsonSerializer jsonSerializer)"
|
|
name: "serializer(JsonSerializer jsonSerializer)"
|
|
nameWithType: "SearchIndexClientBuilder.serializer(JsonSerializer jsonSerializer)"
|
|
summary: "Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents library."
|
|
parameters:
|
|
- description: "The serializer to serialize user defined models."
|
|
name: "jsonSerializer"
|
|
type: "<xref href=\"com.azure.core.util.serializer.JsonSerializer?alt=com.azure.core.util.serializer.JsonSerializer&text=JsonSerializer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder serializer(JsonSerializer jsonSerializer)"
|
|
desc: "Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents library."
|
|
returns:
|
|
description: "The updated SearchIndexClientBuilder object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.SearchIndexClientBuilder.serviceVersion(com.azure.search.documents.SearchServiceVersion)"
|
|
fullName: "com.azure.search.documents.indexes.SearchIndexClientBuilder.serviceVersion(SearchServiceVersion serviceVersion)"
|
|
name: "serviceVersion(SearchServiceVersion serviceVersion)"
|
|
nameWithType: "SearchIndexClientBuilder.serviceVersion(SearchServiceVersion serviceVersion)"
|
|
summary: "Sets the <xref uid=\"com.azure.search.documents.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.documents.SearchServiceVersion?alt=com.azure.search.documents.SearchServiceVersion&text=SearchServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchIndexClientBuilder serviceVersion(SearchServiceVersion serviceVersion)"
|
|
desc: "Sets the <xref uid=\"com.azure.search.documents.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.documents.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.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.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.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClients\"></xref> and <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClients\"></xref>.\n\n## Overview ##\n\nThis client allows you to create instances of <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> and <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> to utilize synchronous and asynchronous APIs respectively to interact with Azure AI Search.\n\n## Getting Started ##\n\n### Authentication ###\n\nAzure AI Search supports [ Microsoft Entra ID (role-based) authentication ][Microsoft Entra ID _role-based_ authentication] and [API keys][] for authentication.\n\nFor more information about the scopes of authorization, see the [Azure AI Search Security Overview][] documentation.\n\n#### Building and Authenticating a <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> using API keys ####\n\nTo build an instance of <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> using API keys, call <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively from the <xref uid=\"com.azure.search.documents.indexes.SearchIndexClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClientBuilder\"></xref>.\n\nThe following must be provided to construct a client instance.\n\n * The Azure AI Search service URL.\n * An <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"API Key\"></xref> that grants access to the Azure AI Search service.\n\n**Instantiating a synchronous Search Index Client**\n\n```java\nSearchIndexClient searchIndexClient = new SearchIndexClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildClient();\n```\n\n**Instantiating an asynchronous Search Index Client**\n\n```java\nSearchIndexAsyncClient searchIndexAsyncClient = new SearchIndexClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```\n\n#### Building and Authenticating a <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> using Microsoft Entra ####\n\nYou can also create a <xref uid=\"com.azure.search.documents.indexes.SearchIndexClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexClient\"></xref> or <xref uid=\"com.azure.search.documents.indexes.SearchIndexAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexAsyncClient\"></xref> using Microsoft Entra ID authentication. Your user or service principal must be assigned the \"Search Index Data Reader\" role. Using Azure Identity you can authenticate a service using Managed Identity or a service principal, authenticate as a developer working on an application, and more all without changing code. Please refer the [documentation][] for instructions on how to connect to Azure AI Search using Azure role-based access control (Azure RBAC).\n\nBefore you can use any credential type from Azure.Identity, you'll first need to install the Azure.Identity package.\nThere are a variety of credentials types available in Azure.Identity. To better understand your authentication options, view the [Azure Identity README][]. and [Azure Identity Samples][].\n\nMake sure you use the right namespace for DefaultAzureCredential at the top of your source file:\n\n```java\nimport com.azure.identity.DefaultAzureCredential;\n import com.azure.identity.DefaultAzureCredentialBuilder;\n```\n\nThen you can create an instance of DefaultAzureCredential and pass it to a new instance of your client:\n\n**Instantiating a synchronous Search Index Client**\n\n```java\nDefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();\n\n SearchIndexClient searchIndexClient = new SearchIndexClientBuilder()\n .credential(credential)\n .endpoint(\"{endpoint}\")\n .buildClient();\n```\n\n**Instantiating an asynchronous Search Index Client**\n\n```java\nDefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();\n\n SearchIndexAsyncClient searchIndexAsyncClient = new SearchIndexClientBuilder()\n .credential(credential)\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```\n\n\n[Microsoft Entra ID _role-based_ authentication]: https://learn.microsoft.com/azure/search/search-security-rbac?tabs=config-svc-portal%2Croles-portal%2Ctest-portal%2Ccustom-role-portal%2Cdisable-keys-portal\n[API keys]: https://learn.microsoft.com/azure/search/search-security-api-keys?tabs=portal-use%2Cportal-find%2Cportal-query\n[Azure AI Search Security Overview]: https://learn.microsoft.com/azure/search/search-security-overview#authentication\n[documentation]: https://learn.microsoft.com/azure/search/search-security-rbac?tabs=config-svc-portal,roles-portal,test-portal,custom-role-portal,disable-keys-portal\n[Azure Identity README]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity\n[Azure Identity Samples]: https://github.com/Azure/azure-sdk-for-java/wiki/Azure-Identity-Examples"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.SearchIndexClientBuilder?alt=com.azure.search.documents.indexes.SearchIndexClientBuilder&text=SearchIndexClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|