VoiceMessage (AWS Java SDK for Amazon Pinpoint 1.11.594 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.VoiceMessage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VoiceMessage
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VoiceMessage()

Constructors
Constructor and Description
`VoiceMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoiceMessage`	`addSubstitutionsEntry(String key, List<String> value)`
`VoiceMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`VoiceMessage`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBody()` The text script for the voice message.
`String`	`getLanguageCode()` The language to use when delivering the message.
`String`	`getOriginationNumber()` The phone number from the pool or messaging service to send the message from.
`Map<String,List<String>>`	`getSubstitutions()` The default message variables to use in the voice message.
`String`	`getVoiceId()` The name of the voice to use when delivering the message.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBody(String body)` The text script for the voice message.
`void`	`setLanguageCode(String languageCode)` The language to use when delivering the message.
`void`	`setOriginationNumber(String originationNumber)` The phone number from the pool or messaging service to send the message from.
`void`	`setSubstitutions(Map<String,List<String>> substitutions)` The default message variables to use in the voice message.
`void`	`setVoiceId(String voiceId)` The name of the voice to use when delivering the message.
`String`	`toString()` Returns a string representation of this object.
`VoiceMessage`	`withBody(String body)` The text script for the voice message.
`VoiceMessage`	`withLanguageCode(String languageCode)` The language to use when delivering the message.
`VoiceMessage`	`withOriginationNumber(String originationNumber)` The phone number from the pool or messaging service to send the message from.
`VoiceMessage`	`withSubstitutions(Map<String,List<String>> substitutions)` The default message variables to use in the voice message.
`VoiceMessage`	`withVoiceId(String voiceId)` The name of the voice to use when delivering the message.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VoiceMessage
```
public VoiceMessage()
```
- Method Detail
  - setBody
```
public void setBody(String body)
```
    The text script for the voice message.
    
    Parameters:
    
    body - The text script for the voice message.
  - getBody
```
public String getBody()
```
    The text script for the voice message.
    
    Returns:
    
    The text script for the voice message.
  - withBody
```
public VoiceMessage withBody(String body)
```
    The text script for the voice message.
    
    Parameters:
    
    body - The text script for the voice message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
    
    Parameters:
    
    languageCode - The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
  - getLanguageCode
```
public String getLanguageCode()
```
    The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
    
    Returns:
    
    The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
  - withLanguageCode
```
public VoiceMessage withLanguageCode(String languageCode)
```
    The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
    
    Parameters:
    
    languageCode - The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOriginationNumber
```
public void setOriginationNumber(String originationNumber)
```
    The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
    
    Parameters:
    
    originationNumber - The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
  - getOriginationNumber
```
public String getOriginationNumber()
```
    The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
    
    Returns:
    
    The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
  - withOriginationNumber
```
public VoiceMessage withOriginationNumber(String originationNumber)
```
    The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
    
    Parameters:
    
    originationNumber - The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubstitutions
```
public Map<String,List<String>> getSubstitutions()
```
    The default message variables to use in the voice message. You can override the default variables with individual address variables.
    
    Returns:
    
    The default message variables to use in the voice message. You can override the default variables with individual address variables.
  - setSubstitutions
```
public void setSubstitutions(Map<String,List<String>> substitutions)
```
    The default message variables to use in the voice message. You can override the default variables with individual address variables.
    
    Parameters:
    
    substitutions - The default message variables to use in the voice message. You can override the default variables with individual address variables.
  - withSubstitutions
```
public VoiceMessage withSubstitutions(Map<String,List<String>> substitutions)
```
    The default message variables to use in the voice message. You can override the default variables with individual address variables.
    
    Parameters:
    
    substitutions - The default message variables to use in the voice message. You can override the default variables with individual address variables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public VoiceMessage addSubstitutionsEntry(String key,
                                          List<String> value)
```
  - clearSubstitutionsEntries
```
public VoiceMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVoiceId
```
public void setVoiceId(String voiceId)
```
    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
    
    Parameters:
    
    voiceId - The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
  - getVoiceId
```
public String getVoiceId()
```
    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
    
    Returns:
    
    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
  - withVoiceId
```
public VoiceMessage withVoiceId(String voiceId)
```
    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
    
    Parameters:
    
    voiceId - The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VoiceMessage clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class VoiceMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VoiceMessage

Method Detail

setBody

getBody

withBody

setLanguageCode

getLanguageCode

withLanguageCode

setOriginationNumber

getOriginationNumber

withOriginationNumber

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setVoiceId

getVoiceId

withVoiceId

toString

equals

hashCode

clone

marshall