### YamlMime:JavaType uid: "com.azure.communication.sms.SmsClientBuilder" fullName: "com.azure.communication.sms.SmsClientBuilder" name: "SmsClientBuilder" nameWithType: "SmsClientBuilder" summary: "SmsClientBuilder that creates SmsAsyncClient and SmsClient." inheritances: - "" inheritedClassMethods: - classRef: "java.lang.Object" methodsRef: - "clone" - "equals" - "finalize" - "getClass" - "hashCode" - "notify" - "notifyAll" - "toString" - "wait" - "wait" - "wait" syntax: "public final class **SmsClientBuilder**
implements <>, <>, <>, <>, <>, <>" constructors: - uid: "com.azure.communication.sms.SmsClientBuilder.SmsClientBuilder()" fullName: "com.azure.communication.sms.SmsClientBuilder.SmsClientBuilder()" name: "SmsClientBuilder()" nameWithType: "SmsClientBuilder.SmsClientBuilder()" syntax: "public SmsClientBuilder()" methods: - uid: "com.azure.communication.sms.SmsClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)" fullName: "com.azure.communication.sms.SmsClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" name: "addPolicy(HttpPipelinePolicy customPolicy)" nameWithType: "SmsClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" summary: "Adds a to apply on each request sent." parameters: - description: "A ." name: "customPolicy" type: "" syntax: "public SmsClientBuilder addPolicy(HttpPipelinePolicy customPolicy)" desc: "Adds a 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 is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.buildAsyncClient()" fullName: "com.azure.communication.sms.SmsClientBuilder.buildAsyncClient()" name: "buildAsyncClient()" nameWithType: "SmsClientBuilder.buildAsyncClient()" summary: "Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy." syntax: "public SmsAsyncClient buildAsyncClient()" desc: "Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them" returns: description: "SmsAsyncClient instance" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.buildClient()" fullName: "com.azure.communication.sms.SmsClientBuilder.buildClient()" name: "buildClient()" nameWithType: "SmsClientBuilder.buildClient()" summary: "Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy." syntax: "public SmsClient buildClient()" desc: "Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them" returns: description: "SmsClient instance" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.clientOptions(com.azure.core.util.ClientOptions)" fullName: "com.azure.communication.sms.SmsClientBuilder.clientOptions(ClientOptions clientOptions)" name: "clientOptions(ClientOptions clientOptions)" nameWithType: "SmsClientBuilder.clientOptions(ClientOptions clientOptions)" summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc." parameters: - description: "A configured instance of ." name: "clientOptions" type: "" syntax: "public SmsClientBuilder 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 class (a subclass of the 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 is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.configuration(com.azure.core.util.Configuration)" fullName: "com.azure.communication.sms.SmsClientBuilder.configuration(Configuration configuration)" name: "configuration(Configuration configuration)" nameWithType: "SmsClientBuilder.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: "" syntax: "public SmsClientBuilder configuration(Configuration configuration)" desc: "Sets the configuration object used to retrieve environment configuration values during building of the client." returns: description: "the updated SmsClientBuilder object" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.connectionString(java.lang.String)" fullName: "com.azure.communication.sms.SmsClientBuilder.connectionString(String connectionString)" name: "connectionString(String connectionString)" nameWithType: "SmsClientBuilder.connectionString(String connectionString)" summary: "Set endpoint and credential to use" parameters: - description: "connection string for setting endpoint and initalizing AzureKeyCredential" name: "connectionString" type: "String" syntax: "public SmsClientBuilder connectionString(String connectionString)" desc: "Set endpoint and credential to use" returns: description: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)" fullName: "com.azure.communication.sms.SmsClientBuilder.credential(AzureKeyCredential keyCredential)" name: "credential(AzureKeyCredential keyCredential)" nameWithType: "SmsClientBuilder.credential(AzureKeyCredential keyCredential)" summary: "Sets the used to authenticate HTTP requests." parameters: - description: "The used to authenticate HTTP requests." name: "keyCredential" type: "" syntax: "public SmsClientBuilder credential(AzureKeyCredential keyCredential)" desc: "Sets the used to authenticate HTTP requests." returns: description: "The updated object." type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.credential(com.azure.core.credential.TokenCredential)" fullName: "com.azure.communication.sms.SmsClientBuilder.credential(TokenCredential tokenCredential)" name: "credential(TokenCredential tokenCredential)" nameWithType: "SmsClientBuilder.credential(TokenCredential tokenCredential)" summary: "Sets the used to authorize requests sent to the service." parameters: - description: " used to authorize requests sent to the service." name: "tokenCredential" type: "" syntax: "public SmsClientBuilder credential(TokenCredential tokenCredential)" desc: "Sets the 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 type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity" returns: description: "The updated object." type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.endpoint(java.lang.String)" fullName: "com.azure.communication.sms.SmsClientBuilder.endpoint(String endpoint)" name: "endpoint(String endpoint)" nameWithType: "SmsClientBuilder.endpoint(String endpoint)" summary: "Set endpoint of the service" parameters: - description: "url of the service" name: "endpoint" type: "String" syntax: "public SmsClientBuilder endpoint(String endpoint)" desc: "Set endpoint of the service" returns: description: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.httpClient(com.azure.core.http.HttpClient)" fullName: "com.azure.communication.sms.SmsClientBuilder.httpClient(HttpClient httpClient)" name: "httpClient(HttpClient httpClient)" nameWithType: "SmsClientBuilder.httpClient(HttpClient httpClient)" summary: "Sets the to use for sending and receiving requests to and from the service." parameters: - description: "The to use for requests." name: "httpClient" type: "" syntax: "public SmsClientBuilder httpClient(HttpClient httpClient)" desc: "Sets the 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 is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)" fullName: "com.azure.communication.sms.SmsClientBuilder.httpLogOptions(HttpLogOptions logOptions)" name: "httpLogOptions(HttpLogOptions logOptions)" nameWithType: "SmsClientBuilder.httpLogOptions(HttpLogOptions logOptions)" summary: "Sets the to use when sending and receiving requests to and from the service." parameters: - description: "The to use when sending and receiving requests to\n and from the service." name: "logOptions" type: "" syntax: "public SmsClientBuilder httpLogOptions(HttpLogOptions logOptions)" desc: "Sets the to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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 SmsClientBuilder object" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.pipeline(com.azure.core.http.HttpPipeline)" fullName: "com.azure.communication.sms.SmsClientBuilder.pipeline(HttpPipeline pipeline)" name: "pipeline(HttpPipeline pipeline)" nameWithType: "SmsClientBuilder.pipeline(HttpPipeline pipeline)" summary: "Sets the to use for the service client." parameters: - description: " to use for sending service requests and receiving responses." name: "pipeline" type: "" syntax: "public SmsClientBuilder pipeline(HttpPipeline pipeline)" desc: "Sets the 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 is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)" fullName: "com.azure.communication.sms.SmsClientBuilder.retryOptions(RetryOptions retryOptions)" name: "retryOptions(RetryOptions retryOptions)" nameWithType: "SmsClientBuilder.retryOptions(RetryOptions retryOptions)" summary: "Sets the for all the requests made through the client." parameters: - description: "The to use for all the requests made through the client." name: "retryOptions" type: "" syntax: "public SmsClientBuilder retryOptions(RetryOptions retryOptions)" desc: "Sets the 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 is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no 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 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 ." returns: description: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)" fullName: "com.azure.communication.sms.SmsClientBuilder.retryPolicy(RetryPolicy retryPolicy)" name: "retryPolicy(RetryPolicy retryPolicy)" nameWithType: "SmsClientBuilder.retryPolicy(RetryPolicy retryPolicy)" summary: "Sets the retry policy to use (using the RetryPolicy type)." parameters: - description: "object to be applied" name: "retryPolicy" type: "" syntax: "public SmsClientBuilder retryPolicy(RetryPolicy retryPolicy)" desc: "Sets the retry policy to use (using the RetryPolicy type).\n\nSetting this is mutually exclusive with using ." returns: description: "SmsClientBuilder" type: "" - uid: "com.azure.communication.sms.SmsClientBuilder.serviceVersion(com.azure.communication.sms.SmsServiceVersion)" fullName: "com.azure.communication.sms.SmsClientBuilder.serviceVersion(SmsServiceVersion version)" name: "serviceVersion(SmsServiceVersion version)" nameWithType: "SmsClientBuilder.serviceVersion(SmsServiceVersion version)" summary: "Sets the that is used when making API requests." parameters: - description: " of the service to be used when making requests." name: "version" type: "" syntax: "public SmsClientBuilder serviceVersion(SmsServiceVersion version)" desc: "Sets the 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 SmsClientBuilder object" type: "" type: "class" desc: "SmsClientBuilder that creates SmsAsyncClient and SmsClient." implements: - "<>" - "<>" - "<>" - "<>" - "<>" - "<>" metadata: {} package: "com.azure.communication.sms" artifact: com.azure:azure-communication-sms:1.1.27