software.amazon.awssdk.services.pinpoint.model.Message Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies the content and settings for a push notification that's sent to recipients of a campaign.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Message implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ACTION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Action")
.getter(getter(Message::actionAsString)).setter(setter(Builder::action))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Action").build()).build();
private static final SdkField BODY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Body")
.getter(getter(Message::body)).setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Body").build()).build();
private static final SdkField IMAGE_ICON_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageIconUrl").getter(getter(Message::imageIconUrl)).setter(setter(Builder::imageIconUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageIconUrl").build()).build();
private static final SdkField IMAGE_SMALL_ICON_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageSmallIconUrl").getter(getter(Message::imageSmallIconUrl))
.setter(setter(Builder::imageSmallIconUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageSmallIconUrl").build()).build();
private static final SdkField IMAGE_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageUrl").getter(getter(Message::imageUrl)).setter(setter(Builder::imageUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageUrl").build()).build();
private static final SdkField JSON_BODY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("JsonBody").getter(getter(Message::jsonBody)).setter(setter(Builder::jsonBody))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JsonBody").build()).build();
private static final SdkField MEDIA_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MediaUrl").getter(getter(Message::mediaUrl)).setter(setter(Builder::mediaUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MediaUrl").build()).build();
private static final SdkField RAW_CONTENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RawContent").getter(getter(Message::rawContent)).setter(setter(Builder::rawContent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RawContent").build()).build();
private static final SdkField SILENT_PUSH_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("SilentPush").getter(getter(Message::silentPush)).setter(setter(Builder::silentPush))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SilentPush").build()).build();
private static final SdkField TIME_TO_LIVE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TimeToLive").getter(getter(Message::timeToLive)).setter(setter(Builder::timeToLive))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeToLive").build()).build();
private static final SdkField TITLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Title")
.getter(getter(Message::title)).setter(setter(Builder::title))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Title").build()).build();
private static final SdkField URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Url")
.getter(getter(Message::url)).setter(setter(Builder::url))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Url").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACTION_FIELD, BODY_FIELD,
IMAGE_ICON_URL_FIELD, IMAGE_SMALL_ICON_URL_FIELD, IMAGE_URL_FIELD, JSON_BODY_FIELD, MEDIA_URL_FIELD,
RAW_CONTENT_FIELD, SILENT_PUSH_FIELD, TIME_TO_LIVE_FIELD, TITLE_FIELD, URL_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String action;
private final String body;
private final String imageIconUrl;
private final String imageSmallIconUrl;
private final String imageUrl;
private final String jsonBody;
private final String mediaUrl;
private final String rawContent;
private final Boolean silentPush;
private final Integer timeToLive;
private final String title;
private final String url;
private Message(BuilderImpl builder) {
this.action = builder.action;
this.body = builder.body;
this.imageIconUrl = builder.imageIconUrl;
this.imageSmallIconUrl = builder.imageSmallIconUrl;
this.imageUrl = builder.imageUrl;
this.jsonBody = builder.jsonBody;
this.mediaUrl = builder.mediaUrl;
this.rawContent = builder.rawContent;
this.silentPush = builder.silentPush;
this.timeToLive = builder.timeToLive;
this.title = builder.title;
this.url = builder.url;
}
/**
*
* The action to occur if a recipient taps the push notification. Valid values are:
*
*
* -
*
* OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default
* action.
*
*
* -
*
* DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the
* deep-linking features of iOS and Android.
*
*
* -
*
* URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you
* specify.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link Action#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionAsString}.
*
*
* @return The action to occur if a recipient taps the push notification. Valid values are:
*
* -
*
* OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the
* default action.
*
*
* -
*
* DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the
* deep-linking features of iOS and Android.
*
*
* -
*
* URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you
* specify.
*
*
* @see Action
*/
public final Action action() {
return Action.fromValue(action);
}
/**
*
* The action to occur if a recipient taps the push notification. Valid values are:
*
*
* -
*
* OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default
* action.
*
*
* -
*
* DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the
* deep-linking features of iOS and Android.
*
*
* -
*
* URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you
* specify.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link Action#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionAsString}.
*
*
* @return The action to occur if a recipient taps the push notification. Valid values are:
*
* -
*
* OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the
* default action.
*
*
* -
*
* DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the
* deep-linking features of iOS and Android.
*
*
* -
*
* URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you
* specify.
*
*
* @see Action
*/
public final String actionAsString() {
return action;
}
/**
*
* The body of the notification message. The maximum number of characters is 200.
*
*
* @return The body of the notification message. The maximum number of characters is 200.
*/
public final String body() {
return body;
}
/**
*
* The URL of the image to display as the push-notification icon, such as the icon for the app.
*
*
* @return The URL of the image to display as the push-notification icon, such as the icon for the app.
*/
public final String imageIconUrl() {
return imageIconUrl;
}
/**
*
* The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the
* app.
*
*
* @return The URL of the image to display as the small, push-notification icon, such as a small version of the icon
* for the app.
*/
public final String imageSmallIconUrl() {
return imageSmallIconUrl;
}
/**
*
* The URL of an image to display in the push notification.
*
*
* @return The URL of an image to display in the push notification.
*/
public final String imageUrl() {
return imageUrl;
}
/**
*
* The JSON payload to use for a silent push notification.
*
*
* @return The JSON payload to use for a silent push notification.
*/
public final String jsonBody() {
return jsonBody;
}
/**
*
* The URL of the image or video to display in the push notification.
*
*
* @return The URL of the image or video to display in the push notification.
*/
public final String mediaUrl() {
return mediaUrl;
}
/**
*
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value
* overrides all other content for the message.
*
*
* @return The raw, JSON-formatted string to use as the payload for the notification message. If specified, this
* value overrides all other content for the message.
*/
public final String rawContent() {
return rawContent;
}
/**
*
* Specifies whether the notification is a silent push notification, which is a push notification that doesn't
* display on a recipient's device. Silent push notifications can be used for cases such as updating an app's
* configuration, displaying messages in an in-app message center, or supporting phone home functionality.
*
*
* @return Specifies whether the notification is a silent push notification, which is a push notification that
* doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating
* an app's configuration, displaying messages in an in-app message center, or supporting phone home
* functionality.
*/
public final Boolean silentPush() {
return silentPush;
}
/**
*
* The number of seconds that the push-notification service should keep the message, if the service is unable to
* deliver the notification the first time. This value is converted to an expiration value when it's sent to a
* push-notification service. If this value is 0, the service treats the notification as if it expires immediately
* and the service doesn't store or try to deliver the notification again.
*
*
* This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*
*
* @return The number of seconds that the push-notification service should keep the message, if the service is
* unable to deliver the notification the first time. This value is converted to an expiration value when
* it's sent to a push-notification service. If this value is 0, the service treats the notification as if
* it expires immediately and the service doesn't store or try to deliver the notification again.
*
* This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*/
public final Integer timeToLive() {
return timeToLive;
}
/**
*
* The title to display above the notification message on a recipient's device.
*
*
* @return The title to display above the notification message on a recipient's device.
*/
public final String title() {
return title;
}
/**
*
* The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value
* of the Action property is URL.
*
*
* @return The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and
* the value of the Action property is URL.
*/
public final String url() {
return url;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(actionAsString());
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(imageIconUrl());
hashCode = 31 * hashCode + Objects.hashCode(imageSmallIconUrl());
hashCode = 31 * hashCode + Objects.hashCode(imageUrl());
hashCode = 31 * hashCode + Objects.hashCode(jsonBody());
hashCode = 31 * hashCode + Objects.hashCode(mediaUrl());
hashCode = 31 * hashCode + Objects.hashCode(rawContent());
hashCode = 31 * hashCode + Objects.hashCode(silentPush());
hashCode = 31 * hashCode + Objects.hashCode(timeToLive());
hashCode = 31 * hashCode + Objects.hashCode(title());
hashCode = 31 * hashCode + Objects.hashCode(url());
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 Message)) {
return false;
}
Message other = (Message) obj;
return Objects.equals(actionAsString(), other.actionAsString()) && Objects.equals(body(), other.body())
&& Objects.equals(imageIconUrl(), other.imageIconUrl())
&& Objects.equals(imageSmallIconUrl(), other.imageSmallIconUrl()) && Objects.equals(imageUrl(), other.imageUrl())
&& Objects.equals(jsonBody(), other.jsonBody()) && Objects.equals(mediaUrl(), other.mediaUrl())
&& Objects.equals(rawContent(), other.rawContent()) && Objects.equals(silentPush(), other.silentPush())
&& Objects.equals(timeToLive(), other.timeToLive()) && Objects.equals(title(), other.title())
&& Objects.equals(url(), other.url());
}
/**
* 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("Message").add("Action", actionAsString()).add("Body", body())
.add("ImageIconUrl", imageIconUrl()).add("ImageSmallIconUrl", imageSmallIconUrl()).add("ImageUrl", imageUrl())
.add("JsonBody", jsonBody()).add("MediaUrl", mediaUrl()).add("RawContent", rawContent())
.add("SilentPush", silentPush()).add("TimeToLive", timeToLive()).add("Title", title()).add("Url", url()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Action":
return Optional.ofNullable(clazz.cast(actionAsString()));
case "Body":
return Optional.ofNullable(clazz.cast(body()));
case "ImageIconUrl":
return Optional.ofNullable(clazz.cast(imageIconUrl()));
case "ImageSmallIconUrl":
return Optional.ofNullable(clazz.cast(imageSmallIconUrl()));
case "ImageUrl":
return Optional.ofNullable(clazz.cast(imageUrl()));
case "JsonBody":
return Optional.ofNullable(clazz.cast(jsonBody()));
case "MediaUrl":
return Optional.ofNullable(clazz.cast(mediaUrl()));
case "RawContent":
return Optional.ofNullable(clazz.cast(rawContent()));
case "SilentPush":
return Optional.ofNullable(clazz.cast(silentPush()));
case "TimeToLive":
return Optional.ofNullable(clazz.cast(timeToLive()));
case "Title":
return Optional.ofNullable(clazz.cast(title()));
case "Url":
return Optional.ofNullable(clazz.cast(url()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Action", ACTION_FIELD);
map.put("Body", BODY_FIELD);
map.put("ImageIconUrl", IMAGE_ICON_URL_FIELD);
map.put("ImageSmallIconUrl", IMAGE_SMALL_ICON_URL_FIELD);
map.put("ImageUrl", IMAGE_URL_FIELD);
map.put("JsonBody", JSON_BODY_FIELD);
map.put("MediaUrl", MEDIA_URL_FIELD);
map.put("RawContent", RAW_CONTENT_FIELD);
map.put("SilentPush", SILENT_PUSH_FIELD);
map.put("TimeToLive", TIME_TO_LIVE_FIELD);
map.put("Title", TITLE_FIELD);
map.put("Url", URL_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function