azure-docs-sdk-java/docs-ref-autogen/com.azure.mixedreality.remo...

254 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder"
name: "RemoteRenderingClientBuilder"
nameWithType: "RemoteRenderingClientBuilder"
summary: "A builder for creating instances of Remote<wbr>Rendering<wbr>Client and Remote<wbr>Rendering<wbr>Async<wbr>Client."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **RemoteRenderingClientBuilder**"
constructors:
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.RemoteRenderingClientBuilder()"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.RemoteRenderingClientBuilder()"
name: "RemoteRenderingClientBuilder()"
nameWithType: "RemoteRenderingClientBuilder.RemoteRenderingClientBuilder()"
summary: "Constructs a new Remote<wbr>Rendering<wbr>Client<wbr>Builder instance."
syntax: "public RemoteRenderingClientBuilder()"
desc: "Constructs a new RemoteRenderingClientBuilder instance."
methods:
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accessToken(com.azure.core.credential.AccessToken)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accessToken(AccessToken accessToken)"
name: "accessToken(AccessToken accessToken)"
nameWithType: "RemoteRenderingClientBuilder.accessToken(AccessToken accessToken)"
summary: "Use a <xref uid=\"com.azure.core.credential.AccessToken\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessToken\"></xref> for authentication."
parameters:
- description: "An access token used to access the specified Azure Remote Rendering account"
name: "accessToken"
type: "<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />"
syntax: "public RemoteRenderingClientBuilder accessToken(AccessToken accessToken)"
desc: "Use a <xref uid=\"com.azure.core.credential.AccessToken\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessToken\"></xref> for authentication."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accountDomain(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accountDomain(String accountDomain)"
name: "accountDomain(String accountDomain)"
nameWithType: "RemoteRenderingClientBuilder.accountDomain(String accountDomain)"
summary: "Sets the account<wbr>Domain."
parameters:
- description: "the accountDomain value."
name: "accountDomain"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public RemoteRenderingClientBuilder accountDomain(String accountDomain)"
desc: "Sets the accountDomain."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accountId(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.accountId(String accountId)"
name: "accountId(String accountId)"
nameWithType: "RemoteRenderingClientBuilder.accountId(String accountId)"
summary: "Sets the account<wbr>Id."
parameters:
- description: "the accountId value."
name: "accountId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public RemoteRenderingClientBuilder accountId(String accountId)"
desc: "Sets the accountId."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
name: "addPolicy(HttpPipelinePolicy customPolicy)"
nameWithType: "RemoteRenderingClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
summary: "Adds a custom Http pipeline policy."
parameters:
- description: "The custom Http pipeline policy to add."
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 RemoteRenderingClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
desc: "Adds a custom Http pipeline policy."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.buildAsyncClient()"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.buildAsyncClient()"
name: "buildAsyncClient()"
nameWithType: "RemoteRenderingClientBuilder.buildAsyncClient()"
summary: "Builds and returns a Remote<wbr>Rendering<wbr>Async<wbr>Client instance from the provided parameters."
syntax: "public RemoteRenderingAsyncClient buildAsyncClient()"
desc: "Builds and returns a RemoteRenderingAsyncClient instance from the provided parameters."
returns:
description: "the RemoteRenderingAsyncClient instance."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient?alt=com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient&text=RemoteRenderingAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.buildClient()"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.buildClient()"
name: "buildClient()"
nameWithType: "RemoteRenderingClientBuilder.buildClient()"
summary: "Builds and returns a Remote<wbr>Rendering<wbr>Client instance from the provided parameters."
syntax: "public RemoteRenderingClient buildClient()"
desc: "Builds and returns a RemoteRenderingClient instance from the provided parameters."
returns:
description: "the RemoteRenderingClient instance."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClient?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClient&text=RemoteRenderingClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.clientOptions(ClientOptions clientOptions)"
name: "clientOptions(ClientOptions clientOptions)"
nameWithType: "RemoteRenderingClientBuilder.clientOptions(ClientOptions clientOptions)"
summary: "Sets the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> which enables various options to be set on the client."
parameters:
- description: "the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> to be set on the client."
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 RemoteRenderingClientBuilder clientOptions(ClientOptions clientOptions)"
desc: "Sets the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> which enables various options to be set on the client."
returns:
description: "The RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.configuration(com.azure.core.util.Configuration)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.configuration(Configuration configuration)"
name: "configuration(Configuration configuration)"
nameWithType: "RemoteRenderingClientBuilder.configuration(Configuration configuration)"
summary: "Sets The configuration store that is used during construction of the service client."
parameters:
- description: "the configuration value."
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 RemoteRenderingClientBuilder configuration(Configuration configuration)"
desc: "Sets The configuration store that is used during construction of the service client."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.credential(AzureKeyCredential accountKeyCredential)"
name: "credential(AzureKeyCredential accountKeyCredential)"
nameWithType: "RemoteRenderingClientBuilder.credential(AzureKeyCredential accountKeyCredential)"
summary: "Sets the account<wbr>Key<wbr>Credential to use for authentication."
parameters:
- description: "the accountKeyCredential value."
name: "accountKeyCredential"
type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
syntax: "public RemoteRenderingClientBuilder credential(AzureKeyCredential accountKeyCredential)"
desc: "Sets the accountKeyCredential to use for authentication."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.credential(com.azure.core.credential.TokenCredential)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.credential(TokenCredential tokenCredential)"
name: "credential(TokenCredential tokenCredential)"
nameWithType: "RemoteRenderingClientBuilder.credential(TokenCredential tokenCredential)"
summary: "Use a <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> for authentication."
parameters:
- description: "The <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authenticate HTTP requests."
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 RemoteRenderingClientBuilder credential(TokenCredential tokenCredential)"
desc: "Use a <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> for authentication."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.endpoint(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.endpoint(String endpoint)"
name: "endpoint(String endpoint)"
nameWithType: "RemoteRenderingClientBuilder.endpoint(String endpoint)"
summary: "Sets the Remote Rendering service endpoint."
parameters:
- description: "the host value."
name: "endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public RemoteRenderingClientBuilder endpoint(String endpoint)"
desc: "Sets the Remote Rendering service endpoint.\n\nFor converting assets, it is preferable to pick a region close to the storage containing the assets. For rendering, it is strongly recommended that you pick the closest region to the devices using the service. The time taken to communicate with the server impacts the quality of the experience."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.httpClient(com.azure.core.http.HttpClient)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.httpClient(HttpClient httpClient)"
name: "httpClient(HttpClient httpClient)"
nameWithType: "RemoteRenderingClientBuilder.httpClient(HttpClient httpClient)"
summary: "Sets The HTTP client used to send the request."
parameters:
- description: "the httpClient value."
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 RemoteRenderingClientBuilder httpClient(HttpClient httpClient)"
desc: "Sets The HTTP client used to send the request."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
nameWithType: "RemoteRenderingClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
summary: "Sets The logging configuration for HTTP requests and responses."
parameters:
- description: "the httpLogOptions value."
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 RemoteRenderingClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
desc: "Sets The logging configuration for HTTP requests and responses."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.pipeline(HttpPipeline pipeline)"
name: "pipeline(HttpPipeline pipeline)"
nameWithType: "RemoteRenderingClientBuilder.pipeline(HttpPipeline pipeline)"
summary: "Sets The HTTP pipeline to send requests through."
parameters:
- description: "the pipeline value."
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 RemoteRenderingClientBuilder pipeline(HttpPipeline pipeline)"
desc: "Sets The HTTP pipeline to send requests through."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
name: "retryPolicy(RetryPolicy retryPolicy)"
nameWithType: "RemoteRenderingClientBuilder.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 RemoteRenderingClientBuilder retryPolicy(RetryPolicy retryPolicy)"
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
returns:
description: "the RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.serviceVersion(com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder.serviceVersion(RemoteRenderingServiceVersion version)"
name: "serviceVersion(RemoteRenderingServiceVersion version)"
nameWithType: "RemoteRenderingClientBuilder.serviceVersion(RemoteRenderingServiceVersion version)"
summary: "Sets the <xref uid=\"com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RemoteRenderingServiceVersion\"></xref> that is used when making API requests."
parameters:
- description: "<xref uid=\"com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RemoteRenderingServiceVersion\"></xref> of the service to be used when making requests."
name: "version"
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion?alt=com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion&text=RemoteRenderingServiceVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public RemoteRenderingClientBuilder serviceVersion(RemoteRenderingServiceVersion version)"
desc: "Sets the <xref uid=\"com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RemoteRenderingServiceVersion\"></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 RemoteRenderingClientBuilder."
type: "<xref href=\"com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder?alt=com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder&text=RemoteRenderingClientBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A builder for creating instances of RemoteRenderingClient and RemoteRenderingAsyncClient."
metadata: {}
package: "com.azure.mixedreality.remoterendering"
artifact: com.azure:azure-mixedreality-remoterendering:1.1.34