software.amazon.awssdk.services.pinpoint.model.SegmentGroup 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.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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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 the base segments and dimensions for a segment, and the relationships between these base segments and
* dimensions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SegmentGroup implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> DIMENSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Dimensions")
.getter(getter(SegmentGroup::dimensions))
.setter(setter(Builder::dimensions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SegmentDimensions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SOURCE_SEGMENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SourceSegments")
.getter(getter(SegmentGroup::sourceSegments))
.setter(setter(Builder::sourceSegments))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceSegments").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SegmentReference::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SOURCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceType").getter(getter(SegmentGroup::sourceTypeAsString)).setter(setter(Builder::sourceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceType").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(SegmentGroup::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIMENSIONS_FIELD,
SOURCE_SEGMENTS_FIELD, SOURCE_TYPE_FIELD, TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final List dimensions;
private final List sourceSegments;
private final String sourceType;
private final String type;
private SegmentGroup(BuilderImpl builder) {
this.dimensions = builder.dimensions;
this.sourceSegments = builder.sourceSegments;
this.sourceType = builder.sourceType;
this.type = builder.type;
}
/**
* For responses, this returns true if the service returned a value for the Dimensions 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 hasDimensions() {
return dimensions != null && !(dimensions instanceof SdkAutoConstructList);
}
/**
*
* An array that defines the dimensions for the segment.
*
*
* 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 #hasDimensions} method.
*
*
* @return An array that defines the dimensions for the segment.
*/
public final List dimensions() {
return dimensions;
}
/**
* For responses, this returns true if the service returned a value for the SourceSegments 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 hasSourceSegments() {
return sourceSegments != null && !(sourceSegments instanceof SdkAutoConstructList);
}
/**
*
* The base segment to build the segment on. A base segment, also referred to as a source segment, defines
* the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters
* the base segment by using the dimensions that you specify.
*
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an imported
* segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported
* segment without any filters applied to it.
*
*
* 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 #hasSourceSegments} method.
*
*
* @return The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon
* Pinpoint filters the base segment by using the dimensions that you specify.
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an
* imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of
* the imported segment without any filters applied to it.
*/
public final List sourceSegments() {
return sourceSegments;
}
/**
*
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments
* for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sourceType} will
* return {@link SourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sourceTypeAsString}.
*
*
* @return Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base
* segments.
* @see SourceType
*/
public final SourceType sourceType() {
return SourceType.fromValue(sourceType);
}
/**
*
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments
* for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sourceType} will
* return {@link SourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sourceTypeAsString}.
*
*
* @return Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base
* segments.
* @see SourceType
*/
public final String sourceTypeAsString() {
return sourceType;
}
/**
*
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the
* segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link Type#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions
* for the segment, whether the resulting segment includes endpoints that match all, any, or none of the
* dimensions.
* @see Type
*/
public final Type type() {
return Type.fromValue(type);
}
/**
*
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the
* segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link Type#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions
* for the segment, whether the resulting segment includes endpoints that match all, any, or none of the
* dimensions.
* @see Type
*/
public final String typeAsString() {
return type;
}
@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(hasDimensions() ? dimensions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSourceSegments() ? sourceSegments() : null);
hashCode = 31 * hashCode + Objects.hashCode(sourceTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
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 SegmentGroup)) {
return false;
}
SegmentGroup other = (SegmentGroup) obj;
return hasDimensions() == other.hasDimensions() && Objects.equals(dimensions(), other.dimensions())
&& hasSourceSegments() == other.hasSourceSegments() && Objects.equals(sourceSegments(), other.sourceSegments())
&& Objects.equals(sourceTypeAsString(), other.sourceTypeAsString())
&& Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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("SegmentGroup").add("Dimensions", hasDimensions() ? dimensions() : null)
.add("SourceSegments", hasSourceSegments() ? sourceSegments() : null).add("SourceType", sourceTypeAsString())
.add("Type", typeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "SourceSegments":
return Optional.ofNullable(clazz.cast(sourceSegments()));
case "SourceType":
return Optional.ofNullable(clazz.cast(sourceTypeAsString()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SegmentGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array that defines the dimensions for the segment.
*
*
* @param dimensions
* An array that defines the dimensions for the segment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(Collection dimensions);
/**
*
* An array that defines the dimensions for the segment.
*
*
* @param dimensions
* An array that defines the dimensions for the segment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(SegmentDimensions... dimensions);
/**
*
* An array that defines the dimensions for the segment.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentDimensions.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.pinpoint.model.SegmentDimensions#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentDimensions.Builder#build()} is called
* immediately and its result is passed to {@link #dimensions(List)}.
*
* @param dimensions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentDimensions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensions(java.util.Collection)
*/
Builder dimensions(Consumer... dimensions);
/**
*
* The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon
* Pinpoint filters the base segment by using the dimensions that you specify.
*
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an imported
* segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported
* segment without any filters applied to it.
*
*
* @param sourceSegments
* The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment,
* Amazon Pinpoint filters the base segment by using the dimensions that you specify.
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an
* imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size
* of the imported segment without any filters applied to it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceSegments(Collection sourceSegments);
/**
*
* The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon
* Pinpoint filters the base segment by using the dimensions that you specify.
*
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an imported
* segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported
* segment without any filters applied to it.
*
*
* @param sourceSegments
* The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment,
* Amazon Pinpoint filters the base segment by using the dimensions that you specify.
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an
* imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size
* of the imported segment without any filters applied to it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceSegments(SegmentReference... sourceSegments);
/**
*
* The base segment to build the segment on. A base segment, also referred to as a source segment,
* defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon
* Pinpoint filters the base segment by using the dimensions that you specify.
*
*
* You can specify more than one dimensional segment or only one imported segment. If you specify an imported
* segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported
* segment without any filters applied to it.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentReference.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.pinpoint.model.SegmentReference#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentReference.Builder#build()} is called immediately
* and its result is passed to {@link #sourceSegments(List)}.
*
* @param sourceSegments
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpoint.model.SegmentReference.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sourceSegments(java.util.Collection)
*/
Builder sourceSegments(Consumer... sourceSegments);
/**
*
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*
*
* @param sourceType
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base
* segments.
* @see SourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
Builder sourceType(String sourceType);
/**
*
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*
*
* @param sourceType
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base
* segments for the segment, whether the resulting segment is based on all, any, or none of the base
* segments.
* @see SourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
Builder sourceType(SourceType sourceType);
/**
*
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for
* the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*
*
* @param type
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three
* dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or
* none of the dimensions.
* @see Type
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
Builder type(String type);
/**
*
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for
* the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*
*
* @param type
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three
* dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or
* none of the dimensions.
* @see Type
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
Builder type(Type type);
}
static final class BuilderImpl implements Builder {
private List dimensions = DefaultSdkAutoConstructList.getInstance();
private List sourceSegments = DefaultSdkAutoConstructList.getInstance();
private String sourceType;
private String type;
private BuilderImpl() {
}
private BuilderImpl(SegmentGroup model) {
dimensions(model.dimensions);
sourceSegments(model.sourceSegments);
sourceType(model.sourceType);
type(model.type);
}
public final List getDimensions() {
List result = ListOfSegmentDimensionsCopier.copyToBuilder(this.dimensions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDimensions(Collection dimensions) {
this.dimensions = ListOfSegmentDimensionsCopier.copyFromBuilder(dimensions);
}
@Override
public final Builder dimensions(Collection dimensions) {
this.dimensions = ListOfSegmentDimensionsCopier.copy(dimensions);
return this;
}
@Override
@SafeVarargs
public final Builder dimensions(SegmentDimensions... dimensions) {
dimensions(Arrays.asList(dimensions));
return this;
}
@Override
@SafeVarargs
public final Builder dimensions(Consumer... dimensions) {
dimensions(Stream.of(dimensions).map(c -> SegmentDimensions.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getSourceSegments() {
List result = ListOfSegmentReferenceCopier.copyToBuilder(this.sourceSegments);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSourceSegments(Collection sourceSegments) {
this.sourceSegments = ListOfSegmentReferenceCopier.copyFromBuilder(sourceSegments);
}
@Override
public final Builder sourceSegments(Collection sourceSegments) {
this.sourceSegments = ListOfSegmentReferenceCopier.copy(sourceSegments);
return this;
}
@Override
@SafeVarargs
public final Builder sourceSegments(SegmentReference... sourceSegments) {
sourceSegments(Arrays.asList(sourceSegments));
return this;
}
@Override
@SafeVarargs
public final Builder sourceSegments(Consumer... sourceSegments) {
sourceSegments(Stream.of(sourceSegments).map(c -> SegmentReference.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getSourceType() {
return sourceType;
}
public final void setSourceType(String sourceType) {
this.sourceType = sourceType;
}
@Override
public final Builder sourceType(String sourceType) {
this.sourceType = sourceType;
return this;
}
@Override
public final Builder sourceType(SourceType sourceType) {
this.sourceType(sourceType == null ? null : sourceType.toString());
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(Type type) {
this.type(type == null ? null : type.toString());
return this;
}
@Override
public SegmentGroup build() {
return new SegmentGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}