MtBatchTextSmsUpdate.Builder (SDK for CLX XMS 1.0.2 API)

java.lang.Object
- com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder

Enclosing class:

MtBatchTextSmsUpdate
```
public static class MtBatchTextSmsUpdate.Builder
extends Object
```
A builder of text batch message updates.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MtBatchTextSmsUpdate.Builder`	`addAllRecipientInsertions(Iterable<String> elements)` Adds elements to `recipientInsertions` list.
`MtBatchTextSmsUpdate.Builder`	`addAllRecipientRemovals(Iterable<String> elements)` Adds elements to `recipientRemovals` list.
`MtBatchTextSmsUpdate.Builder`	`addRecipientInsertion(String... elements)` Adds elements to `recipientInsertions` list.
`MtBatchTextSmsUpdate.Builder`	`addRecipientInsertion(String element)` Adds one element to `recipientInsertions` list.
`MtBatchTextSmsUpdate.Builder`	`addRecipientRemoval(String... elements)` Adds elements to `recipientRemovals` list.
`MtBatchTextSmsUpdate.Builder`	`addRecipientRemoval(String element)` Adds one element to `recipientRemovals` list.
`MtBatchTextSmsUpdate.Builder`	`body(String body)` Initializes the value for the `body` attribute.
`MtBatchTextSmsUpdate`	`build()` Builds a new `MtBatchTextSmsUpdate`.
`MtBatchTextSmsUpdate.Builder`	`callbackUrl(UpdateValue<URI> callbackUrl)` Initializes the value for the `callbackUrl` attribute.
`MtBatchTextSmsUpdate.Builder`	`callbackUrl(URI url)` Updates the callback URL.
`MtBatchTextSmsUpdate.Builder`	`deliveryReport(ReportType deliveryReport)` Updates the delivery report type of this batch.
`MtBatchTextSmsUpdate.Builder`	`deliveryReport(UpdateValue<ReportType> deliveryReport)` Initializes the value for the `deliveryReport` attribute.
`MtBatchTextSmsUpdate.Builder`	`expireAt(OffsetDateTime time)` Updates the batch expire time.
`MtBatchTextSmsUpdate.Builder`	`expireAt(UpdateValue<OffsetDateTime> expireAt)` Initializes the value for the `expireAt` attribute.
`MtBatchTextSmsUpdate.Builder`	`parameters(Map<String,ParameterValues> params)` Replaces the batch parameters to the ones in the given map.
`MtBatchTextSmsUpdate.Builder`	`parameters(UpdateValue<Map<String,ParameterValues>> parameters)` Initializes the value for the `parameters` attribute.
`MtBatchTextSmsUpdate.Builder`	`recipientInsertions(Iterable<String> elements)` Sets or replaces all elements for `recipientInsertions` list.
`MtBatchTextSmsUpdate.Builder`	`recipientRemovals(Iterable<String> elements)` Sets or replaces all elements for `recipientRemovals` list.
`MtBatchTextSmsUpdate.Builder`	`sendAt(OffsetDateTime time)` Updates the scheduled send time.
`MtBatchTextSmsUpdate.Builder`	`sendAt(UpdateValue<OffsetDateTime> sendAt)` Initializes the value for the `sendAt` attribute.
`MtBatchTextSmsUpdate.Builder`	`sender(String sender)` Initializes the value for the `sender` attribute.
`MtBatchTextSmsUpdate.Builder`	`unsetCallbackUrl()` Resets the callback URL to the default callback URL.
`MtBatchTextSmsUpdate.Builder`	`unsetDeliveryReport()` Resets the delivery report type to the messaging system default value.
`MtBatchTextSmsUpdate.Builder`	`unsetExpireAt()` Resets the batch expire time to the messaging system default value.
`MtBatchTextSmsUpdate.Builder`	`unsetParameters()` Unsets the batch parameters.
`MtBatchTextSmsUpdate.Builder`	`unsetSendAt()` Unsets the scheduled send time.
`MtBatchTextSmsUpdate.Builder`	`using(MtBatchSmsUpdate instance)` Fill a builder with attribute values from the provided `com.clxcommunications.xms.api.MtBatchSmsUpdate` instance.
`MtBatchTextSmsUpdate.Builder`	`using(MtBatchTextSmsUpdate instance)` Fill a builder with attribute values from the provided `com.clxcommunications.xms.api.MtBatchTextSmsUpdate` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - unsetDeliveryReport
```
public MtBatchTextSmsUpdate.Builder unsetDeliveryReport()
```
    Resets the delivery report type to the messaging system default value.
    
    Returns:
    
    this builder for use in a chained invocation
  - deliveryReport
```
public MtBatchTextSmsUpdate.Builder deliveryReport(ReportType deliveryReport)
```
    Updates the delivery report type of this batch. If given a null reference then this is equivalent to calling unsetDeliveryReport().
    
    Parameters:
    
    deliveryReport - the new delivery report type or null to unset
    
    Returns:
    
    this builder for use in a chained invocation
  - unsetSendAt
```
public MtBatchTextSmsUpdate.Builder unsetSendAt()
```
    Unsets the scheduled send time. This has the effect of immediately starting to send the batch.
    
    Returns:
    
    this builder for use in a chained invocation
  - sendAt
```
public MtBatchTextSmsUpdate.Builder sendAt(OffsetDateTime time)
```
    Updates the scheduled send time. If given a null reference then this is equivalent to calling unsetSendAt().
    
    Parameters:
    
    time - the new scheduled send time
    
    Returns:
    
    this builder for use in a chained invocation
  - unsetExpireAt
```
public MtBatchTextSmsUpdate.Builder unsetExpireAt()
```
    Resets the batch expire time to the messaging system default value.
    
    Returns:
    
    this builder for use in a chained invocation
  - expireAt
```
public MtBatchTextSmsUpdate.Builder expireAt(OffsetDateTime time)
```
    Updates the batch expire time. If given a null reference then this is equivalent to calling unsetExpireAt().
    
    Parameters:
    
    time - the new expire time
    
    Returns:
    
    this builder for use in a chained invocation
  - unsetCallbackUrl
```
public MtBatchTextSmsUpdate.Builder unsetCallbackUrl()
```
    Resets the callback URL to the default callback URL.
    
    Returns:
    
    this builder for use in a chained invocation
  - callbackUrl
```
public MtBatchTextSmsUpdate.Builder callbackUrl(URI url)
```
    Updates the callback URL. If given a null reference then this is equivalent to calling unsetCallbackUrl().
    
    Parameters:
    
    url - the new callback URL
    
    Returns:
    
    this builder for use in a chained invocation
  - unsetParameters
```
public MtBatchTextSmsUpdate.Builder unsetParameters()
```
    Unsets the batch parameters.
    
    Returns:
    
    this builder for use in a chained invocation
  - parameters
```
public MtBatchTextSmsUpdate.Builder parameters(Map<String,ParameterValues> params)
```
    Replaces the batch parameters to the ones in the given map. If given a null reference then this is equivalent to calling unsetParameters().
    
    Parameters:
    
    params - the new parameter mapping
    
    Returns:
    
    this builder for use in a chained invocation
  - using
```
public final MtBatchTextSmsUpdate.Builder using(MtBatchSmsUpdate instance)
```
    Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchSmsUpdate instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - using
```
public final MtBatchTextSmsUpdate.Builder using(MtBatchTextSmsUpdate instance)
```
    Fill a builder with attribute values from the provided com.clxcommunications.xms.api.MtBatchTextSmsUpdate instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - body
```
public final MtBatchTextSmsUpdate.Builder body(@Nullable
                                               String body)
```
    Initializes the value for the body attribute.
    
    Parameters:
    
    body - The value for body (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - parameters
```
public final MtBatchTextSmsUpdate.Builder parameters(@Nullable
                                                     UpdateValue<Map<String,ParameterValues>> parameters)
```
    Initializes the value for the parameters attribute.
    
    Parameters:
    
    parameters - The value for parameters (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - addRecipientInsertion
```
public final MtBatchTextSmsUpdate.Builder addRecipientInsertion(String element)
```
    Adds one element to recipientInsertions list.
    
    Parameters:
    
    element - A recipientInsertions element
    
    Returns:
    
    this builder for use in a chained invocation
  - addRecipientInsertion
```
public final MtBatchTextSmsUpdate.Builder addRecipientInsertion(String... elements)
```
    Adds elements to recipientInsertions list.
    
    Parameters:
    
    elements - An array of recipientInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - recipientInsertions
```
public final MtBatchTextSmsUpdate.Builder recipientInsertions(@Nullable
                                                              Iterable<String> elements)
```
    Sets or replaces all elements for recipientInsertions list.
    
    Parameters:
    
    elements - An iterable of recipientInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllRecipientInsertions
```
public final MtBatchTextSmsUpdate.Builder addAllRecipientInsertions(Iterable<String> elements)
```
    Adds elements to recipientInsertions list.
    
    Parameters:
    
    elements - An iterable of recipientInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addRecipientRemoval
```
public final MtBatchTextSmsUpdate.Builder addRecipientRemoval(String element)
```
    Adds one element to recipientRemovals list.
    
    Parameters:
    
    element - A recipientRemovals element
    
    Returns:
    
    this builder for use in a chained invocation
  - addRecipientRemoval
```
public final MtBatchTextSmsUpdate.Builder addRecipientRemoval(String... elements)
```
    Adds elements to recipientRemovals list.
    
    Parameters:
    
    elements - An array of recipientRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - recipientRemovals
```
public final MtBatchTextSmsUpdate.Builder recipientRemovals(@Nullable
                                                            Iterable<String> elements)
```
    Sets or replaces all elements for recipientRemovals list.
    
    Parameters:
    
    elements - An iterable of recipientRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllRecipientRemovals
```
public final MtBatchTextSmsUpdate.Builder addAllRecipientRemovals(Iterable<String> elements)
```
    Adds elements to recipientRemovals list.
    
    Parameters:
    
    elements - An iterable of recipientRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - sender
```
public final MtBatchTextSmsUpdate.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 MtBatchTextSmsUpdate.Builder deliveryReport(@Nullable
                                                         UpdateValue<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 MtBatchTextSmsUpdate.Builder sendAt(@Nullable
                                                 UpdateValue<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 MtBatchTextSmsUpdate.Builder expireAt(@Nullable
                                                   UpdateValue<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 MtBatchTextSmsUpdate.Builder callbackUrl(@Nullable
                                                      UpdateValue<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
  - build
```
public MtBatchTextSmsUpdate build()
```
    Builds a new MtBatchTextSmsUpdate.
    
    Returns:
    
    An immutable instance of MtBatchTextSmsUpdate
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class MtBatchTextSmsUpdate.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unsetDeliveryReport

deliveryReport

unsetSendAt

sendAt

unsetExpireAt

expireAt

unsetCallbackUrl

callbackUrl

unsetParameters

parameters

using

using

body

parameters

addRecipientInsertion

addRecipientInsertion

recipientInsertions

addAllRecipientInsertions

addRecipientRemoval

addRecipientRemoval

recipientRemovals

addAllRecipientRemovals

sender

deliveryReport

sendAt

expireAt

callbackUrl

build