software.amazon.awssdk.services.pinpoint.model.RecencyDimension 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.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 criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RecencyDimension implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Duration").getter(getter(RecencyDimension::durationAsString)).setter(setter(Builder::duration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Duration").build()).build();
private static final SdkField RECENCY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RecencyType").getter(getter(RecencyDimension::recencyTypeAsString)).setter(setter(Builder::recencyType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecencyType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DURATION_FIELD,
RECENCY_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String duration;
private final String recencyType;
private RecencyDimension(BuilderImpl builder) {
this.duration = builder.duration;
this.recencyType = builder.recencyType;
}
/**
*
* The duration to use when determining whether an endpoint is active or inactive.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #duration} will
* return {@link Duration#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #durationAsString}.
*
*
* @return The duration to use when determining whether an endpoint is active or inactive.
* @see Duration
*/
public final Duration duration() {
return Duration.fromValue(duration);
}
/**
*
* The duration to use when determining whether an endpoint is active or inactive.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #duration} will
* return {@link Duration#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #durationAsString}.
*
*
* @return The duration to use when determining whether an endpoint is active or inactive.
* @see Duration
*/
public final String durationAsString() {
return duration;
}
/**
*
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within
* the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the
* specified duration are included in the segment.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #recencyType} will
* return {@link RecencyType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #recencyTypeAsString}.
*
*
* @return The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were
* active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't
* active within the specified duration are included in the segment.
* @see RecencyType
*/
public final RecencyType recencyType() {
return RecencyType.fromValue(recencyType);
}
/**
*
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within
* the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the
* specified duration are included in the segment.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #recencyType} will
* return {@link RecencyType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #recencyTypeAsString}.
*
*
* @return The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were
* active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't
* active within the specified duration are included in the segment.
* @see RecencyType
*/
public final String recencyTypeAsString() {
return recencyType;
}
@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(durationAsString());
hashCode = 31 * hashCode + Objects.hashCode(recencyTypeAsString());
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 RecencyDimension)) {
return false;
}
RecencyDimension other = (RecencyDimension) obj;
return Objects.equals(durationAsString(), other.durationAsString())
&& Objects.equals(recencyTypeAsString(), other.recencyTypeAsString());
}
/**
* 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("RecencyDimension").add("Duration", durationAsString()).add("RecencyType", recencyTypeAsString())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Duration":
return Optional.ofNullable(clazz.cast(durationAsString()));
case "RecencyType":
return Optional.ofNullable(clazz.cast(recencyTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RecencyDimension) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The duration to use when determining whether an endpoint is active or inactive.
*
*
* @param duration
* The duration to use when determining whether an endpoint is active or inactive.
* @see Duration
* @return Returns a reference to this object so that method calls can be chained together.
* @see Duration
*/
Builder duration(String duration);
/**
*
* The duration to use when determining whether an endpoint is active or inactive.
*
*
* @param duration
* The duration to use when determining whether an endpoint is active or inactive.
* @see Duration
* @return Returns a reference to this object so that method calls can be chained together.
* @see Duration
*/
Builder duration(Duration duration);
/**
*
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active
* within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active
* within the specified duration are included in the segment.
*
*
* @param recencyType
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were
* active within the specified duration are included in the segment; and, INACTIVE, endpoints that
* weren't active within the specified duration are included in the segment.
* @see RecencyType
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecencyType
*/
Builder recencyType(String recencyType);
/**
*
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active
* within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active
* within the specified duration are included in the segment.
*
*
* @param recencyType
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were
* active within the specified duration are included in the segment; and, INACTIVE, endpoints that
* weren't active within the specified duration are included in the segment.
* @see RecencyType
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecencyType
*/
Builder recencyType(RecencyType recencyType);
}
static final class BuilderImpl implements Builder {
private String duration;
private String recencyType;
private BuilderImpl() {
}
private BuilderImpl(RecencyDimension model) {
duration(model.duration);
recencyType(model.recencyType);
}
public final String getDuration() {
return duration;
}
public final void setDuration(String duration) {
this.duration = duration;
}
@Override
public final Builder duration(String duration) {
this.duration = duration;
return this;
}
@Override
public final Builder duration(Duration duration) {
this.duration(duration == null ? null : duration.toString());
return this;
}
public final String getRecencyType() {
return recencyType;
}
public final void setRecencyType(String recencyType) {
this.recencyType = recencyType;
}
@Override
public final Builder recencyType(String recencyType) {
this.recencyType = recencyType;
return this;
}
@Override
public final Builder recencyType(RecencyType recencyType) {
this.recencyType(recencyType == null ? null : recencyType.toString());
return this;
}
@Override
public RecencyDimension build() {
return new RecencyDimension(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}