Package software.amazon.awssdk.services.personalize.model

Class SolutionVersionSummary

java.lang.Object

software.amazon.awssdk.services.personalize.model.SolutionVersionSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SolutionVersionSummary.Builder,SolutionVersionSummary>

@Generated("software.amazon.awssdk:codegen")
public final class SolutionVersionSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SolutionVersionSummary.Builder,SolutionVersionSummary>

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SolutionVersionSummary.Builder

Method Summary

Modifier and Type	Method	Description
static SolutionVersionSummary.Builder	builder()
Instant	creationDateTime()	The date and time (in Unix time) that this version of a solution was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	If a solution version fails, the reason behind the failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDateTime()	The date and time (in Unix time) that the solution version was last updated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SolutionVersionSummary.Builder>	serializableBuilderClass()
String	solutionVersionArn()	The Amazon Resource Name (ARN) of the solution version.
String	status()	The status of the solution version.
SolutionVersionSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TrainingMode	trainingMode()	The scope of training to be performed when creating the solution version.
String	trainingModeAsString()	The scope of training to be performed when creating the solution version.
TrainingType	trainingType()	Whether the solution version was created automatically or manually.
String	trainingTypeAsString()	Whether the solution version was created automatically or manually.

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

solutionVersionArn

public final String solutionVersionArn()

The Amazon Resource Name (ARN) of the solution version.

Returns:

The Amazon Resource Name (ARN) of the solution version.

status

public final String status()

The status of the solution version.

A solution version can be in one of the following states:

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

Returns:

The status of the solution version.

A solution version can be in one of the following states:

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

trainingMode

public final TrainingMode trainingMode()

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

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

Returns:

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

See Also:

TrainingMode

trainingModeAsString

public final String trainingModeAsString()

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

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

Returns:

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

See Also:

TrainingMode

trainingType

public final TrainingType trainingType()

Whether the solution version was created automatically or manually.

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

Returns:

Whether the solution version was created automatically or manually.

See Also:

TrainingType

trainingTypeAsString

public final String trainingTypeAsString()

Whether the solution version was created automatically or manually.

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

Returns:

Whether the solution version was created automatically or manually.

See Also:

TrainingType

creationDateTime

public final Instant creationDateTime()

The date and time (in Unix time) that this version of a solution was created.

Returns:

The date and time (in Unix time) that this version of a solution was created.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The date and time (in Unix time) that the solution version was last updated.

Returns:

The date and time (in Unix time) that the solution version was last updated.

failureReason

public final String failureReason()

If a solution version fails, the reason behind the failure.

Returns:

If a solution version fails, the reason behind the failure.

toBuilder

public SolutionVersionSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SolutionVersionSummary.Builder,SolutionVersionSummary>

builder

public static SolutionVersionSummary.Builder builder()

serializableBuilderClass

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