com.clxcommunications.xms.api

Class MtBatchTextSmsCreate.Builder

java.lang.Object

com.clxcommunications.xms.api.MtBatchTextSmsCreate.Builder

Enclosing class:

MtBatchTextSmsCreate

public static class MtBatchTextSmsCreate.Builder
extends Object

A builder of textual batch messages.

Method Summary

Modifier and Type	Method and Description
MtBatchTextSmsCreate.Builder	addAllRecipients(Iterable<String> elements) Adds elements to recipients list.
MtBatchTextSmsCreate.Builder	addAllTags(Iterable<String> elements) Adds elements to tags set.
MtBatchTextSmsCreate.Builder	addRecipient(String... elements) Adds elements to recipients list.
MtBatchTextSmsCreate.Builder	addRecipient(String element) Adds one element to recipients list.
MtBatchTextSmsCreate.Builder	addTag(String... elements) Adds elements to tags set.
MtBatchTextSmsCreate.Builder	addTag(String element) Adds one element to tags set.
MtBatchTextSmsCreate.Builder	body(String body) Initializes the value for the body attribute.
MtBatchTextSmsCreate	build() Builds a new MtBatchTextSmsCreate.
MtBatchTextSmsCreate.Builder	callbackUrl(URI callbackUrl) Initializes the value for the callbackUrl attribute.
MtBatchTextSmsCreate.Builder	deliveryReport(ReportType deliveryReport) Initializes the value for the deliveryReport attribute.
MtBatchTextSmsCreate.Builder	expireAt(OffsetDateTime expireAt) Initializes the value for the expireAt attribute.
MtBatchTextSmsCreate.Builder	parameters(Map<String,? extends ParameterValues> parameters) Sets or replaces all mappings from the specified map as entries for the parameters map.
MtBatchTextSmsCreate.Builder	putAllParameters(Map<String,? extends ParameterValues> parameters) Put all mappings from the specified map as entries to parameters map.
MtBatchTextSmsCreate.Builder	putParameter(Map.Entry<String,? extends ParameterValues> entry) Put one entry to the parameters map.
MtBatchTextSmsCreate.Builder	putParameter(String key, ParameterValues value) Put one entry to the parameters map.
MtBatchTextSmsCreate.Builder	recipients(Iterable<String> elements) Sets or replaces all elements for recipients list.
MtBatchTextSmsCreate.Builder	sendAt(OffsetDateTime sendAt) Initializes the value for the sendAt attribute.
MtBatchTextSmsCreate.Builder	sender(String sender) Initializes the value for the sender attribute.
MtBatchTextSmsCreate.Builder	tags(Iterable<String> elements) Sets or replaces all elements for tags set.
MtBatchTextSmsCreate.Builder	using(MtBatchSmsCreate instance) Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchSmsCreate instance.
MtBatchTextSmsCreate.Builder	using(MtBatchTextSmsCreate instance) Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchTextSmsCreate instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

using

public final MtBatchTextSmsCreate.Builder using(MtBatchSmsCreate instance)

Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchSmsCreate instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

using

public final MtBatchTextSmsCreate.Builder using(MtBatchTextSmsCreate instance)

Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchTextSmsCreate instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

body

public final MtBatchTextSmsCreate.Builder body(String body)

Initializes the value for the body attribute.

Parameters:

body - The value for body

Returns:

this builder for use in a chained invocation

putParameter

public final MtBatchTextSmsCreate.Builder putParameter(String key,
                                                       ParameterValues value)

Put one entry to the parameters map.

Parameters:

key - The key in the parameters map

value - The associated value in the parameters map

Returns:

this builder for use in a chained invocation

putParameter

public final MtBatchTextSmsCreate.Builder putParameter(Map.Entry<String,? extends ParameterValues> entry)

Put one entry to the parameters map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

parameters

public final MtBatchTextSmsCreate.Builder parameters(Map<String,? extends ParameterValues> parameters)

Sets or replaces all mappings from the specified map as entries for the parameters map. Nulls are not permitted

Parameters:

parameters - The entries that will be added to the parameters map

Returns:

this builder for use in a chained invocation

putAllParameters

public final MtBatchTextSmsCreate.Builder putAllParameters(Map<String,? extends ParameterValues> parameters)

Put all mappings from the specified map as entries to parameters map. Nulls are not permitted

Parameters:

parameters - The entries that will be added to the parameters map

Returns:

this builder for use in a chained invocation

addRecipient

public final MtBatchTextSmsCreate.Builder addRecipient(String element)

Adds one element to recipients list.

Parameters:

element - A recipients element

Returns:

this builder for use in a chained invocation

addRecipient

public final MtBatchTextSmsCreate.Builder addRecipient(String... elements)

Adds elements to recipients list.

Parameters:

elements - An array of recipients elements

Returns:

this builder for use in a chained invocation

recipients

public final MtBatchTextSmsCreate.Builder recipients(Iterable<String> elements)

Sets or replaces all elements for recipients list.

Parameters:

elements - An iterable of recipients elements

Returns:

this builder for use in a chained invocation

addAllRecipients

public final MtBatchTextSmsCreate.Builder addAllRecipients(Iterable<String> elements)

Adds elements to recipients list.

Parameters:

elements - An iterable of recipients elements

Returns:

this builder for use in a chained invocation

sender

public final MtBatchTextSmsCreate.Builder sender(String sender)

Initializes the value for the sender attribute.

Parameters:

sender - The value for sender

Returns:

this builder for use in a chained invocation

deliveryReport

public final MtBatchTextSmsCreate.Builder deliveryReport(@Nullable
                                                         ReportType deliveryReport)

Initializes the value for the deliveryReport attribute.

Parameters:

deliveryReport - The value for deliveryReport (can be null)

Returns:

this builder for use in a chained invocation

sendAt

public final MtBatchTextSmsCreate.Builder sendAt(@Nullable
                                                 OffsetDateTime sendAt)

Initializes the value for the sendAt attribute.

Parameters:

sendAt - The value for sendAt (can be null)

Returns:

this builder for use in a chained invocation

expireAt

public final MtBatchTextSmsCreate.Builder expireAt(@Nullable
                                                   OffsetDateTime expireAt)

Initializes the value for the expireAt attribute.

Parameters:

expireAt - The value for expireAt (can be null)

Returns:

this builder for use in a chained invocation

callbackUrl

public final MtBatchTextSmsCreate.Builder callbackUrl(@Nullable
                                                      URI callbackUrl)

Initializes the value for the callbackUrl attribute.

Parameters:

callbackUrl - The value for callbackUrl (can be null)

Returns:

this builder for use in a chained invocation

addTag

public final MtBatchTextSmsCreate.Builder addTag(String element)

Adds one element to tags set.

Parameters:

element - A tags element

Returns:

this builder for use in a chained invocation

addTag

public final MtBatchTextSmsCreate.Builder addTag(String... elements)

Adds elements to tags set.

Parameters:

elements - An array of tags elements

Returns:

this builder for use in a chained invocation

tags

public final MtBatchTextSmsCreate.Builder tags(Iterable<String> elements)

Sets or replaces all elements for tags set.

Parameters:

elements - An iterable of tags elements

Returns:

this builder for use in a chained invocation

addAllTags

public final MtBatchTextSmsCreate.Builder addAllTags(Iterable<String> elements)

Adds elements to tags set.

Parameters:

elements - An iterable of tags elements

Returns:

this builder for use in a chained invocation

build

public MtBatchTextSmsCreate build()

Builds a new MtBatchTextSmsCreate.

Returns:

An immutable instance of MtBatchTextSmsCreate

Throws:

IllegalStateException - if any required attributes are missing