• Home
• software.amazon.awssdk
• pinpoint
• 2.28.11
• source code
• AttributeDimension.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

software.amazon.awssdk.services.pinpoint.model.AttributeDimension 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.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.core.util.SdkAutoConstructList;
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)
            .memberName("AttributeType").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)
            .memberName("Values")
            .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 have attributes matching the values are included in the segment.
     * 
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
     * 
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
     * 
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
     * segment.
     * 
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
     * 
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is
     * ignored in this comparison.
     * 
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 have attributes matching the values are included in the segment.
     *         
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
     *         
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
     *         
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
     *         segment.
     *         
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the
     *         segment.
     *         
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment.
     *         Time is ignored in this comparison.
     *         
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in
     *         the segment.
     * @see AttributeType
     */
    public final AttributeType attributeType() {
        return AttributeType.fromValue(attributeType);
    }

    /**
     * 

     * The type of segment dimension to use. Valid values are:
     * 

     * 
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
     * 
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
     * 
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
     * 
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
     * segment.
     * 
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
     * 
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is
     * ignored in this comparison.
     * 
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 have attributes matching the values are included in the segment.
     *         
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
     *         
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
     *         
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
     *         segment.
     *         
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the
     *         segment.
     *         
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment.
     *         Time is ignored in this comparison.
     *         
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in
     *         the segment.
     * @see AttributeType
     */
    public final String attributeTypeAsString() {
        return attributeType;
    }

    /**
     * For responses, this returns true if the service returned a value for the Values property. This DOES NOT check
     * that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
     * useful because the SDK will never return a null collection or map, but you may need to differentiate between the
     * service returning nothing (or null) and the service returning an empty collection or map. For requests, this
     * returns true if a value for the property was specified in the request builder, and false if a value was not
     * specified.
     */
    public final boolean hasValues() {
        return values != null && !(values instanceof SdkAutoConstructList);
    }

    /**
     * 

     * 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.
     * 
     * 

     * This method will never return null. If you would like to know whether the service returned this field (so that
     * you can differentiate between null and empty), you can use the {@link #hasValues} method.
     * 
     * 
     * @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 final 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 final int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + Objects.hashCode(attributeTypeAsString());
        hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : null);
        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 AttributeDimension)) {
            return false;
        }
        AttributeDimension other = (AttributeDimension) obj;
        return Objects.equals(attributeTypeAsString(), other.attributeTypeAsString()) && hasValues() == other.hasValues()
                && 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 final String toString() {
        return ToString.builder("AttributeDimension").add("AttributeType", attributeTypeAsString())
                .add("Values", hasValues() ? values() : null).build();
    }

    public final  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 final 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 have attributes matching the values are included in the segment.
         * 
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
         * 
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
         * 
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
         * segment.
         * 
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the
         * segment.
         * 
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time
         * is ignored in this comparison.
         * 
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the
         * segment.
         * 

         * 
         * @param attributeType
         *        The type of segment dimension to use. Valid values are:
         *        

         *        
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
         *        
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
         *        
CONTAINS - endpoints that have attributes' substrings match the values are included in the
         *        segment.
         *        
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in
         *        the segment.
         *        
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in
         *        the segment.
         *        
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment.
         *        Time is ignored in this comparison.
         *        
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included
         *        in 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 have attributes matching the values are included in the segment.
         * 
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
         * 
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
         * 
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the
         * segment.
         * 
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the
         * segment.
         * 
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time
         * is ignored in this comparison.
         * 
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the
         * segment.
         * 

         * 
         * @param attributeType
         *        The type of segment dimension to use. Valid values are:
         *        

         *        
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
         *        
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
         *        
CONTAINS - endpoints that have attributes' substrings match the values are included in the
         *        segment.
         *        
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in
         *        the segment.
         *        
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in
         *        the segment.
         *        
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment.
         *        Time is ignored in this comparison.
         *        
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included
         *        in 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 getAttributeType() {
            return attributeType;
        }

        public final void setAttributeType(String attributeType) {
            this.attributeType = 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 Collection getValues() {
            if (values instanceof SdkAutoConstructList) {
                return null;
            }
            return values;
        }

        public final void setValues(Collection values) {
            this.values = ListOf__stringCopier.copy(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;
        }

        @Override
        public AttributeDimension build() {
            return new AttributeDimension(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}