software.amazon.awssdk.services.pinpoint.model.EventDimensions 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.HashMap;
import java.util.List;
import java.util.Map;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is
* performed.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EventDimensions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Attributes")
.getter(getter(EventDimensions::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeDimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField EVENT_TYPE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("EventType").getter(getter(EventDimensions::eventType)).setter(setter(Builder::eventType))
.constructor(SetDimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventType").build()).build();
private static final SdkField> METRICS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Metrics")
.getter(getter(EventDimensions::metrics))
.setter(setter(Builder::metrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Metrics").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MetricDimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTES_FIELD,
EVENT_TYPE_FIELD, METRICS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Attributes", ATTRIBUTES_FIELD);
put("EventType", EVENT_TYPE_FIELD);
put("Metrics", METRICS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final Map attributes;
private final SetDimension eventType;
private final Map metrics;
private EventDimensions(BuilderImpl builder) {
this.attributes = builder.attributes;
this.eventType = builder.eventType;
this.metrics = builder.metrics;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as
* selection criteria when you create an event filter.
*
*
* 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 #hasAttributes} method.
*
*
* @return One or more custom attributes that your application reports to Amazon Pinpoint. You can use these
* attributes as selection criteria when you create an event filter.
*/
public final Map attributes() {
return attributes;
}
/**
*
* The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a
* standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom
* event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint
* Events in the Amazon Pinpoint Developer Guide.
*
*
* @return The name of the event that causes the campaign to be sent or the journey activity to be performed. This
* can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can
* also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon
* Pinpoint Events in the Amazon Pinpoint Developer Guide.
*/
public final SetDimension eventType() {
return eventType;
}
/**
* For responses, this returns true if the service returned a value for the Metrics 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 hasMetrics() {
return metrics != null && !(metrics instanceof SdkAutoConstructMap);
}
/**
*
* One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
* selection criteria when you create an event filter.
*
*
* 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 #hasMetrics} method.
*
*
* @return One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
* selection criteria when you create an event filter.
*/
public final Map metrics() {
return metrics;
}
@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(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(eventType());
hashCode = 31 * hashCode + Objects.hashCode(hasMetrics() ? metrics() : 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 EventDimensions)) {
return false;
}
EventDimensions other = (EventDimensions) obj;
return hasAttributes() == other.hasAttributes() && Objects.equals(attributes(), other.attributes())
&& Objects.equals(eventType(), other.eventType()) && hasMetrics() == other.hasMetrics()
&& Objects.equals(metrics(), other.metrics());
}
/**
* 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("EventDimensions").add("Attributes", hasAttributes() ? attributes() : null)
.add("EventType", eventType()).add("Metrics", hasMetrics() ? metrics() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "EventType":
return Optional.ofNullable(clazz.cast(eventType()));
case "Metrics":
return Optional.ofNullable(clazz.cast(metrics()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((EventDimensions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes
* as selection criteria when you create an event filter.
*
*
* @param attributes
* One or more custom attributes that your application reports to Amazon Pinpoint. You can use these
* attributes as selection criteria when you create an event filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* The name of the event that causes the campaign to be sent or the journey activity to be performed. This can
* be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be
* a custom event that's specific to your application. For information about standard events, see Streaming Amazon
* Pinpoint Events in the Amazon Pinpoint Developer Guide.
*
*
* @param eventType
* The name of the event that causes the campaign to be sent or the journey activity to be performed.
* This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns,
* this can also be a custom event that's specific to your application. For information about standard
* events, see Streaming Amazon
* Pinpoint Events in the Amazon Pinpoint Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventType(SetDimension eventType);
/**
*
* The name of the event that causes the campaign to be sent or the journey activity to be performed. This can
* be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be
* a custom event that's specific to your application. For information about standard events, see Streaming Amazon
* Pinpoint Events in the Amazon Pinpoint Developer Guide.
*
* This is a convenience method that creates an instance of the {@link SetDimension.Builder} avoiding the need
* to create one manually via {@link SetDimension#builder()}.
*
*
* When the {@link Consumer} completes, {@link SetDimension.Builder#build()} is called immediately and its
* result is passed to {@link #eventType(SetDimension)}.
*
* @param eventType
* a consumer that will call methods on {@link SetDimension.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #eventType(SetDimension)
*/
default Builder eventType(Consumer eventType) {
return eventType(SetDimension.builder().applyMutation(eventType).build());
}
/**
*
* One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
* selection criteria when you create an event filter.
*
*
* @param metrics
* One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics
* as selection criteria when you create an event filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metrics(Map metrics);
}
static final class BuilderImpl implements Builder {
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private SetDimension eventType;
private Map metrics = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(EventDimensions model) {
attributes(model.attributes);
eventType(model.eventType);
metrics(model.metrics);
}
public final Map getAttributes() {
Map result = MapOfAttributeDimensionCopier.copyToBuilder(this.attributes);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setAttributes(Map attributes) {
this.attributes = MapOfAttributeDimensionCopier.copyFromBuilder(attributes);
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = MapOfAttributeDimensionCopier.copy(attributes);
return this;
}
public final SetDimension.Builder getEventType() {
return eventType != null ? eventType.toBuilder() : null;
}
public final void setEventType(SetDimension.BuilderImpl eventType) {
this.eventType = eventType != null ? eventType.build() : null;
}
@Override
public final Builder eventType(SetDimension eventType) {
this.eventType = eventType;
return this;
}
public final Map getMetrics() {
Map result = MapOfMetricDimensionCopier.copyToBuilder(this.metrics);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setMetrics(Map metrics) {
this.metrics = MapOfMetricDimensionCopier.copyFromBuilder(metrics);
}
@Override
public final Builder metrics(Map metrics) {
this.metrics = MapOfMetricDimensionCopier.copy(metrics);
return this;
}
@Override
public EventDimensions build() {
return new EventDimensions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}