software.amazon.awssdk.services.pinpoint.model.JourneyPushMessage 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.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
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 message configuration for a push notification that's sent to participants in a journey.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class JourneyPushMessage implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TIME_TO_LIVE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TimeToLive").getter(getter(JourneyPushMessage::timeToLive)).setter(setter(Builder::timeToLive))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeToLive").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TIME_TO_LIVE_FIELD));
private static final long serialVersionUID = 1L;
private final String timeToLive;
private JourneyPushMessage(BuilderImpl builder) {
this.timeToLive = builder.timeToLive;
}
/**
*
* 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 String timeToLive() {
return timeToLive;
}
@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(timeToLive());
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 JourneyPushMessage)) {
return false;
}
JourneyPushMessage other = (JourneyPushMessage) obj;
return Objects.equals(timeToLive(), other.timeToLive());
}
/**
* 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("JourneyPushMessage").add("TimeToLive", timeToLive()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TimeToLive":
return Optional.ofNullable(clazz.cast(timeToLive()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((JourneyPushMessage) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param timeToLive
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder timeToLive(String timeToLive);
}
static final class BuilderImpl implements Builder {
private String timeToLive;
private BuilderImpl() {
}
private BuilderImpl(JourneyPushMessage model) {
timeToLive(model.timeToLive);
}
public final String getTimeToLive() {
return timeToLive;
}
public final void setTimeToLive(String timeToLive) {
this.timeToLive = timeToLive;
}
@Override
@Transient
public final Builder timeToLive(String timeToLive) {
this.timeToLive = timeToLive;
return this;
}
@Override
public JourneyPushMessage build() {
return new JourneyPushMessage(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}