software.amazon.awssdk.services.sns.model.PublishRequest Maven / Gradle / Ivy
Show all versions of sns Show documentation
/*
* 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.sns.model;
import java.util.Arrays;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.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;
/**
*
* Input for Publish action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PublishRequest extends SnsRequest implements ToCopyableBuilder {
private static final SdkField TOPIC_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TopicArn").getter(getter(PublishRequest::topicArn)).setter(setter(Builder::topicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TopicArn").build()).build();
private static final SdkField TARGET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetArn").getter(getter(PublishRequest::targetArn)).setter(setter(Builder::targetArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetArn").build()).build();
private static final SdkField PHONE_NUMBER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PhoneNumber").getter(getter(PublishRequest::phoneNumber)).setter(setter(Builder::phoneNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumber").build()).build();
private static final SdkField MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Message")
.getter(getter(PublishRequest::message)).setter(setter(Builder::message))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Message").build()).build();
private static final SdkField SUBJECT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Subject")
.getter(getter(PublishRequest::subject)).setter(setter(Builder::subject))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subject").build()).build();
private static final SdkField MESSAGE_STRUCTURE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageStructure").getter(getter(PublishRequest::messageStructure))
.setter(setter(Builder::messageStructure))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageStructure").build()).build();
private static final SdkField> MESSAGE_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("MessageAttributes")
.getter(getter(PublishRequest::messageAttributes))
.setter(setter(Builder::messageAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageAttributes").build(),
MapTrait.builder()
.keyLocationName("Name")
.valueLocationName("Value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MessageAttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Value").build()).build()).build()).build();
private static final SdkField MESSAGE_DEDUPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageDeduplicationId").getter(getter(PublishRequest::messageDeduplicationId))
.setter(setter(Builder::messageDeduplicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageDeduplicationId").build())
.build();
private static final SdkField MESSAGE_GROUP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageGroupId").getter(getter(PublishRequest::messageGroupId)).setter(setter(Builder::messageGroupId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageGroupId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TOPIC_ARN_FIELD,
TARGET_ARN_FIELD, PHONE_NUMBER_FIELD, MESSAGE_FIELD, SUBJECT_FIELD, MESSAGE_STRUCTURE_FIELD,
MESSAGE_ATTRIBUTES_FIELD, MESSAGE_DEDUPLICATION_ID_FIELD, MESSAGE_GROUP_ID_FIELD));
private final String topicArn;
private final String targetArn;
private final String phoneNumber;
private final String message;
private final String subject;
private final String messageStructure;
private final Map messageAttributes;
private final String messageDeduplicationId;
private final String messageGroupId;
private PublishRequest(BuilderImpl builder) {
super(builder);
this.topicArn = builder.topicArn;
this.targetArn = builder.targetArn;
this.phoneNumber = builder.phoneNumber;
this.message = builder.message;
this.subject = builder.subject;
this.messageStructure = builder.messageStructure;
this.messageAttributes = builder.messageAttributes;
this.messageDeduplicationId = builder.messageDeduplicationId;
this.messageGroupId = builder.messageGroupId;
}
/**
*
* The topic you want to publish to.
*
*
* If you don't specify a value for the TopicArn parameter, you must specify a value for the
* PhoneNumber or TargetArn parameters.
*
*
* @return The topic you want to publish to.
*
* If you don't specify a value for the TopicArn parameter, you must specify a value for the
* PhoneNumber or TargetArn parameters.
*/
public final String topicArn() {
return topicArn;
}
/**
*
* If you don't specify a value for the TargetArn parameter, you must specify a value for the
* PhoneNumber or TopicArn parameters.
*
*
* @return If you don't specify a value for the TargetArn parameter, you must specify a value for the
* PhoneNumber or TopicArn parameters.
*/
public final String targetArn() {
return targetArn;
}
/**
*
* The phone number to which you want to deliver an SMS message. Use E.164 format.
*
*
* If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
* TargetArn or TopicArn parameters.
*
*
* @return The phone number to which you want to deliver an SMS message. Use E.164 format.
*
* If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
* TargetArn or TopicArn parameters.
*/
public final String phoneNumber() {
return phoneNumber;
}
/**
*
* The message you want to send.
*
*
* If you are publishing to a topic and you want to send the same message to all transport protocols, include the
* text of the message as a String value. If you want to send different messages for each transport protocol, set
* the value of the MessageStructure parameter to json and use a JSON object for the
* Message parameter.
*
*
*
* Constraints:
*
*
* -
*
* With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not
* 262,144 characters).
*
*
* -
*
* For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For
* example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
*
*
* If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each
* fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
*
*
* The total size limit for a single SMS Publish action is 1,600 characters.
*
*
*
*
* JSON-specific constraints:
*
*
* -
*
* Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
*
*
* -
*
* The values will be parsed (unescaped) before they are used in outgoing messages.
*
*
* -
*
* Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
*
*
* -
*
* Values have a minimum length of 0 (the empty string, "", is allowed).
*
*
* -
*
* Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit
* message sizes).
*
*
* -
*
* Non-string values will cause the key to be ignored.
*
*
* -
*
* Keys that do not correspond to supported transport protocols are ignored.
*
*
* -
*
* Duplicate keys are not allowed.
*
*
* -
*
* Failure to parse or validate any key or value in the message will cause the Publish call to return
* an error (no partial delivery).
*
*
*
*
* @return The message you want to send.
*
* If you are publishing to a topic and you want to send the same message to all transport protocols,
* include the text of the message as a String value. If you want to send different messages for each
* transport protocol, set the value of the MessageStructure parameter to json and
* use a JSON object for the Message parameter.
*
*
*
* Constraints:
*
*
* -
*
* With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144
* bytes, not 262,144 characters).
*
*
* -
*
* For SMS, each message can contain up to 140 characters. This character limit depends on the encoding
* schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2
* characters.
*
*
* If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages,
* each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word
* boundaries.
*
*
* The total size limit for a single SMS Publish action is 1,600 characters.
*
*
*
*
* JSON-specific constraints:
*
*
* -
*
* Keys in the JSON object that correspond to supported transport protocols must have simple JSON string
* values.
*
*
* -
*
* The values will be parsed (unescaped) before they are used in outgoing messages.
*
*
* -
*
* Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
*
*
* -
*
* Values have a minimum length of 0 (the empty string, "", is allowed).
*
*
* -
*
* Values have a maximum length bounded by the overall message size (so, including multiple protocols may
* limit message sizes).
*
*
* -
*
* Non-string values will cause the key to be ignored.
*
*
* -
*
* Keys that do not correspond to supported transport protocols are ignored.
*
*
* -
*
* Duplicate keys are not allowed.
*
*
* -
*
* Failure to parse or validate any key or value in the message will cause the Publish call to
* return an error (no partial delivery).
*
*
*/
public final String message() {
return message;
}
/**
*
* Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field
* will also be included, if present, in the standard JSON messages delivered to other endpoints.
*
*
* Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include
* line breaks or control characters; and must be less than 100 characters long.
*
*
* @return Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
* This field will also be included, if present, in the standard JSON messages delivered to other
* endpoints.
*
* Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not
* include line breaks or control characters; and must be less than 100 characters long.
*/
public final String subject() {
return subject;
}
/**
*
* Set MessageStructure to json if you want to send a different message for each protocol.
* For example, using one publish action, you can send a short message to your SMS subscribers and a longer message
* to your email subscribers. If you set MessageStructure to json, the value of the
* Message parameter must:
*
*
* -
*
* be a syntactically valid JSON object; and
*
*
* -
*
* contain at least a top-level JSON key of "default" with a value that is a string.
*
*
*
*
* You can define other top-level keys that define the message you want to send to a specific transport protocol
* (e.g., "http").
*
*
* Valid value: json
*
*
* @return Set MessageStructure to json if you want to send a different message for each
* protocol. For example, using one publish action, you can send a short message to your SMS subscribers and
* a longer message to your email subscribers. If you set MessageStructure to json
* , the value of the Message parameter must:
*
* -
*
* be a syntactically valid JSON object; and
*
*
* -
*
* contain at least a top-level JSON key of "default" with a value that is a string.
*
*
*
*
* You can define other top-level keys that define the message you want to send to a specific transport
* protocol (e.g., "http").
*
*
* Valid value: json
*/
public final String messageStructure() {
return messageStructure;
}
/**
* For responses, this returns true if the service returned a value for the MessageAttributes 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 hasMessageAttributes() {
return messageAttributes != null && !(messageAttributes instanceof SdkAutoConstructMap);
}
/**
*
* Message attributes for Publish action.
*
*
* 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 #hasMessageAttributes} method.
*
*
* @return Message attributes for Publish action.
*/
public final Map messageAttributes() {
return messageAttributes;
}
/**
*
* This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can
* contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
*
* Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of
* sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any
* message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is
* treated as a duplicate.
*
*
* If the topic has ContentBasedDeduplication set, the system generates a
* MessageDeduplicationId based on the contents of the message. Your
* MessageDeduplicationId overrides the generated one.
*
*
* @return This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId
* can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
* Every message must have a unique MessageDeduplicationId, which is a token used for
* deduplication of sent messages. If a message with a particular MessageDeduplicationId is
* sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute
* deduplication interval is treated as a duplicate.
*
*
* If the topic has ContentBasedDeduplication set, the system generates a
* MessageDeduplicationId based on the contents of the message. Your
* MessageDeduplicationId overrides the generated one.
*/
public final String messageDeduplicationId() {
return messageDeduplicationId;
}
/**
*
* This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up
* to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
*
* The MessageGroupId is a tag that specifies that a message belongs to a specific message group.
* Messages that belong to the same message group are processed in a FIFO manner (however, messages in different
* message groups might be processed out of order). Every message must include a MessageGroupId.
*
*
* @return This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can
* contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
* The MessageGroupId is a tag that specifies that a message belongs to a specific message
* group. Messages that belong to the same message group are processed in a FIFO manner (however, messages
* in different message groups might be processed out of order). Every message must include a
* MessageGroupId.
*/
public final String messageGroupId() {
return messageGroupId;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
hashCode = 31 * hashCode + Objects.hashCode(targetArn());
hashCode = 31 * hashCode + Objects.hashCode(phoneNumber());
hashCode = 31 * hashCode + Objects.hashCode(message());
hashCode = 31 * hashCode + Objects.hashCode(subject());
hashCode = 31 * hashCode + Objects.hashCode(messageStructure());
hashCode = 31 * hashCode + Objects.hashCode(hasMessageAttributes() ? messageAttributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(messageDeduplicationId());
hashCode = 31 * hashCode + Objects.hashCode(messageGroupId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PublishRequest)) {
return false;
}
PublishRequest other = (PublishRequest) obj;
return Objects.equals(topicArn(), other.topicArn()) && Objects.equals(targetArn(), other.targetArn())
&& Objects.equals(phoneNumber(), other.phoneNumber()) && Objects.equals(message(), other.message())
&& Objects.equals(subject(), other.subject()) && Objects.equals(messageStructure(), other.messageStructure())
&& hasMessageAttributes() == other.hasMessageAttributes()
&& Objects.equals(messageAttributes(), other.messageAttributes())
&& Objects.equals(messageDeduplicationId(), other.messageDeduplicationId())
&& Objects.equals(messageGroupId(), other.messageGroupId());
}
/**
* 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("PublishRequest").add("TopicArn", topicArn()).add("TargetArn", targetArn())
.add("PhoneNumber", phoneNumber() == null ? null : "*** Sensitive Data Redacted ***").add("Message", message())
.add("Subject", subject()).add("MessageStructure", messageStructure())
.add("MessageAttributes", hasMessageAttributes() ? messageAttributes() : null)
.add("MessageDeduplicationId", messageDeduplicationId()).add("MessageGroupId", messageGroupId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TopicArn":
return Optional.ofNullable(clazz.cast(topicArn()));
case "TargetArn":
return Optional.ofNullable(clazz.cast(targetArn()));
case "PhoneNumber":
return Optional.ofNullable(clazz.cast(phoneNumber()));
case "Message":
return Optional.ofNullable(clazz.cast(message()));
case "Subject":
return Optional.ofNullable(clazz.cast(subject()));
case "MessageStructure":
return Optional.ofNullable(clazz.cast(messageStructure()));
case "MessageAttributes":
return Optional.ofNullable(clazz.cast(messageAttributes()));
case "MessageDeduplicationId":
return Optional.ofNullable(clazz.cast(messageDeduplicationId()));
case "MessageGroupId":
return Optional.ofNullable(clazz.cast(messageGroupId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PublishRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The topic you want to publish to.
*
*
* If you don't specify a value for the TopicArn parameter, you must specify a value for the
* PhoneNumber or TargetArn parameters.
*
*
* @param topicArn
* The topic you want to publish to.
*
* If you don't specify a value for the TopicArn parameter, you must specify a value for the
* PhoneNumber or TargetArn parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder topicArn(String topicArn);
/**
*
* If you don't specify a value for the TargetArn parameter, you must specify a value for the
* PhoneNumber or TopicArn parameters.
*
*
* @param targetArn
* If you don't specify a value for the TargetArn parameter, you must specify a value for
* the PhoneNumber or TopicArn parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetArn(String targetArn);
/**
*
* The phone number to which you want to deliver an SMS message. Use E.164 format.
*
*
* If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
* TargetArn or TopicArn parameters.
*
*
* @param phoneNumber
* The phone number to which you want to deliver an SMS message. Use E.164 format.
*
* If you don't specify a value for the PhoneNumber parameter, you must specify a value for
* the TargetArn or TopicArn parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder phoneNumber(String phoneNumber);
/**
*
* The message you want to send.
*
*
* If you are publishing to a topic and you want to send the same message to all transport protocols, include
* the text of the message as a String value. If you want to send different messages for each transport
* protocol, set the value of the MessageStructure parameter to json and use a JSON
* object for the Message parameter.
*
*
*
* Constraints:
*
*
* -
*
* With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes,
* not 262,144 characters).
*
*
* -
*
* For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema.
* For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
*
*
* If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages,
* each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word
* boundaries.
*
*
* The total size limit for a single SMS Publish action is 1,600 characters.
*
*
*
*
* JSON-specific constraints:
*
*
* -
*
* Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
*
*
* -
*
* The values will be parsed (unescaped) before they are used in outgoing messages.
*
*
* -
*
* Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
*
*
* -
*
* Values have a minimum length of 0 (the empty string, "", is allowed).
*
*
* -
*
* Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit
* message sizes).
*
*
* -
*
* Non-string values will cause the key to be ignored.
*
*
* -
*
* Keys that do not correspond to supported transport protocols are ignored.
*
*
* -
*
* Duplicate keys are not allowed.
*
*
* -
*
* Failure to parse or validate any key or value in the message will cause the Publish call to
* return an error (no partial delivery).
*
*
*
*
* @param message
* The message you want to send.
*
* If you are publishing to a topic and you want to send the same message to all transport protocols,
* include the text of the message as a String value. If you want to send different messages for each
* transport protocol, set the value of the MessageStructure parameter to json
* and use a JSON object for the Message parameter.
*
*
*
* Constraints:
*
*
* -
*
* With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144
* bytes, not 262,144 characters).
*
*
* -
*
* For SMS, each message can contain up to 140 characters. This character limit depends on the encoding
* schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2
* characters.
*
*
* If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple
* messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at
* whole-word boundaries.
*
*
* The total size limit for a single SMS Publish action is 1,600 characters.
*
*
*
*
* JSON-specific constraints:
*
*
* -
*
* Keys in the JSON object that correspond to supported transport protocols must have simple JSON string
* values.
*
*
* -
*
* The values will be parsed (unescaped) before they are used in outgoing messages.
*
*
* -
*
* Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
*
*
* -
*
* Values have a minimum length of 0 (the empty string, "", is allowed).
*
*
* -
*
* Values have a maximum length bounded by the overall message size (so, including multiple protocols may
* limit message sizes).
*
*
* -
*
* Non-string values will cause the key to be ignored.
*
*
* -
*
* Keys that do not correspond to supported transport protocols are ignored.
*
*
* -
*
* Duplicate keys are not allowed.
*
*
* -
*
* Failure to parse or validate any key or value in the message will cause the Publish call
* to return an error (no partial delivery).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder message(String message);
/**
*
* Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
* field will also be included, if present, in the standard JSON messages delivered to other endpoints.
*
*
* Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not
* include line breaks or control characters; and must be less than 100 characters long.
*
*
* @param subject
* Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
* This field will also be included, if present, in the standard JSON messages delivered to other
* endpoints.
*
* Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must
* not include line breaks or control characters; and must be less than 100 characters long.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subject(String subject);
/**
*
* Set MessageStructure to json if you want to send a different message for each
* protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a
* longer message to your email subscribers. If you set MessageStructure to json, the
* value of the Message parameter must:
*
*
* -
*
* be a syntactically valid JSON object; and
*
*
* -
*
* contain at least a top-level JSON key of "default" with a value that is a string.
*
*
*
*
* You can define other top-level keys that define the message you want to send to a specific transport protocol
* (e.g., "http").
*
*
* Valid value: json
*
*
* @param messageStructure
* Set MessageStructure to json if you want to send a different message for
* each protocol. For example, using one publish action, you can send a short message to your SMS
* subscribers and a longer message to your email subscribers. If you set MessageStructure
* to json, the value of the Message parameter must:
*
* -
*
* be a syntactically valid JSON object; and
*
*
* -
*
* contain at least a top-level JSON key of "default" with a value that is a string.
*
*
*
*
* You can define other top-level keys that define the message you want to send to a specific transport
* protocol (e.g., "http").
*
*
* Valid value: json
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageStructure(String messageStructure);
/**
*
* Message attributes for Publish action.
*
*
* @param messageAttributes
* Message attributes for Publish action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageAttributes(Map messageAttributes);
/**
*
* This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can
* contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
*
* Every message must have a unique MessageDeduplicationId, which is a token used for deduplication
* of sent messages. If a message with a particular MessageDeduplicationId is sent successfully,
* any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval
* is treated as a duplicate.
*
*
* If the topic has ContentBasedDeduplication set, the system generates a
* MessageDeduplicationId based on the contents of the message. Your
* MessageDeduplicationId overrides the generated one.
*
*
* @param messageDeduplicationId
* This parameter applies only to FIFO (first-in-first-out) topics. The
* MessageDeduplicationId can contain up to 128 alphanumeric characters
* (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
* .
*
* Every message must have a unique MessageDeduplicationId, which is a token used for
* deduplication of sent messages. If a message with a particular MessageDeduplicationId is
* sent successfully, any message sent with the same MessageDeduplicationId during the
* 5-minute deduplication interval is treated as a duplicate.
*
*
* If the topic has ContentBasedDeduplication set, the system generates a
* MessageDeduplicationId based on the contents of the message. Your
* MessageDeduplicationId overrides the generated one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageDeduplicationId(String messageDeduplicationId);
/**
*
* This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain
* up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
*
* The MessageGroupId is a tag that specifies that a message belongs to a specific message group.
* Messages that belong to the same message group are processed in a FIFO manner (however, messages in different
* message groups might be processed out of order). Every message must include a MessageGroupId.
*
*
* @param messageGroupId
* This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can
* contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
* (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
*
* The MessageGroupId is a tag that specifies that a message belongs to a specific message
* group. Messages that belong to the same message group are processed in a FIFO manner (however,
* messages in different message groups might be processed out of order). Every message must include a
* MessageGroupId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageGroupId(String messageGroupId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SnsRequest.BuilderImpl implements Builder {
private String topicArn;
private String targetArn;
private String phoneNumber;
private String message;
private String subject;
private String messageStructure;
private Map messageAttributes = DefaultSdkAutoConstructMap.getInstance();
private String messageDeduplicationId;
private String messageGroupId;
private BuilderImpl() {
}
private BuilderImpl(PublishRequest model) {
super(model);
topicArn(model.topicArn);
targetArn(model.targetArn);
phoneNumber(model.phoneNumber);
message(model.message);
subject(model.subject);
messageStructure(model.messageStructure);
messageAttributes(model.messageAttributes);
messageDeduplicationId(model.messageDeduplicationId);
messageGroupId(model.messageGroupId);
}
public final String getTopicArn() {
return topicArn;
}
public final void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
@Override
public final Builder topicArn(String topicArn) {
this.topicArn = topicArn;
return this;
}
public final String getTargetArn() {
return targetArn;
}
public final void setTargetArn(String targetArn) {
this.targetArn = targetArn;
}
@Override
public final Builder targetArn(String targetArn) {
this.targetArn = targetArn;
return this;
}
public final String getPhoneNumber() {
return phoneNumber;
}
public final void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
@Override
public final Builder phoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
return this;
}
public final String getMessage() {
return message;
}
public final void setMessage(String message) {
this.message = message;
}
@Override
public final Builder message(String message) {
this.message = message;
return this;
}
public final String getSubject() {
return subject;
}
public final void setSubject(String subject) {
this.subject = subject;
}
@Override
public final Builder subject(String subject) {
this.subject = subject;
return this;
}
public final String getMessageStructure() {
return messageStructure;
}
public final void setMessageStructure(String messageStructure) {
this.messageStructure = messageStructure;
}
@Override
public final Builder messageStructure(String messageStructure) {
this.messageStructure = messageStructure;
return this;
}
public final Map getMessageAttributes() {
Map result = MessageAttributeMapCopier.copyToBuilder(this.messageAttributes);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setMessageAttributes(Map messageAttributes) {
this.messageAttributes = MessageAttributeMapCopier.copyFromBuilder(messageAttributes);
}
@Override
public final Builder messageAttributes(Map messageAttributes) {
this.messageAttributes = MessageAttributeMapCopier.copy(messageAttributes);
return this;
}
public final String getMessageDeduplicationId() {
return messageDeduplicationId;
}
public final void setMessageDeduplicationId(String messageDeduplicationId) {
this.messageDeduplicationId = messageDeduplicationId;
}
@Override
public final Builder messageDeduplicationId(String messageDeduplicationId) {
this.messageDeduplicationId = messageDeduplicationId;
return this;
}
public final String getMessageGroupId() {
return messageGroupId;
}
public final void setMessageGroupId(String messageGroupId) {
this.messageGroupId = messageGroupId;
}
@Override
public final Builder messageGroupId(String messageGroupId) {
this.messageGroupId = messageGroupId;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PublishRequest build() {
return new PublishRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}