software.amazon.awssdk.services.pinpoint.model.VoiceMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.pinpoint.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class VoiceMessage implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField BODY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Body")
.getter(getter(VoiceMessage::body)).setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Body").build()).build();
private static final SdkField LANGUAGE_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LanguageCode").getter(getter(VoiceMessage::languageCode)).setter(setter(Builder::languageCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LanguageCode").build()).build();
private static final SdkField ORIGINATION_NUMBER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OriginationNumber").getter(getter(VoiceMessage::originationNumber))
.setter(setter(Builder::originationNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OriginationNumber").build()).build();
private static final SdkField>> SUBSTITUTIONS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("Substitutions")
.getter(getter(VoiceMessage::substitutions))
.setter(setter(Builder::substitutions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Substitutions").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final SdkField VOICE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VoiceId").getter(getter(VoiceMessage::voiceId)).setter(setter(Builder::voiceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VoiceId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BODY_FIELD,
LANGUAGE_CODE_FIELD, ORIGINATION_NUMBER_FIELD, SUBSTITUTIONS_FIELD, VOICE_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String body;
private final String languageCode;
private final String originationNumber;
private final Map> substitutions;
private final String voiceId;
private VoiceMessage(BuilderImpl builder) {
this.body = builder.body;
this.languageCode = builder.languageCode;
this.originationNumber = builder.originationNumber;
this.substitutions = builder.substitutions;
this.voiceId = builder.voiceId;
}
/**
*
* The text of the script to use for the voice message.
*
*
* @return The text of the script to use for the voice message.
*/
public final String body() {
return body;
}
/**
*
* The code for the language to use when synthesizing the text of the message script. For a list of supported
* languages and the code for each one, see the Amazon Polly Developer Guide.
*
*
* @return The code for the language to use when synthesizing the text of the message script. For a list of
* supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/
public final String languageCode() {
return languageCode;
}
/**
*
* The long code to send the voice message from. This value should be one of the dedicated long codes that's
* assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164
* format, for example +12065550100, to ensure prompt and accurate delivery of the message.
*
*
* @return The long code to send the voice message from. This value should be one of the dedicated long codes that's
* assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in
* E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
*/
public final String originationNumber() {
return originationNumber;
}
/**
* For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasSubstitutions() {
return substitutions != null && !(substitutions instanceof SdkAutoConstructMap);
}
/**
*
* The default message variables to use in the voice message. You can override the default variables with individual
* address variables.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSubstitutions} method.
*
*
* @return The default message variables to use in the voice message. You can override the default variables with
* individual address variables.
*/
public final Map> substitutions() {
return substitutions;
}
/**
*
* The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
*
*
* @return The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
*/
public final String voiceId() {
return voiceId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(languageCode());
hashCode = 31 * hashCode + Objects.hashCode(originationNumber());
hashCode = 31 * hashCode + Objects.hashCode(hasSubstitutions() ? substitutions() : null);
hashCode = 31 * hashCode + Objects.hashCode(voiceId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof VoiceMessage)) {
return false;
}
VoiceMessage other = (VoiceMessage) obj;
return Objects.equals(body(), other.body()) && Objects.equals(languageCode(), other.languageCode())
&& Objects.equals(originationNumber(), other.originationNumber())
&& hasSubstitutions() == other.hasSubstitutions() && Objects.equals(substitutions(), other.substitutions())
&& Objects.equals(voiceId(), other.voiceId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("VoiceMessage").add("Body", body()).add("LanguageCode", languageCode())
.add("OriginationNumber", originationNumber()).add("Substitutions", hasSubstitutions() ? substitutions() : null)
.add("VoiceId", voiceId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Body":
return Optional.ofNullable(clazz.cast(body()));
case "LanguageCode":
return Optional.ofNullable(clazz.cast(languageCode()));
case "OriginationNumber":
return Optional.ofNullable(clazz.cast(originationNumber()));
case "Substitutions":
return Optional.ofNullable(clazz.cast(substitutions()));
case "VoiceId":
return Optional.ofNullable(clazz.cast(voiceId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((VoiceMessage) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The text of the script to use for the voice message.
*
*
* @param body
* The text of the script to use for the voice message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder body(String body);
/**
*
* The code for the language to use when synthesizing the text of the message script. For a list of supported
* languages and the code for each one, see the Amazon Polly Developer Guide.
*
*
* @param languageCode
* The code for the language to use when synthesizing the text of the message script. For a list of
* supported languages and the code for each one, see the Amazon Polly Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder languageCode(String languageCode);
/**
*
* The long code to send the voice message from. This value should be one of the dedicated long codes that's
* assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in
* E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
*
*
* @param originationNumber
* The long code to send the voice message from. This value should be one of the dedicated long codes
* that's assigned to your AWS account. Although it isn't required, we recommend that you specify the
* long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the
* message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder originationNumber(String originationNumber);
/**
*
* The default message variables to use in the voice message. You can override the default variables with
* individual address variables.
*
*
* @param substitutions
* The default message variables to use in the voice message. You can override the default variables with
* individual address variables.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder substitutions(Map> substitutions);
/**
*
* The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
*
*
* @param voiceId
* The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder voiceId(String voiceId);
}
static final class BuilderImpl implements Builder {
private String body;
private String languageCode;
private String originationNumber;
private Map> substitutions = DefaultSdkAutoConstructMap.getInstance();
private String voiceId;
private BuilderImpl() {
}
private BuilderImpl(VoiceMessage model) {
body(model.body);
languageCode(model.languageCode);
originationNumber(model.originationNumber);
substitutions(model.substitutions);
voiceId(model.voiceId);
}
public final String getBody() {
return body;
}
public final void setBody(String body) {
this.body = body;
}
@Override
@Transient
public final Builder body(String body) {
this.body = body;
return this;
}
public final String getLanguageCode() {
return languageCode;
}
public final void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
@Override
@Transient
public final Builder languageCode(String languageCode) {
this.languageCode = languageCode;
return this;
}
public final String getOriginationNumber() {
return originationNumber;
}
public final void setOriginationNumber(String originationNumber) {
this.originationNumber = originationNumber;
}
@Override
@Transient
public final Builder originationNumber(String originationNumber) {
this.originationNumber = originationNumber;
return this;
}
public final Map> getSubstitutions() {
if (substitutions instanceof SdkAutoConstructMap) {
return null;
}
return substitutions;
}
public final void setSubstitutions(Map> substitutions) {
this.substitutions = MapOfListOf__stringCopier.copy(substitutions);
}
@Override
@Transient
public final Builder substitutions(Map> substitutions) {
this.substitutions = MapOfListOf__stringCopier.copy(substitutions);
return this;
}
public final String getVoiceId() {
return voiceId;
}
public final void setVoiceId(String voiceId) {
this.voiceId = voiceId;
}
@Override
@Transient
public final Builder voiceId(String voiceId) {
this.voiceId = voiceId;
return this;
}
@Override
public VoiceMessage build() {
return new VoiceMessage(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy