-
Notifications
You must be signed in to change notification settings - Fork 254
/
com.azure.iot.deviceupdate.DeviceManagementClientBuilder.yml
212 lines (212 loc) · 18.2 KB
/
com.azure.iot.deviceupdate.DeviceManagementClientBuilder.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
### YamlMime:JavaType
uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder"
name: "DeviceManagementClientBuilder"
nameWithType: "DeviceManagementClientBuilder"
summary: "A builder for creating a new instance of the Device<wbr>Management<wbr>Client type."
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 **DeviceManagementClientBuilder**</br> implements <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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.DeviceManagementClientBuilder()"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.DeviceManagementClientBuilder()"
name: "DeviceManagementClientBuilder()"
nameWithType: "DeviceManagementClientBuilder.DeviceManagementClientBuilder()"
summary: "Create an instance of the Device<wbr>Management<wbr>Client<wbr>Builder."
syntax: "public DeviceManagementClientBuilder()"
desc: "Create an instance of the DeviceManagementClientBuilder."
methods:
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
name: "addPolicy(HttpPipelinePolicy customPolicy)"
nameWithType: "DeviceManagementClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
summary: "."
parameters:
- name: "customPolicy"
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 DeviceManagementClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.buildAsyncClient()"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.buildAsyncClient()"
name: "buildAsyncClient()"
nameWithType: "DeviceManagementClientBuilder.buildAsyncClient()"
summary: "Builds an instance of Device<wbr>Management<wbr>Async<wbr>Client class."
syntax: "public DeviceManagementAsyncClient buildAsyncClient()"
desc: "Builds an instance of DeviceManagementAsyncClient class."
returns:
description: "an instance of DeviceManagementAsyncClient."
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementAsyncClient?alt=com.azure.iot.deviceupdate.DeviceManagementAsyncClient&text=DeviceManagementAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.buildClient()"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.buildClient()"
name: "buildClient()"
nameWithType: "DeviceManagementClientBuilder.buildClient()"
summary: "Builds an instance of Device<wbr>Management<wbr>Client class."
syntax: "public DeviceManagementClient buildClient()"
desc: "Builds an instance of DeviceManagementClient class."
returns:
description: "an instance of DeviceManagementClient."
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClient?alt=com.azure.iot.deviceupdate.DeviceManagementClient&text=DeviceManagementClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.clientOptions(ClientOptions clientOptions)"
name: "clientOptions(ClientOptions clientOptions)"
nameWithType: "DeviceManagementClientBuilder.clientOptions(ClientOptions clientOptions)"
summary: "."
parameters:
- 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 DeviceManagementClientBuilder clientOptions(ClientOptions clientOptions)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.configuration(com.azure.core.util.Configuration)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.configuration(Configuration configuration)"
name: "configuration(Configuration configuration)"
nameWithType: "DeviceManagementClientBuilder.configuration(Configuration configuration)"
summary: "."
parameters:
- 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 DeviceManagementClientBuilder configuration(Configuration configuration)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.credential(com.azure.core.credential.TokenCredential)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.credential(TokenCredential tokenCredential)"
name: "credential(TokenCredential tokenCredential)"
nameWithType: "DeviceManagementClientBuilder.credential(TokenCredential tokenCredential)"
summary: "."
parameters:
- 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 DeviceManagementClientBuilder credential(TokenCredential tokenCredential)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.endpoint(java.lang.String)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.endpoint(String endpoint)"
name: "endpoint(String endpoint)"
nameWithType: "DeviceManagementClientBuilder.endpoint(String endpoint)"
summary: "."
parameters:
- name: "endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DeviceManagementClientBuilder endpoint(String endpoint)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.httpClient(com.azure.core.http.HttpClient)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.httpClient(HttpClient httpClient)"
name: "httpClient(HttpClient httpClient)"
nameWithType: "DeviceManagementClientBuilder.httpClient(HttpClient httpClient)"
summary: "."
parameters:
- name: "httpClient"
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceManagementClientBuilder httpClient(HttpClient httpClient)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
nameWithType: "DeviceManagementClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
summary: "."
parameters:
- name: "httpLogOptions"
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 DeviceManagementClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.instanceId(java.lang.String)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.instanceId(String instanceId)"
name: "instanceId(String instanceId)"
nameWithType: "DeviceManagementClientBuilder.instanceId(String instanceId)"
summary: "Sets The Device Update for IoT Hub account instance identifier."
parameters:
- description: "the instanceId value."
name: "instanceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DeviceManagementClientBuilder instanceId(String instanceId)"
desc: "Sets The Device Update for IoT Hub account instance identifier."
returns:
description: "the DeviceManagementClientBuilder."
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.pipeline(HttpPipeline pipeline)"
name: "pipeline(HttpPipeline pipeline)"
nameWithType: "DeviceManagementClientBuilder.pipeline(HttpPipeline pipeline)"
summary: "."
parameters:
- 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 DeviceManagementClientBuilder pipeline(HttpPipeline pipeline)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.retryOptions(RetryOptions retryOptions)"
name: "retryOptions(RetryOptions retryOptions)"
nameWithType: "DeviceManagementClientBuilder.retryOptions(RetryOptions retryOptions)"
summary: "."
parameters:
- 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 DeviceManagementClientBuilder retryOptions(RetryOptions retryOptions)"
desc: "."
returns:
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
name: "retryPolicy(RetryPolicy retryPolicy)"
nameWithType: "DeviceManagementClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
parameters:
- description: "the retryPolicy value."
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 DeviceManagementClientBuilder retryPolicy(RetryPolicy retryPolicy)"
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
returns:
description: "the DeviceManagementClientBuilder."
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.serviceVersion(com.azure.iot.deviceupdate.DeviceUpdateServiceVersion)"
fullName: "com.azure.iot.deviceupdate.DeviceManagementClientBuilder.serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
name: "serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
nameWithType: "DeviceManagementClientBuilder.serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
summary: "Sets Service version."
parameters:
- description: "the serviceVersion value."
name: "serviceVersion"
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateServiceVersion?alt=com.azure.iot.deviceupdate.DeviceUpdateServiceVersion&text=DeviceUpdateServiceVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceManagementClientBuilder serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
desc: "Sets Service version."
returns:
description: "the DeviceManagementClientBuilder."
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A builder for creating a new instance of the DeviceManagementClient type."
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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" 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.iot.deviceupdate.DeviceManagementClientBuilder?alt=com.azure.iot.deviceupdate.DeviceManagementClientBuilder&text=DeviceManagementClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.iot.deviceupdate"
artifact: com.azure:azure-iot-deviceupdate:1.0.20