229 строки
32 KiB
YAML
229 строки
32 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder"
|
|
name: "DigitalTwinsClientBuilder"
|
|
nameWithType: "DigitalTwinsClientBuilder"
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsClients\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsAsyncClients\"></xref>, call <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder.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\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
syntax: "public final class DigitalTwinsClientBuilder implements ConfigurationTrait<DigitalTwinsClientBuilder>, EndpointTrait<DigitalTwinsClientBuilder>, HttpTrait<DigitalTwinsClientBuilder>, TokenCredentialTrait<DigitalTwinsClientBuilder>"
|
|
constructors:
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.DigitalTwinsClientBuilder()"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.DigitalTwinsClientBuilder()"
|
|
name: "DigitalTwinsClientBuilder()"
|
|
nameWithType: "DigitalTwinsClientBuilder.DigitalTwinsClientBuilder()"
|
|
summary: "The public constructor for Digital<wbr>Twins<wbr>Client<wbr>Builder"
|
|
syntax: "public DigitalTwinsClientBuilder()"
|
|
desc: "The public constructor for DigitalTwinsClientBuilder"
|
|
methods:
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
nameWithType: "DigitalTwinsClientBuilder.addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
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: "pipelinePolicy"
|
|
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 DigitalTwinsClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)"
|
|
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 DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "DigitalTwinsClientBuilder.buildAsyncClient()"
|
|
summary: "Create a <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsAsyncClient\"></xref> based on the builder settings."
|
|
syntax: "public DigitalTwinsAsyncClient buildAsyncClient()"
|
|
desc: "Create a <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsAsyncClient\"></xref> based on the builder settings."
|
|
returns:
|
|
description: "the created asynchronous DigitalTwinsAsyncClient"
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient?alt=com.azure.digitaltwins.core.DigitalTwinsAsyncClient&text=DigitalTwinsAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildClient()"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "DigitalTwinsClientBuilder.buildClient()"
|
|
summary: "Create a <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsClient\"></xref> based on the builder settings."
|
|
syntax: "public DigitalTwinsClient buildClient()"
|
|
desc: "Create a <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsClient\"></xref> based on the builder settings."
|
|
returns:
|
|
description: "the created synchronous DigitalTwinsClient"
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClient?alt=com.azure.digitaltwins.core.DigitalTwinsClient&text=DigitalTwinsClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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 DigitalTwinsClientBuilder object."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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=\"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 DigitalTwinsClientBuilder object for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.credential(TokenCredential tokenCredential)"
|
|
name: "credential(TokenCredential tokenCredential)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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 DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "DigitalTwinsClientBuilder.endpoint(String endpoint)"
|
|
summary: "Set the service endpoint that the built client will communicate with."
|
|
parameters:
|
|
- description: "URL of the service."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public DigitalTwinsClientBuilder endpoint(String endpoint)"
|
|
desc: "Set the service endpoint that the built client will communicate with. This field is mandatory to set."
|
|
returns:
|
|
description: "the updated DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "DigitalTwinsClientBuilder.httpClient(HttpClient httpClient)"
|
|
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: "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 DigitalTwinsClientBuilder httpClient(HttpClient httpClient)"
|
|
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 DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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 DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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.digitaltwins.core.DigitalTwinsClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>."
|
|
returns:
|
|
description: "the updated DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 DigitalTwinsClientBuilder 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.digitaltwins.core.DigitalTwinsClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "the updated DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "DigitalTwinsClientBuilder.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 is used as the retry policy for each request that is sent."
|
|
parameters:
|
|
- description: "the retry policy applied to each request."
|
|
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 DigitalTwinsClientBuilder 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 is used as the retry policy for each request that is sent. The default retry policy will be used if not provided. The default retry policy is <xref uid=\"com.azure.core.http.policy.RetryPolicy.RetryPolicy*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy#RetryPolicy()\"></xref>. For implementing custom retry logic, see <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> as an example. Setting this is mutually exclusive with using <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "the updated DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.serializer(com.azure.core.util.serializer.JsonSerializer)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.serializer(JsonSerializer jsonSerializer)"
|
|
name: "serializer(JsonSerializer jsonSerializer)"
|
|
nameWithType: "DigitalTwinsClientBuilder.serializer(JsonSerializer jsonSerializer)"
|
|
summary: "Custom JSON serializer that is used to handle model types that are not contained in the Azure Digital Twins library."
|
|
parameters:
|
|
- description: "The serializer to deserialize response payloads into 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 DigitalTwinsClientBuilder serializer(JsonSerializer jsonSerializer)"
|
|
desc: "Custom JSON serializer that is used to handle model types that are not contained in the Azure Digital Twins library."
|
|
returns:
|
|
description: "The updated DigitalTwinsClientBuilder object."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.serviceVersion(com.azure.digitaltwins.core.DigitalTwinsServiceVersion)"
|
|
fullName: "com.azure.digitaltwins.core.DigitalTwinsClientBuilder.serviceVersion(DigitalTwinsServiceVersion serviceVersion)"
|
|
name: "serviceVersion(DigitalTwinsServiceVersion serviceVersion)"
|
|
nameWithType: "DigitalTwinsClientBuilder.serviceVersion(DigitalTwinsServiceVersion serviceVersion)"
|
|
summary: "Sets the <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "The service API version to use."
|
|
name: "serviceVersion"
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsServiceVersion?alt=com.azure.digitaltwins.core.DigitalTwinsServiceVersion&text=DigitalTwinsServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinsClientBuilder serviceVersion(DigitalTwinsServiceVersion serviceVersion)"
|
|
desc: "Sets the <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsServiceVersion\"></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 of the client library will have the result of potentially moving to a newer service version.\n\nTargeting a specific service version may also mean that the service will return an error for newer APIs."
|
|
returns:
|
|
description: "the updated DigitalTwinsClientBuilder instance for fluent building."
|
|
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" 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.digitaltwins.core.DigitalTwinsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsClients\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinsAsyncClients\"></xref>, call <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
|
|
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.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" 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.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" 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.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" 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.digitaltwins.core.DigitalTwinsClientBuilder?alt=com.azure.digitaltwins.core.DigitalTwinsClientBuilder&text=DigitalTwinsClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.digitaltwins.core"
|
|
artifact: com.azure:azure-digitaltwins-core:1.3.2
|