com.clxcommunications.xms.api

Class MtBatchTextSmsResult.Builder

java.lang.Object

com.clxcommunications.xms.api.MtBatchTextSmsResult.Builder

Enclosing class:

MtBatchTextSmsResult

public static class MtBatchTextSmsResult.Builder
extends Object

Builder of textual batch results.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

using

public final MtBatchTextSmsResult.Builder using(MtBatchSmsResult instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

using

public final MtBatchTextSmsResult.Builder using(MtBatchTextSmsResult instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

body

public final MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.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

id

public final MtBatchTextSmsResult.Builder id(BatchId id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

addRecipient

public final MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.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 MtBatchTextSmsResult.Builder sender(@Nullable
                                                 String sender)

Initializes the value for the sender attribute.

Parameters:

sender - The value for sender (can be null)

Returns:

this builder for use in a chained invocation

deliveryReport

public final MtBatchTextSmsResult.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

callbackUrl

public final MtBatchTextSmsResult.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

sendAt

public final MtBatchTextSmsResult.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 MtBatchTextSmsResult.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

createdAt

public final MtBatchTextSmsResult.Builder createdAt(@Nullable
                                                    OffsetDateTime createdAt)

Initializes the value for the createdAt attribute.

Parameters:

createdAt - The value for createdAt (can be null)

Returns:

this builder for use in a chained invocation

modifiedAt

public final MtBatchTextSmsResult.Builder modifiedAt(@Nullable
                                                     OffsetDateTime modifiedAt)

Initializes the value for the modifiedAt attribute.

Parameters:

modifiedAt - The value for modifiedAt (can be null)

Returns:

this builder for use in a chained invocation

canceled

public final MtBatchTextSmsResult.Builder canceled(boolean canceled)

Initializes the value for the canceled attribute.

Parameters:

canceled - The value for canceled

Returns:

this builder for use in a chained invocation

build

public MtBatchTextSmsResult build()

Builds a new MtBatchTextSmsResult.

Returns:

An immutable instance of MtBatchTextSmsResult

Throws:

IllegalStateException - if any required attributes are missing