software.amazon.awssdk.services.sagemaker.model

Class Trial

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Trial

All Implemented Interfaces:

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

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

The properties of a trial as returned by the Search API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Trial.Builder

Method Summary

Modifier and Type	Method and Description
static Trial.Builder	builder()
UserContext	createdBy() Returns the value of the CreatedBy property for this object.
Instant	creationTime() When the trial was created.
String	displayName() The name of the trial as displayed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experimentName() The name of the experiment the trial is part of.
<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	hasTrialComponentSummaries() For responses, this returns true if the service returned a value for the TrialComponentSummaries property.
UserContext	lastModifiedBy() Returns the value of the LastModifiedBy property for this object.
Instant	lastModifiedTime() Who last modified the trial.
MetadataProperties	metadataProperties() Returns the value of the MetadataProperties property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends Trial.Builder>	serializableBuilderClass()
TrialSource	source() Returns the value of the Source property for this object.
List<Tag>	tags() The list of tags that are associated with the trial.
Trial.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	trialArn() The Amazon Resource Name (ARN) of the trial.
List<TrialComponentSimpleSummary>	trialComponentSummaries() A list of the components associated with the trial.
String	trialName() The name of the trial.

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

trialName

public final String trialName()

The name of the trial.

Returns:

The name of the trial.

trialArn

public final String trialArn()

The Amazon Resource Name (ARN) of the trial.

Returns:

The Amazon Resource Name (ARN) of the trial.

displayName

public final String displayName()

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

Returns:

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

experimentName

public final String experimentName()

The name of the experiment the trial is part of.

Returns:

The name of the experiment the trial is part of.

source

public final TrialSource source()

Returns the value of the Source property for this object.

Returns:

The value of the Source property for this object.

creationTime

public final Instant creationTime()

When the trial was created.

Returns:

When the trial was created.

createdBy

public final UserContext createdBy()

Returns the value of the CreatedBy property for this object.

Returns:

The value of the CreatedBy property for this object.

lastModifiedTime

public final Instant lastModifiedTime()

Who last modified the trial.

Returns:

Who last modified the trial.

lastModifiedBy

public final UserContext lastModifiedBy()

Returns the value of the LastModifiedBy property for this object.

Returns:

The value of the LastModifiedBy property for this object.

metadataProperties

public final MetadataProperties metadataProperties()

Returns the value of the MetadataProperties property for this object.

Returns:

The value of the MetadataProperties property for this object.

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 List<Tag> tags()

The list of tags that are associated with the trial. You can use Search API to search on the tags.

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 list of tags that are associated with the trial. You can use Search API to search on the tags.

hasTrialComponentSummaries

public final boolean hasTrialComponentSummaries()

For responses, this returns true if the service returned a value for the TrialComponentSummaries 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.

trialComponentSummaries

public final List<TrialComponentSimpleSummary> trialComponentSummaries()

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

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 hasTrialComponentSummaries() method.

Returns:

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

toBuilder

public Trial.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Trial.Builder,Trial>

builder

public static Trial.Builder builder()

serializableBuilderClass

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