software.amazon.awssdk.services.pinpoint.model.AttributeDimension Maven / Gradle / Ivy
Show all versions of pinpoint Show documentation
/*
* Copyright 2014-2019 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.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies attribute-based criteria for including or excluding endpoints from a segment.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AttributeDimension implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ATTRIBUTE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(AttributeDimension::attributeTypeAsString)).setter(setter(Builder::attributeType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttributeType").build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(AttributeDimension::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTE_TYPE_FIELD,
VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final String attributeType;
private final List values;
private AttributeDimension(BuilderImpl builder) {
this.attributeType = builder.attributeType;
this.values = builder.values;
}
/**
*
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included
* in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attributeType}
* will return {@link AttributeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #attributeTypeAsString}.
*
*
* @return The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are
* included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
* @see AttributeType
*/
public AttributeType attributeType() {
return AttributeType.fromValue(attributeType);
}
/**
*
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included
* in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attributeType}
* will return {@link AttributeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #attributeTypeAsString}.
*
*
* @return The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are
* included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
* @see AttributeType
*/
public String attributeTypeAsString() {
return attributeType;
}
/**
*
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType property,
* endpoints are included or excluded from the segment if their attribute values match the criteria values.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The criteria values to use for the segment dimension. Depending on the value of the AttributeType
* property, endpoints are included or excluded from the segment if their attribute values match the
* criteria values.
*/
public List values() {
return values;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(attributeTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(values());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AttributeDimension)) {
return false;
}
AttributeDimension other = (AttributeDimension) obj;
return Objects.equals(attributeTypeAsString(), other.attributeTypeAsString()) && Objects.equals(values(), other.values());
}
/**
* 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 String toString() {
return ToString.builder("AttributeDimension").add("AttributeType", attributeTypeAsString()).add("Values", values())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AttributeType":
return Optional.ofNullable(clazz.cast(attributeTypeAsString()));
case "Values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AttributeDimension) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are
* included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*
*
* @param attributeType
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria
* are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the
* segment.
* @see AttributeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AttributeType
*/
Builder attributeType(String attributeType);
/**
*
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are
* included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*
*
* @param attributeType
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria
* are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the
* segment.
* @see AttributeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AttributeType
*/
Builder attributeType(AttributeType attributeType);
/**
*
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType property,
* endpoints are included or excluded from the segment if their attribute values match the criteria values.
*
*
* @param values
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType
* property, endpoints are included or excluded from the segment if their attribute values match the
* criteria values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType property,
* endpoints are included or excluded from the segment if their attribute values match the criteria values.
*
*
* @param values
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType
* property, endpoints are included or excluded from the segment if their attribute values match the
* criteria values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(String... values);
}
static final class BuilderImpl implements Builder {
private String attributeType;
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AttributeDimension model) {
attributeType(model.attributeType);
values(model.values);
}
public final String getAttributeTypeAsString() {
return attributeType;
}
@Override
public final Builder attributeType(String attributeType) {
this.attributeType = attributeType;
return this;
}
@Override
public final Builder attributeType(AttributeType attributeType) {
this.attributeType(attributeType == null ? null : attributeType.toString());
return this;
}
public final void setAttributeType(String attributeType) {
this.attributeType = attributeType;
}
public final Collection getValues() {
return values;
}
@Override
public final Builder values(Collection values) {
this.values = ListOf__stringCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(String... values) {
values(Arrays.asList(values));
return this;
}
public final void setValues(Collection values) {
this.values = ListOf__stringCopier.copy(values);
}
@Override
public AttributeDimension build() {
return new AttributeDimension(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}