Package software.amazon.awssdk.services.cleanroomsml.model

Class GetTrainingDatasetResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse

software.amazon.awssdk.services.cleanroomsml.model.GetTrainingDatasetResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTrainingDatasetResponse.Builder,GetTrainingDatasetResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetTrainingDatasetResponse
extends CleanRoomsMlResponse
implements ToCopyableBuilder<GetTrainingDatasetResponse.Builder,GetTrainingDatasetResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetTrainingDatasetResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetTrainingDatasetResponse.Builder	builder()
Instant	createTime()	The time at which the training dataset was created.
String	description()	The description of the training dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTrainingData()	For responses, this returns true if the service returned a value for the TrainingData property.
String	name()	The name of the training dataset.
String	roleArn()	The IAM role used to read the training data.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTrainingDatasetResponse.Builder>	serializableBuilderClass()
TrainingDatasetStatus	status()	The status of the training dataset.
String	statusAsString()	The status of the training dataset.
Map<String,String>	tags()	The tags that are assigned to this training dataset.
GetTrainingDatasetResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<Dataset>	trainingData()	Metadata about the requested training data.
String	trainingDatasetArn()	The Amazon Resource Name (ARN) of the training dataset.
Instant	updateTime()	The most recent time at which the training dataset was updated.

Methods inherited from class software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

createTime

public final Instant createTime()

The time at which the training dataset was created.

Returns:

The time at which the training dataset was created.

updateTime

public final Instant updateTime()

The most recent time at which the training dataset was updated.

Returns:

The most recent time at which the training dataset was updated.

trainingDatasetArn

public final String trainingDatasetArn()

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

Returns:

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

name

public final String name()

The name of the training dataset.

Returns:

The name of the training dataset.

hasTrainingData

public final boolean hasTrainingData()

For responses, this returns true if the service returned a value for the TrainingData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

trainingData

public final List<Dataset> trainingData()

Metadata about the requested training data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrainingData() method.

Returns:

Metadata about the requested training data.

status

public final TrainingDatasetStatus status()

The status of the training dataset.

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

Returns:

The status of the training dataset.

See Also:

TrainingDatasetStatus

statusAsString

public final String statusAsString()

The status of the training dataset.

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

Returns:

The status of the training dataset.

See Also:

TrainingDatasetStatus

roleArn

public final String roleArn()

The IAM role used to read the training data.

Returns:

The IAM role used to read the training data.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The tags that are assigned to this training dataset.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags that are assigned to this training dataset.

description

public final String description()

The description of the training dataset.

Returns:

The description of the training dataset.

toBuilder

public GetTrainingDatasetResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTrainingDatasetResponse.Builder,GetTrainingDatasetResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetTrainingDatasetResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo