Class Dataset

java.lang.Object
software.amazon.awssdk.services.personalize.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>

Provides metadata for a dataset.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset that you want metadata for.

      Returns:
      The Amazon Resource Name (ARN) of the dataset that you want metadata for.

    • datasetGroupArn

      public final String datasetGroupArn()

      The Amazon Resource Name (ARN) of the dataset group.

      Returns:
      The Amazon Resource Name (ARN) of the dataset group.

    • datasetType

      public final String datasetType()

      One of the following values:

      • Interactions

      • Items

      • Users

      • Actions

      • Action_Interactions

      Returns:
      One of the following values:

      • Interactions

      • Items

      • Users

      • Actions

      • Action_Interactions

    • schemaArn

      public final String schemaArn()

      The ARN of the associated schema.

      Returns:
      The ARN of the associated schema.

    • status

      public final String status()

      The status of the dataset.

      A dataset can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

      Returns:
      The status of the dataset.

      A dataset can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

    • creationDateTime

      public final Instant creationDateTime()

      The creation date and time (in Unix time) of the dataset.

      Returns:
      The creation date and time (in Unix time) of the dataset.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      A time stamp that shows when the dataset was updated.

      Returns:
      A time stamp that shows when the dataset was updated.

    • latestDatasetUpdate

      public final DatasetUpdateSummary latestDatasetUpdate()

      Describes the latest update to the dataset.

      Returns:
      Describes the latest update to the dataset.

    • trackingId

      public final String trackingId()

      The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

      Returns:
      The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.