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:

  • Method Details

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.