Package software.amazon.awssdk.services.cognitosync.model

Class Dataset

java.lang.Object

software.amazon.awssdk.services.cognitosync.model.Dataset

All Implemented Interfaces:

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

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

A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Dataset.Builder

Method Summary

Modifier and Type	Method	Description
static Dataset.Builder	builder()
Instant	creationDate()	Date on which the dataset was created.
String	datasetName()	A string of up to 128 characters.
Long	dataStorage()	Total size in bytes of the records in this dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityId()	A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	lastModifiedBy()	The device that made the last change to this dataset.
Instant	lastModifiedDate()	Date when the dataset was last modified.
Long	numRecords()	Number of records in this dataset.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Dataset.Builder>	serializableBuilderClass()
Dataset.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

identityId

public final String identityId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

datasetName

public final String datasetName()

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Returns:

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

creationDate

public final Instant creationDate()

Date on which the dataset was created.

Returns:

Date on which the dataset was created.

lastModifiedDate

public final Instant lastModifiedDate()

Date when the dataset was last modified.

Returns:

Date when the dataset was last modified.

lastModifiedBy

public final String lastModifiedBy()

The device that made the last change to this dataset.

Returns:

The device that made the last change to this dataset.

dataStorage

public final Long dataStorage()

Total size in bytes of the records in this dataset.

Returns:

Total size in bytes of the records in this dataset.

numRecords

public final Long numRecords()

Number of records in this dataset.

Returns:

Number of records in this dataset.

toBuilder

public Dataset.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Dataset.Builder,Dataset>

builder

public static Dataset.Builder builder()

serializableBuilderClass

public static Class<? extends Dataset.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