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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DatasetGroup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DatasetGroup.Builder`	`builder()`
`Instant`	`creationDateTime()`	The creation date and time (in Unix time) of the dataset group.
`String`	`datasetGroupArn()`	The Amazon Resource Name (ARN) of the dataset group.
`Domain`	`domain()`	The domain of a Domain dataset group.
`String`	`domainAsString()`	The domain of a Domain dataset group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	If creating a dataset group fails, provides the reason why.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKeyArn()`	The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
`Instant`	`lastUpdatedDateTime()`	The last update date and time (in Unix time) of the dataset group.
`String`	`name()`	The name of the dataset group.
`String`	`roleArn()`	The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DatasetGroup.Builder>`	`serializableBuilderClass()`
`String`	`status()`	The current status of the dataset group.
`DatasetGroup.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
  - 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:
    
    Domain
  - 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:
    
    Domain
  - toBuilder
```
public DatasetGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DatasetGroup.Builder,DatasetGroup>
  - 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)
```
    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

Class DatasetGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

datasetGroupArn

status

roleArn

kmsKeyArn

creationDateTime

lastUpdatedDateTime

failureReason

domain

domainAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField