258 строки
39 KiB
YAML
258 строки
39 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder"
|
|
name: "MixedRealityStsClientBuilder"
|
|
nameWithType: "MixedRealityStsClientBuilder"
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClients\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref>, call <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder implements AzureKeyCredentialTrait<MixedRealityStsClientBuilder>, ConfigurationTrait<MixedRealityStsClientBuilder>, EndpointTrait<MixedRealityStsClientBuilder>, HttpTrait<MixedRealityStsClientBuilder>, TokenCredentialTrait<MixedRealityStsClientBuilder>"
|
|
constructors:
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.MixedRealityStsClientBuilder()"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.MixedRealityStsClientBuilder()"
|
|
name: "MixedRealityStsClientBuilder()"
|
|
nameWithType: "MixedRealityStsClientBuilder.MixedRealityStsClientBuilder()"
|
|
summary: "Constructs a new builder used to configure and build <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClients\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClients\"></xref>."
|
|
syntax: "public MixedRealityStsClientBuilder()"
|
|
desc: "Constructs a new builder used to configure and build <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClients\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClients\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.accountDomain(java.lang.String)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.accountDomain(String accountDomain)"
|
|
name: "accountDomain(String accountDomain)"
|
|
nameWithType: "MixedRealityStsClientBuilder.accountDomain(String accountDomain)"
|
|
summary: "Sets the Mixed Reality service account domain."
|
|
parameters:
|
|
- description: "The Mixed Reality service account domain."
|
|
name: "accountDomain"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MixedRealityStsClientBuilder accountDomain(String accountDomain)"
|
|
desc: "Sets the Mixed Reality service account domain."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.accountId(java.lang.String)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.accountId(String accountId)"
|
|
name: "accountId(String accountId)"
|
|
nameWithType: "MixedRealityStsClientBuilder.accountId(String accountId)"
|
|
summary: "Sets the Mixed Reality service account identifier."
|
|
parameters:
|
|
- description: "The Mixed Reality service account identifier. The value is expected to be in UUID format."
|
|
name: "accountId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MixedRealityStsClientBuilder accountId(String accountId)"
|
|
desc: "Sets the Mixed Reality service account identifier."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
|
nameWithType: "MixedRealityStsClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
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: "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 MixedRealityStsClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
|
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 <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "MixedRealityStsClientBuilder.buildAsyncClient()"
|
|
summary: "Create a <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> based on options set in the builder."
|
|
syntax: "public MixedRealityStsAsyncClient buildAsyncClient()"
|
|
desc: "Create a <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> is created."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> with the options set from the builder."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient?alt=com.azure.mixedreality.authentication.MixedRealityStsAsyncClient&text=MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildClient()"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "MixedRealityStsClientBuilder.buildClient()"
|
|
summary: "Create a <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref> based on options set in the builder."
|
|
syntax: "public MixedRealityStsClient buildClient()"
|
|
desc: "Create a <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref> based on options set in the builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref> is created."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref> with the options set from the builder."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClient?alt=com.azure.mixedreality.authentication.MixedRealityStsClient&text=MixedRealityStsClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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 <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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 MixedRealityStsClientBuilder object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.credential(AzureKeyCredential keyCredential)"
|
|
name: "credential(AzureKeyCredential keyCredential)"
|
|
nameWithType: "MixedRealityStsClientBuilder.credential(AzureKeyCredential keyCredential)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests."
|
|
name: "keyCredential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MixedRealityStsClientBuilder credential(AzureKeyCredential keyCredential)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> used to authenticate HTTP requests.\n\n**Note:** Not recommended for production applications."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.credential(TokenCredential tokenCredential)"
|
|
name: "credential(TokenCredential tokenCredential)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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 <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "MixedRealityStsClientBuilder.endpoint(String endpoint)"
|
|
summary: "Sets the Mixed Reality STS service endpoint."
|
|
parameters:
|
|
- description: "The Mixed Reality STS service endpoint."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MixedRealityStsClientBuilder endpoint(String endpoint)"
|
|
desc: "Sets the Mixed Reality STS service endpoint."
|
|
returns:
|
|
description: "The updated MixedRealityStsClientBuilder object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.httpClient(HttpClient client)"
|
|
name: "httpClient(HttpClient client)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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 <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.pipeline(HttpPipeline pipeline)"
|
|
name: "pipeline(HttpPipeline pipeline)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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\nIf `pipeline` is set, all other settings are ignored, aside from <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> to build <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> or <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref>."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "MixedRealityStsClientBuilder.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 MixedRealityStsClientBuilder 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.mixedreality.authentication.MixedRealityStsClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "The updated MixedRealityStsClientBuilder object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "MixedRealityStsClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> that is used to retry requests."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> that will be used to retry requests."
|
|
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 MixedRealityStsClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> that is used to retry requests.\n\nThe default retry policy will be used if not provided <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClientBuilder#buildAsyncClient()\"></xref> to build <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref> or <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClient\"></xref>.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "The updated MixedRealityStsClientBuilder object."
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.serviceVersion(com.azure.mixedreality.authentication.MixedRealityStsServiceVersion)"
|
|
fullName: "com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.serviceVersion(MixedRealityStsServiceVersion version)"
|
|
name: "serviceVersion(MixedRealityStsServiceVersion version)"
|
|
nameWithType: "MixedRealityStsClientBuilder.serviceVersion(MixedRealityStsServiceVersion version)"
|
|
summary: "Sets the <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsServiceVersion\"></xref> of the service to be used when making requests."
|
|
name: "version"
|
|
type: "<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsServiceVersion?alt=com.azure.mixedreality.authentication.MixedRealityStsServiceVersion&text=MixedRealityStsServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MixedRealityStsClientBuilder serviceVersion(MixedRealityStsServiceVersion version)"
|
|
desc: "Sets the <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsServiceVersion\"></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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" 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.mixedreality.authentication.MixedRealityStsClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsClients\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MixedRealityStsAsyncClient\"></xref>, call <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient\"></xref> and <xref uid=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder.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.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" 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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" 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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" 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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" 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.mixedreality.authentication.MixedRealityStsClientBuilder?alt=com.azure.mixedreality.authentication.MixedRealityStsClientBuilder&text=MixedRealityStsClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.mixedreality.authentication"
|
|
artifact: com.azure:azure-mixedreality-authentication:1.2.6
|