software.amazon.awssdk.services.pinpoint.model.JourneyLimits Maven / Gradle / Ivy
/*
* 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.List;
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.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 limits on the messages that a journey can send and the number of times participants can enter a journey.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class JourneyLimits implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DAILY_CAP_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("DailyCap").getter(getter(JourneyLimits::dailyCap)).setter(setter(Builder::dailyCap))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DailyCap").build()).build();
private static final SdkField ENDPOINT_REENTRY_CAP_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("EndpointReentryCap").getter(getter(JourneyLimits::endpointReentryCap))
.setter(setter(Builder::endpointReentryCap))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointReentryCap").build())
.build();
private static final SdkField MESSAGES_PER_SECOND_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MessagesPerSecond").getter(getter(JourneyLimits::messagesPerSecond))
.setter(setter(Builder::messagesPerSecond))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessagesPerSecond").build()).build();
private static final SdkField ENDPOINT_REENTRY_INTERVAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointReentryInterval").getter(getter(JourneyLimits::endpointReentryInterval))
.setter(setter(Builder::endpointReentryInterval))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointReentryInterval").build())
.build();
private static final SdkField TIMEFRAME_CAP_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TimeframeCap")
.getter(getter(JourneyLimits::timeframeCap)).setter(setter(Builder::timeframeCap))
.constructor(JourneyTimeframeCap::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeframeCap").build()).build();
private static final SdkField TOTAL_CAP_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TotalCap").getter(getter(JourneyLimits::totalCap)).setter(setter(Builder::totalCap))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TotalCap").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DAILY_CAP_FIELD,
ENDPOINT_REENTRY_CAP_FIELD, MESSAGES_PER_SECOND_FIELD, ENDPOINT_REENTRY_INTERVAL_FIELD, TIMEFRAME_CAP_FIELD,
TOTAL_CAP_FIELD));
private static final long serialVersionUID = 1L;
private final Integer dailyCap;
private final Integer endpointReentryCap;
private final Integer messagesPerSecond;
private final String endpointReentryInterval;
private final JourneyTimeframeCap timeframeCap;
private final Integer totalCap;
private JourneyLimits(BuilderImpl builder) {
this.dailyCap = builder.dailyCap;
this.endpointReentryCap = builder.endpointReentryCap;
this.messagesPerSecond = builder.messagesPerSecond;
this.endpointReentryInterval = builder.endpointReentryInterval;
this.timeframeCap = builder.timeframeCap;
this.totalCap = builder.totalCap;
}
/**
*
* The maximum number of messages that the journey can send to a single participant during a 24-hour period. The
* maximum value is 100.
*
*
* @return The maximum number of messages that the journey can send to a single participant during a 24-hour period.
* The maximum value is 100.
*/
public final Integer dailyCap() {
return dailyCap;
}
/**
*
* The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow
* participants to enter the journey an unlimited number of times, set this value to 0.
*
*
* @return The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow
* participants to enter the journey an unlimited number of times, set this value to 0.
*/
public final Integer endpointReentryCap() {
return endpointReentryCap;
}
/**
*
* The maximum number of messages that the journey can send each second.
*
*
* @return The maximum number of messages that the journey can send each second.
*/
public final Integer messagesPerSecond() {
return messagesPerSecond;
}
/**
*
* Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601
* format, such as PT1H.
*
*
* @return Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an
* ISO 8601 format, such as PT1H.
*/
public final String endpointReentryInterval() {
return endpointReentryInterval;
}
/**
*
* The number of messages that an endpoint can receive during the specified timeframe.
*
*
* @return The number of messages that an endpoint can receive during the specified timeframe.
*/
public final JourneyTimeframeCap timeframeCap() {
return timeframeCap;
}
/**
*
* The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0,
* this limit will not apply.
*
*
* @return The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set
* to 0, this limit will not apply.
*/
public final Integer totalCap() {
return totalCap;
}
@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(dailyCap());
hashCode = 31 * hashCode + Objects.hashCode(endpointReentryCap());
hashCode = 31 * hashCode + Objects.hashCode(messagesPerSecond());
hashCode = 31 * hashCode + Objects.hashCode(endpointReentryInterval());
hashCode = 31 * hashCode + Objects.hashCode(timeframeCap());
hashCode = 31 * hashCode + Objects.hashCode(totalCap());
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 JourneyLimits)) {
return false;
}
JourneyLimits other = (JourneyLimits) obj;
return Objects.equals(dailyCap(), other.dailyCap()) && Objects.equals(endpointReentryCap(), other.endpointReentryCap())
&& Objects.equals(messagesPerSecond(), other.messagesPerSecond())
&& Objects.equals(endpointReentryInterval(), other.endpointReentryInterval())
&& Objects.equals(timeframeCap(), other.timeframeCap()) && Objects.equals(totalCap(), other.totalCap());
}
/**
* 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("JourneyLimits").add("DailyCap", dailyCap()).add("EndpointReentryCap", endpointReentryCap())
.add("MessagesPerSecond", messagesPerSecond()).add("EndpointReentryInterval", endpointReentryInterval())
.add("TimeframeCap", timeframeCap()).add("TotalCap", totalCap()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DailyCap":
return Optional.ofNullable(clazz.cast(dailyCap()));
case "EndpointReentryCap":
return Optional.ofNullable(clazz.cast(endpointReentryCap()));
case "MessagesPerSecond":
return Optional.ofNullable(clazz.cast(messagesPerSecond()));
case "EndpointReentryInterval":
return Optional.ofNullable(clazz.cast(endpointReentryInterval()));
case "TimeframeCap":
return Optional.ofNullable(clazz.cast(timeframeCap()));
case "TotalCap":
return Optional.ofNullable(clazz.cast(totalCap()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((JourneyLimits) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The maximum number of messages that the journey can send to a single participant during a 24-hour period. The
* maximum value is 100.
*
*
* @param dailyCap
* The maximum number of messages that the journey can send to a single participant during a 24-hour
* period. The maximum value is 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dailyCap(Integer dailyCap);
/**
*
* The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow
* participants to enter the journey an unlimited number of times, set this value to 0.
*
*
* @param endpointReentryCap
* The maximum number of times that a participant can enter the journey. The maximum value is 100. To
* allow participants to enter the journey an unlimited number of times, set this value to 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointReentryCap(Integer endpointReentryCap);
/**
*
* The maximum number of messages that the journey can send each second.
*
*
* @param messagesPerSecond
* The maximum number of messages that the journey can send each second.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messagesPerSecond(Integer messagesPerSecond);
/**
*
* Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO
* 8601 format, such as PT1H.
*
*
* @param endpointReentryInterval
* Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use
* an ISO 8601 format, such as PT1H.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointReentryInterval(String endpointReentryInterval);
/**
*
* The number of messages that an endpoint can receive during the specified timeframe.
*
*
* @param timeframeCap
* The number of messages that an endpoint can receive during the specified timeframe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeframeCap(JourneyTimeframeCap timeframeCap);
/**
*
* The number of messages that an endpoint can receive during the specified timeframe.
*
* This is a convenience method that creates an instance of the {@link JourneyTimeframeCap.Builder} avoiding the
* need to create one manually via {@link JourneyTimeframeCap#builder()}.
*
*
* When the {@link Consumer} completes, {@link JourneyTimeframeCap.Builder#build()} is called immediately and
* its result is passed to {@link #timeframeCap(JourneyTimeframeCap)}.
*
* @param timeframeCap
* a consumer that will call methods on {@link JourneyTimeframeCap.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timeframeCap(JourneyTimeframeCap)
*/
default Builder timeframeCap(Consumer timeframeCap) {
return timeframeCap(JourneyTimeframeCap.builder().applyMutation(timeframeCap).build());
}
/**
*
* The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to
* 0, this limit will not apply.
*
*
* @param totalCap
* The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If
* set to 0, this limit will not apply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder totalCap(Integer totalCap);
}
static final class BuilderImpl implements Builder {
private Integer dailyCap;
private Integer endpointReentryCap;
private Integer messagesPerSecond;
private String endpointReentryInterval;
private JourneyTimeframeCap timeframeCap;
private Integer totalCap;
private BuilderImpl() {
}
private BuilderImpl(JourneyLimits model) {
dailyCap(model.dailyCap);
endpointReentryCap(model.endpointReentryCap);
messagesPerSecond(model.messagesPerSecond);
endpointReentryInterval(model.endpointReentryInterval);
timeframeCap(model.timeframeCap);
totalCap(model.totalCap);
}
public final Integer getDailyCap() {
return dailyCap;
}
public final void setDailyCap(Integer dailyCap) {
this.dailyCap = dailyCap;
}
@Override
public final Builder dailyCap(Integer dailyCap) {
this.dailyCap = dailyCap;
return this;
}
public final Integer getEndpointReentryCap() {
return endpointReentryCap;
}
public final void setEndpointReentryCap(Integer endpointReentryCap) {
this.endpointReentryCap = endpointReentryCap;
}
@Override
public final Builder endpointReentryCap(Integer endpointReentryCap) {
this.endpointReentryCap = endpointReentryCap;
return this;
}
public final Integer getMessagesPerSecond() {
return messagesPerSecond;
}
public final void setMessagesPerSecond(Integer messagesPerSecond) {
this.messagesPerSecond = messagesPerSecond;
}
@Override
public final Builder messagesPerSecond(Integer messagesPerSecond) {
this.messagesPerSecond = messagesPerSecond;
return this;
}
public final String getEndpointReentryInterval() {
return endpointReentryInterval;
}
public final void setEndpointReentryInterval(String endpointReentryInterval) {
this.endpointReentryInterval = endpointReentryInterval;
}
@Override
public final Builder endpointReentryInterval(String endpointReentryInterval) {
this.endpointReentryInterval = endpointReentryInterval;
return this;
}
public final JourneyTimeframeCap.Builder getTimeframeCap() {
return timeframeCap != null ? timeframeCap.toBuilder() : null;
}
public final void setTimeframeCap(JourneyTimeframeCap.BuilderImpl timeframeCap) {
this.timeframeCap = timeframeCap != null ? timeframeCap.build() : null;
}
@Override
public final Builder timeframeCap(JourneyTimeframeCap timeframeCap) {
this.timeframeCap = timeframeCap;
return this;
}
public final Integer getTotalCap() {
return totalCap;
}
public final void setTotalCap(Integer totalCap) {
this.totalCap = totalCap;
}
@Override
public final Builder totalCap(Integer totalCap) {
this.totalCap = totalCap;
return this;
}
@Override
public JourneyLimits build() {
return new JourneyLimits(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}