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

Class Dataset

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Dataset.Builder,Dataset>

@Generated("software.amazon.awssdk:codegen")
public class Dataset
extends Object
implements StructuredPojo, 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.

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()
Date	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)
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.
Date	lastModifiedDate()	Date when the dataset was last modified.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Long	numRecords()	Number of records in this dataset.
static Class<? extends Dataset.Builder>	serializableBuilderClass()
Dataset.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

identityId

public 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 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 Date creationDate()

Date on which the dataset was created.

Returns:

Date on which the dataset was created.

lastModifiedDate

public Date lastModifiedDate()

Date when the dataset was last modified.

Returns:

Date when the dataset was last modified.

lastModifiedBy

public 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 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 Long numRecords()

Number of records in this dataset.

Returns:

Number of records in this dataset.

toBuilder

public Dataset.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Dataset.Builder,Dataset>

Returns:

a builder for type T

builder

public static Dataset.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.