Class DatasetGroup

java.lang.Object
software.amazon.awssdk.services.personalize.model.DatasetGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetGroup.Builder,DatasetGroup>
@Generated("software.amazon.awssdk:codegen") public final class DatasetGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetGroup.Builder,DatasetGroup>

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the dataset group.

      Returns:
      The name of the dataset group.

    • datasetGroupArn

      public final String datasetGroupArn()

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

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

    • status

      public final String status()

      The current status of the dataset group.

      A dataset group can be in one of the following states:

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

      • DELETE PENDING

      Returns:
      The current status of the dataset group.

      A dataset group can be in one of the following states:

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

      • DELETE PENDING

    • roleArn

      public final String roleArn()

      The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

      Returns:
      The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

      Returns:
      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

    • creationDateTime

      public final Instant creationDateTime()

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

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

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The last update date and time (in Unix time) of the dataset group.

      Returns:
      The last update date and time (in Unix time) of the dataset group.

    • failureReason

      public final String failureReason()

      If creating a dataset group fails, provides the reason why.

      Returns:
      If creating a dataset group fails, provides the reason why.

    • domain

      public final Domain domain()

      The domain of a Domain dataset group.

      If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

      Returns:
      The domain of a Domain dataset group.
      See Also:

    • domainAsString

      public final String domainAsString()

      The domain of a Domain dataset group.

      If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

      Returns:
      The domain of a Domain dataset group.
      See Also:

    • toBuilder

      public DatasetGroup.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<DatasetGroup.Builder,DatasetGroup>
      Returns:
      a builder for type T

    • builder

      public static DatasetGroup.Builder builder()

    • serializableBuilderClass

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