213 строки
18 KiB
YAML
213 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder"
|
|
name: "DeviceUpdateClientBuilder"
|
|
nameWithType: "DeviceUpdateClientBuilder"
|
|
summary: "A builder for creating a new instance of the Device<wbr>Update<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 **DeviceUpdateClientBuilder**</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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.DeviceUpdateClientBuilder()"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.DeviceUpdateClientBuilder()"
|
|
name: "DeviceUpdateClientBuilder()"
|
|
nameWithType: "DeviceUpdateClientBuilder.DeviceUpdateClientBuilder()"
|
|
summary: "Create an instance of the Device<wbr>Update<wbr>Client<wbr>Builder."
|
|
syntax: "public DeviceUpdateClientBuilder()"
|
|
desc: "Create an instance of the DeviceUpdateClientBuilder."
|
|
methods:
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "DeviceUpdateClientBuilder.buildAsyncClient()"
|
|
summary: "Builds an instance of Device<wbr>Update<wbr>Async<wbr>Client class."
|
|
syntax: "public DeviceUpdateAsyncClient buildAsyncClient()"
|
|
desc: "Builds an instance of DeviceUpdateAsyncClient class."
|
|
returns:
|
|
description: "an instance of DeviceUpdateAsyncClient."
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateAsyncClient?alt=com.azure.iot.deviceupdate.DeviceUpdateAsyncClient&text=DeviceUpdateAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.buildClient()"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "DeviceUpdateClientBuilder.buildClient()"
|
|
summary: "Builds an instance of Device<wbr>Update<wbr>Client class."
|
|
syntax: "public DeviceUpdateClient buildClient()"
|
|
desc: "Builds an instance of DeviceUpdateClient class."
|
|
returns:
|
|
description: "an instance of DeviceUpdateClient."
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClient?alt=com.azure.iot.deviceupdate.DeviceUpdateClient&text=DeviceUpdateClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder clientOptions(ClientOptions clientOptions)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder configuration(Configuration configuration)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.credential(TokenCredential tokenCredential)"
|
|
name: "credential(TokenCredential tokenCredential)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder credential(TokenCredential tokenCredential)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder endpoint(String endpoint)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder httpClient(HttpClient httpClient)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.instanceId(java.lang.String)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.instanceId(String instanceId)"
|
|
name: "instanceId(String instanceId)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder instanceId(String instanceId)"
|
|
desc: "Sets The Device Update for IoT Hub account instance identifier."
|
|
returns:
|
|
description: "the DeviceUpdateClientBuilder."
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.pipeline(HttpPipeline pipeline)"
|
|
name: "pipeline(HttpPipeline pipeline)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder pipeline(HttpPipeline pipeline)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder retryOptions(RetryOptions retryOptions)"
|
|
desc: "."
|
|
returns:
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
|
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
|
returns:
|
|
description: "the DeviceUpdateClientBuilder."
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.serviceVersion(com.azure.iot.deviceupdate.DeviceUpdateServiceVersion)"
|
|
fullName: "com.azure.iot.deviceupdate.DeviceUpdateClientBuilder.serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
|
|
name: "serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
|
|
nameWithType: "DeviceUpdateClientBuilder.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 DeviceUpdateClientBuilder serviceVersion(DeviceUpdateServiceVersion serviceVersion)"
|
|
desc: "Sets Service version."
|
|
returns:
|
|
description: "the DeviceUpdateClientBuilder."
|
|
type: "<xref href=\"com.azure.iot.deviceupdate.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A builder for creating a new instance of the DeviceUpdateClient 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" 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.DeviceUpdateClientBuilder?alt=com.azure.iot.deviceupdate.DeviceUpdateClientBuilder&text=DeviceUpdateClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.iot.deviceupdate"
|
|
artifact: com.azure:azure-iot-deviceupdate:1.0.5
|