-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.data.appconfiguration.ConfigurationClientBuilder.yml
231 lines (231 loc) · 40.2 KB
/
com.azure.data.appconfiguration.ConfigurationClientBuilder.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
### YamlMime:JavaType
uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder"
name: "ConfigurationClientBuilder"
nameWithType: "ConfigurationClientBuilder"
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClients\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClients\"></xref>, call <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
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 **ConfigurationClientBuilder**</br> implements <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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.ConfigurationClientBuilder()"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.ConfigurationClientBuilder()"
name: "ConfigurationClientBuilder()"
nameWithType: "ConfigurationClientBuilder.ConfigurationClientBuilder()"
summary: "Constructs a new builder used to configure and build <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClients\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClients\"></xref>."
syntax: "public ConfigurationClientBuilder()"
desc: "Constructs a new builder used to configure and build <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClients\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClients\"></xref>."
methods:
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.addPolicy(HttpPipelinePolicy policy)"
name: "addPolicy(HttpPipelinePolicy policy)"
nameWithType: "ConfigurationClientBuilder.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 ConfigurationClientBuilder 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 ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.buildAsyncClient()"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.buildAsyncClient()"
name: "buildAsyncClient()"
nameWithType: "ConfigurationClientBuilder.buildAsyncClient()"
summary: "Creates a <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClient\"></xref> based on options set in the Builder."
syntax: "public ConfigurationAsyncClient buildAsyncClient()"
desc: "Creates a <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClient\"></xref> based on options set in the Builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A ConfigurationAsyncClient with the options set from the builder."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationAsyncClient?alt=com.azure.data.appconfiguration.ConfigurationAsyncClient&text=ConfigurationAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.buildClient()"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.buildClient()"
name: "buildClient()"
nameWithType: "ConfigurationClientBuilder.buildClient()"
summary: "Creates a <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClient\"></xref> based on options set in the Builder."
syntax: "public ConfigurationClient buildClient()"
desc: "Creates a <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClient\"></xref> based on options set in the Builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A ConfigurationClient with the options set from the builder."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClient?alt=com.azure.data.appconfiguration.ConfigurationClient&text=ConfigurationClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.clientOptions(ClientOptions clientOptions)"
name: "clientOptions(ClientOptions clientOptions)"
nameWithType: "ConfigurationClientBuilder.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 ConfigurationClientBuilder 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 ConfigurationClientBuilder object"
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.configuration(com.azure.core.util.Configuration)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.configuration(Configuration configuration)"
name: "configuration(Configuration configuration)"
nameWithType: "ConfigurationClientBuilder.configuration(Configuration configuration)"
summary: "Sets the configuration store that is used during construction of the service client."
parameters:
- description: "The configuration store used to"
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 ConfigurationClientBuilder configuration(Configuration configuration)"
desc: "Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"global 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 ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.connectionString(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.connectionString(String connectionString)"
name: "connectionString(String connectionString)"
nameWithType: "ConfigurationClientBuilder.connectionString(String connectionString)"
summary: "Sets the credential to use when authenticating HTTP requests."
parameters:
- description: "Connection string in the format \"endpoint={endpoint_value};id={id_value};\n secret={secret_value}\""
name: "connectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ConfigurationClientBuilder connectionString(String connectionString)"
desc: "Sets the credential to use when authenticating HTTP requests. Also, sets the <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> for this ConfigurationClientBuilder."
returns:
description: "The updated ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.credential(com.azure.core.credential.TokenCredential)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.credential(TokenCredential tokenCredential)"
name: "credential(TokenCredential tokenCredential)"
nameWithType: "ConfigurationClientBuilder.credential(TokenCredential tokenCredential)"
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: "tokenCredential"
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConfigurationClientBuilder credential(TokenCredential tokenCredential)"
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 ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(String endpoint)"
name: "endpoint(String endpoint)"
nameWithType: "ConfigurationClientBuilder.endpoint(String endpoint)"
summary: "Sets the service endpoint for the Azure App Configuration instance."
parameters:
- description: "The URL of the Azure App Configuration instance."
name: "endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ConfigurationClientBuilder endpoint(String endpoint)"
desc: "Sets the service endpoint for the Azure App Configuration instance."
returns:
description: "The updated ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.httpClient(com.azure.core.http.HttpClient)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.httpClient(HttpClient client)"
name: "httpClient(HttpClient client)"
nameWithType: "ConfigurationClientBuilder.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 ConfigurationClientBuilder 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 ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
name: "httpLogOptions(HttpLogOptions logOptions)"
nameWithType: "ConfigurationClientBuilder.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 ConfigurationClientBuilder 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 ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.pipeline(HttpPipeline pipeline)"
name: "pipeline(HttpPipeline pipeline)"
nameWithType: "ConfigurationClientBuilder.pipeline(HttpPipeline pipeline)"
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: "pipeline"
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConfigurationClientBuilder pipeline(HttpPipeline pipeline)"
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\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> is not ignored when `pipeline` is set."
returns:
description: "The updated ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.retryOptions(RetryOptions retryOptions)"
name: "retryOptions(RetryOptions retryOptions)"
nameWithType: "ConfigurationClientBuilder.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 ConfigurationClientBuilder 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.data.appconfiguration.ConfigurationClientBuilder.retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(HttpPipelinePolicy)\"></xref>."
returns:
description: "The updated <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.retryPolicy(HttpPipelinePolicy retryPolicy)"
name: "retryPolicy(HttpPipelinePolicy retryPolicy)"
nameWithType: "ConfigurationClientBuilder.retryPolicy(HttpPipelinePolicy retryPolicy)"
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that is used to retry requests."
parameters:
- description: "The <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that will be used to retry requests. For example,\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> can be used to retry requests."
name: "retryPolicy"
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 ConfigurationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)"
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that is used to retry requests.\n\nThe default retry policy will be used if not provided <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClientBuilder#buildAsyncClient()\"></xref> to build <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClient\"></xref> or <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClient\"></xref>.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
returns:
description: "The updated ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.ConfigurationClientBuilder.serviceVersion(com.azure.data.appconfiguration.ConfigurationServiceVersion)"
fullName: "com.azure.data.appconfiguration.ConfigurationClientBuilder.serviceVersion(ConfigurationServiceVersion version)"
name: "serviceVersion(ConfigurationServiceVersion version)"
nameWithType: "ConfigurationClientBuilder.serviceVersion(ConfigurationServiceVersion version)"
summary: "Sets the <xref uid=\"com.azure.data.appconfiguration.ConfigurationServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationServiceVersion\"></xref> that is used when making API requests."
parameters:
- description: "<xref uid=\"com.azure.data.appconfiguration.ConfigurationServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationServiceVersion\"></xref> of the service to be used when making requests."
name: "version"
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationServiceVersion?alt=com.azure.data.appconfiguration.ConfigurationServiceVersion&text=ConfigurationServiceVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConfigurationClientBuilder serviceVersion(ConfigurationServiceVersion version)"
desc: "Sets the <xref uid=\"com.azure.data.appconfiguration.ConfigurationServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationServiceVersion\"></xref> that is used when making API requests.\n\nIf a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version."
returns:
description: "The updated ConfigurationClientBuilder object."
type: "<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClients\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClients\"></xref>, call <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure App Configuration store and access credential. <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.connectionString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"connectionString(String)\"></xref> gives the builder the service endpoint and access credential.\n\n**Instantiating an asynchronous Configuration Client**\n\n```java\nConfigurationAsyncClient configurationAsyncClient = new ConfigurationClientBuilder()\n .connectionString(connectionString)\n .buildAsyncClient();\n```\n\n**Instantiating a synchronous Configuration Client**\n\n```java\nConfigurationClient configurationClient = new ConfigurationClientBuilder()\n .connectionString(connectionString)\n .buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service but it doesn't contain the service endpoint. Set the pipeline with <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationClient\"></xref> and <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .policies(/* add policies */)\n .build();\n\n ConfigurationClient configurationClient = new ConfigurationClientBuilder()\n .pipeline(pipeline)\n .endpoint(\"https://myconfig.azure.net/\")\n .connectionString(connectionString)\n .buildClient();\n```"
implements:
- "<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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" 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.data.appconfiguration.ConfigurationClientBuilder?alt=com.azure.data.appconfiguration.ConfigurationClientBuilder&text=ConfigurationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.data.appconfiguration"
artifact: com.azure:azure-data-appconfiguration:1.6.1