/* * Copyright 2018-2023 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 com.amazonaws.services.pinpointsmsvoicev2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SendVoiceMessageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The destination phone number in E.164 format. *

*/ private String destinationPhoneNumber; /** *

* The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, * PoolId, or PoolArn. *

*/ private String originationIdentity; /** *

* The text to convert to a voice message. *

*/ private String messageBody; /** *

* Specifies if the MessageBody field contains text or speech synthesis markup language (SSML). *

* */ private String messageBodyTextType; /** *

* The voice for the Amazon Polly service to * use. By default this is set to "MATTHEW". *

*/ private String voiceId; /** *

* The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. *

*/ private String configurationSetName; /** *

* The maximum amount to spend per voice message, in US dollars. *

*/ private String maxPricePerMinute; /** *

* How long the voice message is valid for. By default this is 72 hours. *

*/ private Integer timeToLive; /** *

* You can specify custom data in this field. If you do, that data is logged to the event destination. *

*/ private java.util.Map context; /** *

* When set to true, the message is checked and validated, but isn't sent to the end recipient. *

*/ private Boolean dryRun; /** *

* The destination phone number in E.164 format. *

* * @param destinationPhoneNumber * The destination phone number in E.164 format. */ public void setDestinationPhoneNumber(String destinationPhoneNumber) { this.destinationPhoneNumber = destinationPhoneNumber; } /** *

* The destination phone number in E.164 format. *

* * @return The destination phone number in E.164 format. */ public String getDestinationPhoneNumber() { return this.destinationPhoneNumber; } /** *

* The destination phone number in E.164 format. *

* * @param destinationPhoneNumber * The destination phone number in E.164 format. * @return Returns a reference to this object so that method calls can be chained together. */ public SendVoiceMessageRequest withDestinationPhoneNumber(String destinationPhoneNumber) { setDestinationPhoneNumber(destinationPhoneNumber); return this; } /** *

* The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, * PoolId, or PoolArn. *

* * @param originationIdentity * The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, * PhoneNumberArn, PoolId, or PoolArn. */ public void setOriginationIdentity(String originationIdentity) { this.originationIdentity = originationIdentity; } /** *

* The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, * PoolId, or PoolArn. *

* * @return The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, * PhoneNumberArn, PoolId, or PoolArn. */ public String getOriginationIdentity() { return this.originationIdentity; } /** *

* The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, * PoolId, or PoolArn. *

* * @param originationIdentity * The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, * PhoneNumberArn, PoolId, or PoolArn. * @return Returns a reference to this object so that method calls can be chained together. */ public SendVoiceMessageRequest withOriginationIdentity(String originationIdentity) { setOriginationIdentity(originationIdentity); return this; } /** *

* The text to convert to a voice message. *

* * @param messageBody * The text to convert to a voice message. */ public void setMessageBody(String messageBody) { this.messageBody = messageBody; } /** *

* The text to convert to a voice message. *

* * @return The text to convert to a voice message. */ public String getMessageBody() { return this.messageBody; } /** *

* The text to convert to a voice message. *

* * @param messageBody * The text to convert to a voice message. * @return Returns a reference to this object so that method calls can be chained together. */ public SendVoiceMessageRequest withMessageBody(String messageBody) { setMessageBody(messageBody); return this; } /** *

* Specifies if the MessageBody field contains text or speech synthesis markup language (SSML). *

* * * @param messageBodyTextType * Specifies if the MessageBody field contains text or speech synthesis markup language * (SSML).

*