All Implemented Interfaces:


public final class MessageRetrieveResponse.Builder

A builder for MessageRetrieveResponse.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final MessageRetrieveResponse.Builder`	`id(String id)`	A unique identifier associated with the message you wish to retrieve (results from a send).
`final MessageRetrieveResponse.Builder`	`id(JsonField<String> id)`	Sets Builder.id to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`enqueued(Long enqueued)`	A UTC timestamp at which Courier received the message request.
`final MessageRetrieveResponse.Builder`	`enqueued(JsonField<Long> enqueued)`	Sets Builder.enqueued to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`event(String event)`	A unique identifier associated with the event of the delivered message.
`final MessageRetrieveResponse.Builder`	`event(JsonField<String> event)`	Sets Builder.event to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`notification(String notification)`	A unique identifier associated with the notification of the delivered message.
`final MessageRetrieveResponse.Builder`	`notification(JsonField<String> notification)`	Sets Builder.notification to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`recipient(String recipient)`	A unique identifier associated with the recipient of the delivered message.
`final MessageRetrieveResponse.Builder`	`recipient(JsonField<String> recipient)`	Sets Builder.recipient to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`status(MessageDetails.Status status)`	The current status of the message.
`final MessageRetrieveResponse.Builder`	`status(JsonField<MessageDetails.Status> status)`	Sets Builder.status to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`clicked(Long clicked)`	A UTC timestamp at which the recipient clicked on a tracked link for the first time.
`final MessageRetrieveResponse.Builder`	`clicked(JsonField<Long> clicked)`	Sets Builder.clicked to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`delivered(Long delivered)`	A UTC timestamp at which the Integration provider delivered the message.
`final MessageRetrieveResponse.Builder`	`delivered(JsonField<Long> delivered)`	Sets Builder.delivered to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`error(String error)`	A message describing the error that occurred.
`final MessageRetrieveResponse.Builder`	`error(Optional<String> error)`	Alias for calling Builder.error with `error.orElse(null)`.
`final MessageRetrieveResponse.Builder`	`error(JsonField<String> error)`	Sets Builder.error to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`opened(Long opened)`	A UTC timestamp at which the recipient opened a message for the first time.
`final MessageRetrieveResponse.Builder`	`opened(JsonField<Long> opened)`	Sets Builder.opened to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`reason(MessageDetails.Reason reason)`	The reason for the current status of the message.
`final MessageRetrieveResponse.Builder`	`reason(Optional<MessageDetails.Reason> reason)`	Alias for calling Builder.reason with `reason.orElse(null)`.
`final MessageRetrieveResponse.Builder`	`reason(JsonField<MessageDetails.Reason> reason)`	Sets Builder.reason to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`sent(Long sent)`	A UTC timestamp at which Courier passed the message to the Integration provider.
`final MessageRetrieveResponse.Builder`	`sent(JsonField<Long> sent)`	Sets Builder.sent to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`providers(List<MessageRetrieveResponse.Provider> providers)`
`final MessageRetrieveResponse.Builder`	`providers(Optional<List<MessageRetrieveResponse.Provider>> providers)`	Alias for calling Builder.providers with `providers.orElse(null)`.
`final MessageRetrieveResponse.Builder`	`providers(JsonField<List<MessageRetrieveResponse.Provider>> providers)`	Sets Builder.providers to an arbitrary JSON value.
`final MessageRetrieveResponse.Builder`	`addProvider(MessageRetrieveResponse.Provider provider)`	Adds a single Provider to providers.
`final MessageRetrieveResponse.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final MessageRetrieveResponse.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final MessageRetrieveResponse.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final MessageRetrieveResponse.Builder`	`removeAdditionalProperty(String key)`
`final MessageRetrieveResponse.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final MessageRetrieveResponse`	`build()`	Returns an immutable instance of MessageRetrieveResponse.

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

- Constructor Detail
- Method Detail
  - id
```
 final MessageRetrieveResponse.Builder id(String id)
```
    A unique identifier associated with the message you wish to retrieve (results from a send).
  - id
```
 final MessageRetrieveResponse.Builder id(JsonField<String> id)
```
    Sets Builder.id to an arbitrary JSON value.
    You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - enqueued
```
 final MessageRetrieveResponse.Builder enqueued(Long enqueued)
```
    A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
  - enqueued
```
 final MessageRetrieveResponse.Builder enqueued(JsonField<Long> enqueued)
```
    Sets Builder.enqueued to an arbitrary JSON value.
    You should usually call Builder.enqueued with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - event
```
 final MessageRetrieveResponse.Builder event(String event)
```
    A unique identifier associated with the event of the delivered message.
  - event
```
 final MessageRetrieveResponse.Builder event(JsonField<String> event)
```
    Sets Builder.event to an arbitrary JSON value.
    You should usually call Builder.event with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - notification
```
 final MessageRetrieveResponse.Builder notification(String notification)
```
    A unique identifier associated with the notification of the delivered message.
  - notification
```
 final MessageRetrieveResponse.Builder notification(JsonField<String> notification)
```
    Sets Builder.notification to an arbitrary JSON value.
    You should usually call Builder.notification with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - recipient
```
 final MessageRetrieveResponse.Builder recipient(String recipient)
```
    A unique identifier associated with the recipient of the delivered message.
  - recipient
```
 final MessageRetrieveResponse.Builder recipient(JsonField<String> recipient)
```
    Sets Builder.recipient to an arbitrary JSON value.
    You should usually call Builder.recipient with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - status
```
 final MessageRetrieveResponse.Builder status(MessageDetails.Status status)
```
    The current status of the message.
  - status
```
 final MessageRetrieveResponse.Builder status(JsonField<MessageDetails.Status> status)
```
    Sets Builder.status to an arbitrary JSON value.
    You should usually call Builder.status with a well-typed MessageDetails.Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - clicked
```
 final MessageRetrieveResponse.Builder clicked(Long clicked)
```
    A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
  - clicked
```
 final MessageRetrieveResponse.Builder clicked(JsonField<Long> clicked)
```
    Sets Builder.clicked to an arbitrary JSON value.
    You should usually call Builder.clicked with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - delivered
```
 final MessageRetrieveResponse.Builder delivered(Long delivered)
```
    A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
  - delivered
```
 final MessageRetrieveResponse.Builder delivered(JsonField<Long> delivered)
```
    Sets Builder.delivered to an arbitrary JSON value.
    You should usually call Builder.delivered with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - error
```
 final MessageRetrieveResponse.Builder error(String error)
```
    A message describing the error that occurred.
  - error
```
 final MessageRetrieveResponse.Builder error(Optional<String> error)
```
    Alias for calling Builder.error with error.orElse(null).
  - error
```
 final MessageRetrieveResponse.Builder error(JsonField<String> error)
```
    Sets Builder.error to an arbitrary JSON value.
    You should usually call Builder.error with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - opened
```
 final MessageRetrieveResponse.Builder opened(Long opened)
```
    A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
  - opened
```
 final MessageRetrieveResponse.Builder opened(JsonField<Long> opened)
```
    Sets Builder.opened to an arbitrary JSON value.
    You should usually call Builder.opened with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - reason
```
 final MessageRetrieveResponse.Builder reason(MessageDetails.Reason reason)
```
    The reason for the current status of the message.
  - reason
```
 final MessageRetrieveResponse.Builder reason(Optional<MessageDetails.Reason> reason)
```
    Alias for calling Builder.reason with reason.orElse(null).
  - reason
```
 final MessageRetrieveResponse.Builder reason(JsonField<MessageDetails.Reason> reason)
```
    Sets Builder.reason to an arbitrary JSON value.
    You should usually call Builder.reason with a well-typed MessageDetails.Reason value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - sent
```
 final MessageRetrieveResponse.Builder sent(Long sent)
```
    A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
  - sent
```
 final MessageRetrieveResponse.Builder sent(JsonField<Long> sent)
```
    Sets Builder.sent to an arbitrary JSON value.
    You should usually call Builder.sent with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - providers
```
 final MessageRetrieveResponse.Builder providers(List<MessageRetrieveResponse.Provider> providers)
```
  - providers
```
 final MessageRetrieveResponse.Builder providers(Optional<List<MessageRetrieveResponse.Provider>> providers)
```
    Alias for calling Builder.providers with providers.orElse(null).
  - providers
```
 final MessageRetrieveResponse.Builder providers(JsonField<List<MessageRetrieveResponse.Provider>> providers)
```
    Sets Builder.providers to an arbitrary JSON value.
    You should usually call Builder.providers with a well-typed List<Provider> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addProvider
```
 final MessageRetrieveResponse.Builder addProvider(MessageRetrieveResponse.Provider provider)
```
    Adds a single Provider to providers.
  - additionalProperties
```
 final MessageRetrieveResponse.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final MessageRetrieveResponse.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final MessageRetrieveResponse.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final MessageRetrieveResponse.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final MessageRetrieveResponse.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final MessageRetrieveResponse build()
```
    Returns an immutable instance of MessageRetrieveResponse.
    Further updates to this Builder will not mutate the returned instance.
    The following fields are required:
    .id() .enqueued() .event() .notification() .recipient() .status()

Class MessageRetrieveResponse.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

id

enqueued

enqueued

event

event

notification

notification

recipient

recipient

status

status

clicked

clicked

delivered

delivered

error

error

error

opened

opened

reason

reason

reason

sent

sent

providers

providers

providers

addProvider

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build