software.amazon.awssdk.services.pinpoint.model

Class EventDimensions

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EventDimensions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EventDimensions.Builder,EventDimensions>

@Generated(value="software.amazon.awssdk:codegen")
public final class EventDimensions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventDimensions.Builder,EventDimensions>

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventDimensions.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AttributeDimension>	attributes() One or more custom attributes that your application reports to Amazon Pinpoint.
static EventDimensions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SetDimension	eventType() The name of the event that causes the campaign to be sent or the journey activity to be performed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,MetricDimension>	metrics() One or more custom metrics that your application reports to Amazon Pinpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends EventDimensions.Builder>	serializableBuilderClass()
EventDimensions.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAttributes

public boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public Map<String,AttributeDimension> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

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.

eventType

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

Returns:

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.

hasMetrics

public boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public Map<String,MetricDimension> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

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.

toBuilder

public EventDimensions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventDimensions.Builder,EventDimensions>

builder

public static EventDimensions.Builder builder()

serializableBuilderClass

public static Class<? extends EventDimensions.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo