-
Notifications
You must be signed in to change notification settings - Fork 258
/
com.azure.search.documents.SearchClientBuilder.yml
299 lines (299 loc) · 48.3 KB
/
com.azure.search.documents.SearchClientBuilder.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
### YamlMime:JavaType
uid: "com.azure.search.documents.SearchClientBuilder"
fullName: "com.azure.search.documents.SearchClientBuilder"
name: "SearchClientBuilder"
nameWithType: "SearchClientBuilder"
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClients\"></xref> and <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClients\"></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 **SearchClientBuilder**</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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.search.documents.SearchClientBuilder.SearchClientBuilder()"
fullName: "com.azure.search.documents.SearchClientBuilder.SearchClientBuilder()"
name: "SearchClientBuilder()"
nameWithType: "SearchClientBuilder.SearchClientBuilder()"
summary: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClients\"></xref> and <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClients\"></xref>."
syntax: "public SearchClientBuilder()"
desc: "Creates a builder instance that is able to configure and construct <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClients\"></xref> and <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClients\"></xref>."
methods:
- uid: "com.azure.search.documents.SearchClientBuilder.<T>bufferedSender(com.azure.core.util.serializer.TypeReference<T>)"
fullName: "com.azure.search.documents.SearchClientBuilder.bufferedSender(TypeReference<T> documentType)"
name: "bufferedSender(TypeReference<T> documentType)"
nameWithType: "SearchClientBuilder.bufferedSender(TypeReference<T> documentType)"
summary: "Create a new instance of <xref uid=\"com.azure.search.documents.SearchClientBuilder.SearchIndexingBufferedSenderBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedSenderBuilder\"></xref> used to configure <xref uid=\"com.azure.search.documents.SearchIndexingBufferedSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedSenders\"></xref> and <xref uid=\"com.azure.search.documents.SearchIndexingBufferedAsyncSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedAsyncSenders\"></xref>."
parameters:
- description: "The <xref uid=\"com.azure.core.util.serializer.TypeReference\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TypeReference\"></xref> representing the document type associated with the sender."
name: "documentType"
type: "<xref href=\"com.azure.core.util.serializer.TypeReference?alt=com.azure.core.util.serializer.TypeReference&text=TypeReference\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public SearchClientBuilder.SearchIndexingBufferedSenderBuilder<T> <T>bufferedSender(TypeReference<T> documentType)"
desc: "Create a new instance of <xref uid=\"com.azure.search.documents.SearchClientBuilder.SearchIndexingBufferedSenderBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedSenderBuilder\"></xref> used to configure <xref uid=\"com.azure.search.documents.SearchIndexingBufferedSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedSenders\"></xref> and <xref uid=\"com.azure.search.documents.SearchIndexingBufferedAsyncSender\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedAsyncSenders\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.search.documents.SearchClientBuilder.SearchIndexingBufferedSenderBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexingBufferedSenderBuilder\"></xref>."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder.SearchIndexingBufferedSenderBuilder?alt=com.azure.search.documents.SearchClientBuilder.SearchIndexingBufferedSenderBuilder&text=SearchIndexingBufferedSenderBuilder\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.search.documents.SearchClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.search.documents.SearchClientBuilder.addPolicy(HttpPipelinePolicy policy)"
name: "addPolicy(HttpPipelinePolicy policy)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.audience(com.azure.search.documents.models.SearchAudience)"
fullName: "com.azure.search.documents.SearchClientBuilder.audience(SearchAudience audience)"
name: "audience(SearchAudience audience)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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.SearchClientBuilder.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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.buildAsyncClient()"
fullName: "com.azure.search.documents.SearchClientBuilder.buildAsyncClient()"
name: "buildAsyncClient()"
nameWithType: "SearchClientBuilder.buildAsyncClient()"
summary: "Creates a <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> based on options set in the builder."
syntax: "public SearchAsyncClient buildAsyncClient()"
desc: "Creates a <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.documents.SearchClientBuilder.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.documents.SearchClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>, and <xref uid=\"com.azure.search.documents.SearchClientBuilder.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.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A SearchClient with the options set from the builder."
type: "<xref href=\"com.azure.search.documents.SearchAsyncClient?alt=com.azure.search.documents.SearchAsyncClient&text=SearchAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.buildClient()"
fullName: "com.azure.search.documents.SearchClientBuilder.buildClient()"
name: "buildClient()"
nameWithType: "SearchClientBuilder.buildClient()"
summary: "Creates a <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> based on options set in the builder."
syntax: "public SearchClient buildClient()"
desc: "Creates a <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> based on options set in the builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.search.documents.SearchClientBuilder.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.documents.SearchClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>, and <xref uid=\"com.azure.search.documents.SearchClientBuilder.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.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A SearchClient with the options set from the builder."
type: "<xref href=\"com.azure.search.documents.SearchClient?alt=com.azure.search.documents.SearchClient&text=SearchClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
fullName: "com.azure.search.documents.SearchClientBuilder.clientOptions(ClientOptions clientOptions)"
name: "clientOptions(ClientOptions clientOptions)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.configuration(com.azure.core.util.Configuration)"
fullName: "com.azure.search.documents.SearchClientBuilder.configuration(Configuration configuration)"
name: "configuration(Configuration configuration)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
fullName: "com.azure.search.documents.SearchClientBuilder.credential(AzureKeyCredential credential)"
name: "credential(AzureKeyCredential credential)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.credential(com.azure.core.credential.TokenCredential)"
fullName: "com.azure.search.documents.SearchClientBuilder.credential(TokenCredential credential)"
name: "credential(TokenCredential credential)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.endpoint(java.lang.String)"
fullName: "com.azure.search.documents.SearchClientBuilder.endpoint(String endpoint)"
name: "endpoint(String endpoint)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder endpoint(String endpoint)"
desc: "Sets the service endpoint for the Azure AI Search instance."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.getDefaultLogOptions()"
fullName: "com.azure.search.documents.SearchClientBuilder.getDefaultLogOptions()"
name: "getDefaultLogOptions()"
nameWithType: "SearchClientBuilder.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.SearchClientBuilder.httpClient(com.azure.core.http.HttpClient)"
fullName: "com.azure.search.documents.SearchClientBuilder.httpClient(HttpClient client)"
name: "httpClient(HttpClient client)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
fullName: "com.azure.search.documents.SearchClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
name: "httpLogOptions(HttpLogOptions logOptions)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.indexName(java.lang.String)"
fullName: "com.azure.search.documents.SearchClientBuilder.indexName(String indexName)"
name: "indexName(String indexName)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder indexName(String indexName)"
desc: "Sets the name of the index."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
fullName: "com.azure.search.documents.SearchClientBuilder.pipeline(HttpPipeline httpPipeline)"
name: "pipeline(HttpPipeline httpPipeline)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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.SearchClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> and <xref uid=\"com.azure.search.documents.SearchClientBuilder.indexName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"index\"></xref> when building a <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> or <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref>."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
fullName: "com.azure.search.documents.SearchClientBuilder.retryOptions(RetryOptions retryOptions)"
name: "retryOptions(RetryOptions retryOptions)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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.SearchClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
fullName: "com.azure.search.documents.SearchClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
name: "retryPolicy(RetryPolicy retryPolicy)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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.SearchClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.serializer(com.azure.core.util.serializer.JsonSerializer)"
fullName: "com.azure.search.documents.SearchClientBuilder.serializer(JsonSerializer jsonSerializer)"
name: "serializer(JsonSerializer jsonSerializer)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.SearchClientBuilder.serviceVersion(com.azure.search.documents.SearchServiceVersion)"
fullName: "com.azure.search.documents.SearchClientBuilder.serviceVersion(SearchServiceVersion serviceVersion)"
name: "serviceVersion(SearchServiceVersion serviceVersion)"
nameWithType: "SearchClientBuilder.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 SearchClientBuilder 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 the default is used, updating to a newer client library may implicitly use a newer version of the service."
returns:
description: "The updated SearchClientBuilder object."
type: "<xref href=\"com.azure.search.documents.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClients\"></xref> and <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClients\"></xref>.\n\n## Overview ##\n\nThis client allows you to create instances of <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> and <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></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.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> or <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> using API keys ####\n\nTo build an instance of <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> or <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> using API keys, call <xref uid=\"com.azure.search.documents.SearchClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.search.documents.SearchClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively from the <xref uid=\"com.azure.search.documents.SearchClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClientBuilder\"></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 Client**\n\n```java\nSearchClient searchClient = new SearchClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .indexName(\"{indexName}\")\n .buildClient();\n```\n\n**Instantiating an asynchronous Search Client**\n\n```java\nSearchAsyncClient searchAsyncClient = new SearchClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .indexName(\"{indexName}\")\n .buildAsyncClient();\n```\n\n#### Building and Authenticating a <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> or <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> using Microsoft Entra ID ####\n\nYou can also create a <xref uid=\"com.azure.search.documents.SearchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchClient\"></xref> or <xref uid=\"com.azure.search.documents.SearchAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchAsyncClient\"></xref> using Microsoft Entra ID authentication. Your user or service principal must be assigned the \"Search Index Data Reader\" role. Using the DefaultAzureCredential 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 the \\`DefaultAzureCredential\\`, or any credential type from Azure.Identity, you'll first need to install the Azure.Identity package.\n\nTo use DefaultAzureCredential with a client ID and secret, you'll need to set the \\`AZURE\\_TENANT\\_ID\\`, \\`AZURE\\_CLIENT\\_ID\\`, and \\`AZURE\\_CLIENT\\_SECRET\\` environment variables; alternatively, you can pass those values to the \\`ClientSecretCredential\\` also in azure-identity.\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\nThe following sample builds a SearchClient using DefaultAzureCredential.\n\n**Instantiating a synchronous Search Client**\n\n```java\nDefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();\n\n SearchClient searchClient = new SearchClientBuilder()\n .credential(credential)\n .endpoint(\"{endpoint}\")\n .indexName(\"{indexName}\")\n .buildClient();\n```\n\n**Instantiating an asynchronous Search Client**\n\n```java\nDefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();\n\n SearchAsyncClient searchAsyncClient = new SearchClientBuilder()\n .credential(credential)\n .endpoint(\"{endpoint}\")\n .indexName(\"{indexName}\")\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"
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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" 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.SearchClientBuilder?alt=com.azure.search.documents.SearchClientBuilder&text=SearchClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.search.documents"
artifact: com.azure:azure-search-documents:11.7.0