software.amazon.awssdk.services.sagemaker.model

Class Experiment

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Experiment

All Implemented Interfaces:

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

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

The properties of an experiment as returned by the Search API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Experiment.Builder

Method Summary

Modifier and Type	Method and Description
static Experiment.Builder	builder()
UserContext	createdBy() Returns the value of the CreatedBy property for this object.
Instant	creationTime() When the experiment was created.
String	description() The description of the experiment.
String	displayName() The name of the experiment as displayed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experimentArn() The Amazon Resource Name (ARN) of the experiment.
String	experimentName() The name of the experiment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
UserContext	lastModifiedBy() Returns the value of the LastModifiedBy property for this object.
Instant	lastModifiedTime() When the experiment was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends Experiment.Builder>	serializableBuilderClass()
ExperimentSource	source() Returns the value of the Source property for this object.
List<Tag>	tags() The list of tags that are associated with the experiment.
Experiment.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

experimentName

public final String experimentName()

The name of the experiment.

Returns:

The name of the experiment.

experimentArn

public final String experimentArn()

The Amazon Resource Name (ARN) of the experiment.

Returns:

The Amazon Resource Name (ARN) of the experiment.

displayName

public final String displayName()

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

Returns:

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

source

public final ExperimentSource source()

Returns the value of the Source property for this object.

Returns:

The value of the Source property for this object.

description

public final String description()

The description of the experiment.

Returns:

The description of the experiment.

creationTime

public final Instant creationTime()

When the experiment was created.

Returns:

When the experiment 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()

When the experiment was last modified.

Returns:

When the experiment was last modified.

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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

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

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

You can use hasTags() to see if a value was sent in this field.

Returns:

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

toBuilder

public Experiment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Experiment.Builder,Experiment>

builder

public static Experiment.Builder builder()

serializableBuilderClass

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