Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AnalyticsMetadataType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AnalyticsMetadataType

All Implemented Interfaces:

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

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

Information that your application adds to authentication requests. Applies an endpoint ID to the analytics data that your user pool sends to Amazon Pinpoint.

An endpoint ID uniquely identifies a mobile device, email address or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

This data type is a request parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyticsMetadataType.Builder

Method Summary

Modifier and Type	Method	Description
String	analyticsEndpointId()	The endpoint ID.
static AnalyticsMetadataType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsMetadataType.Builder>	serializableBuilderClass()
AnalyticsMetadataType.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

analyticsEndpointId

public final String analyticsEndpointId()

The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.

Returns:

The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.

toBuilder

public AnalyticsMetadataType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsMetadataType.Builder,AnalyticsMetadataType>

builder

public static AnalyticsMetadataType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo