247 строки
38 KiB
YAML
247 строки
38 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder"
|
|
name: "CommunicationRelayClientBuilder"
|
|
nameWithType: "CommunicationRelayClientBuilder"
|
|
summary: "Communication<wbr>Relay<wbr>Client<wbr>Builder that creates Communication<wbr>Relay<wbr>Async<wbr>Client and Communication<wbr>Relay<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 **CommunicationRelayClientBuilder**</br> 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.CommunicationRelayClientBuilder()"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.CommunicationRelayClientBuilder()"
|
|
name: "CommunicationRelayClientBuilder()"
|
|
nameWithType: "CommunicationRelayClientBuilder.CommunicationRelayClientBuilder()"
|
|
summary: "Default constructor for Communication<wbr>Relay<wbr>Client<wbr>Builder."
|
|
syntax: "public CommunicationRelayClientBuilder()"
|
|
desc: "Default constructor for CommunicationRelayClientBuilder."
|
|
methods:
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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: "CommunicationRelayClientBuilder"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "CommunicationRelayClientBuilder.buildAsyncClient()"
|
|
summary: "Create asynchronous client applying HMACAuthentication<wbr>Policy, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public CommunicationRelayAsyncClient buildAsyncClient()"
|
|
desc: "Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "CommunicationRelayAsyncClient instance"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayAsyncClient?alt=com.azure.communication.networktraversal.CommunicationRelayAsyncClient&text=CommunicationRelayAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.buildClient()"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "CommunicationRelayClientBuilder.buildClient()"
|
|
summary: "Create synchronous client applying Hmac<wbr>Authentication<wbr>Policy, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public CommunicationRelayClient buildClient()"
|
|
desc: "Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "CommunicationRelayClient instance"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClient?alt=com.azure.communication.networktraversal.CommunicationRelayClient&text=CommunicationRelayClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "CommunicationRelayClientBuilder.configuration(Configuration configuration)"
|
|
summary: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
parameters:
|
|
- description: "Configuration store used to retrieve environment configurations."
|
|
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 CommunicationRelayClientBuilder configuration(Configuration configuration)"
|
|
desc: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
returns:
|
|
description: "the updated CommunicationRelayClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.connectionString(java.lang.String)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.connectionString(String connectionString)"
|
|
name: "connectionString(String connectionString)"
|
|
nameWithType: "CommunicationRelayClientBuilder.connectionString(String connectionString)"
|
|
summary: "Set endpoint and credential to use"
|
|
parameters:
|
|
- description: "connection string for setting endpoint and initalizing CommunicationClientCredential"
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CommunicationRelayClientBuilder connectionString(String connectionString)"
|
|
desc: "Set endpoint and credential to use"
|
|
returns:
|
|
description: "CommunicationRelayClientBuilder"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.credential(AzureKeyCredential keyCredential)"
|
|
name: "credential(AzureKeyCredential keyCredential)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.credential(TokenCredential tokenCredential)"
|
|
name: "credential(TokenCredential tokenCredential)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "CommunicationRelayClientBuilder.endpoint(String endpoint)"
|
|
summary: "Set endpoint of the service"
|
|
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 CommunicationRelayClientBuilder endpoint(String endpoint)"
|
|
desc: "Set endpoint of the service"
|
|
returns:
|
|
description: "CommunicationRelayClientBuilder"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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: "CommunicationRelayClientBuilder"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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 CommunicationRelayClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.pipeline(HttpPipeline pipeline)"
|
|
name: "pipeline(HttpPipeline pipeline)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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 a pipeline is not supplied, the credential and httpClient fields must be set"
|
|
returns:
|
|
description: "CommunicationRelayClientBuilder"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 CommunicationRelayClientBuilder 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.communication.networktraversal.CommunicationRelayClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "CommunicationRelayClientBuilder.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 when each request is sent."
|
|
parameters:
|
|
- description: "User's 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 CommunicationRelayClientBuilder 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 when each request is sent.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayClientBuilder\"></xref> object."
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.serviceVersion(com.azure.communication.networktraversal.CommunicationRelayServiceVersion)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClientBuilder.serviceVersion(CommunicationRelayServiceVersion version)"
|
|
name: "serviceVersion(CommunicationRelayServiceVersion version)"
|
|
nameWithType: "CommunicationRelayClientBuilder.serviceVersion(CommunicationRelayServiceVersion version)"
|
|
summary: "Sets the <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.communication.networktraversal.CommunicationRelayServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayServiceVersion\"></xref> of the service to be used when making requests."
|
|
name: "version"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayServiceVersion?alt=com.azure.communication.networktraversal.CommunicationRelayServiceVersion&text=CommunicationRelayServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CommunicationRelayClientBuilder serviceVersion(CommunicationRelayServiceVersion version)"
|
|
desc: "Sets the <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommunicationRelayServiceVersion\"></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 CommunicationRelayClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "CommunicationRelayClientBuilder that creates CommunicationRelayAsyncClient and CommunicationRelayClient.\n\n**Instantiating a CommunicationRelayClientBuilder**\n\n```java\n// You can find your endpoint and access key from your resource in the Azure Portal\n String endpoint = \"https://<RESOURCE_NAME>.communication.azure.com\";\n AzureKeyCredential keyCredential = new AzureKeyCredential(\"<access-key>\");\n\n CommunicationRelayClientBuilder communicationRelayClientBuilder = new CommunicationRelayClientBuilder()\n .endpoint(endpoint)\n .credential(keyCredential);\n```"
|
|
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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" 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.communication.networktraversal.CommunicationRelayClientBuilder?alt=com.azure.communication.networktraversal.CommunicationRelayClientBuilder&text=CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.communication.networktraversal"
|
|
artifact: com.azure:azure-communication-networktraversal:1.1.0
|