Package software.amazon.awssdk.services.sagemaker.model

Interface Experiment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Experiment.Builder,Experiment>, SdkBuilder<Experiment.Builder,Experiment>, SdkPojo

Enclosing class:

Experiment

public static interface Experiment.Builder
extends SdkPojo, CopyableBuilder<Experiment.Builder,Experiment>

Method Summary

Modifier and Type	Method	Description
default Experiment.Builder	createdBy(Consumer<UserContext.Builder> createdBy)	Who created the experiment.
Experiment.Builder	createdBy(UserContext createdBy)	Who created the experiment.
Experiment.Builder	creationTime(Instant creationTime)	When the experiment was created.
Experiment.Builder	description(String description)	The description of the experiment.
Experiment.Builder	displayName(String displayName)	The name of the experiment as displayed.
Experiment.Builder	experimentArn(String experimentArn)	The Amazon Resource Name (ARN) of the experiment.
Experiment.Builder	experimentName(String experimentName)	The name of the experiment.
default Experiment.Builder	lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy)	Sets the value of the LastModifiedBy property for this object.
Experiment.Builder	lastModifiedBy(UserContext lastModifiedBy)	Sets the value of the LastModifiedBy property for this object.
Experiment.Builder	lastModifiedTime(Instant lastModifiedTime)	When the experiment was last modified.
default Experiment.Builder	source(Consumer<ExperimentSource.Builder> source)	Sets the value of the Source property for this object.
Experiment.Builder	source(ExperimentSource source)	Sets the value of the Source property for this object.
Experiment.Builder	tags(Collection<Tag> tags)	The list of tags that are associated with the experiment.
Experiment.Builder	tags(Consumer<Tag.Builder>... tags)	The list of tags that are associated with the experiment.
Experiment.Builder	tags(Tag... tags)	The list of tags that are associated with the experiment.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

experimentName

Experiment.Builder experimentName(String experimentName)

The name of the experiment.

Parameters:

experimentName - The name of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

experimentArn

Experiment.Builder experimentArn(String experimentArn)

The Amazon Resource Name (ARN) of the experiment.

Parameters:

experimentArn - The Amazon Resource Name (ARN) of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayName

Experiment.Builder displayName(String displayName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

source

Experiment.Builder source(ExperimentSource source)

Sets the value of the Source property for this object.

Parameters:

source - The new value for the Source property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default Experiment.Builder source(Consumer<ExperimentSource.Builder> source)

Sets the value of the Source property for this object. This is a convenience method that creates an instance of the ExperimentSource.Builder avoiding the need to create one manually via ExperimentSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(ExperimentSource).

Parameters:

source - a consumer that will call methods on ExperimentSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

source(ExperimentSource)

description

Experiment.Builder description(String description)

The description of the experiment.

Parameters:

description - The description of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

Experiment.Builder creationTime(Instant creationTime)

When the experiment was created.

Parameters:

creationTime - When the experiment was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

Experiment.Builder createdBy(UserContext createdBy)

Who created the experiment.

Parameters:

createdBy - Who created the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

default Experiment.Builder createdBy(Consumer<UserContext.Builder> createdBy)

Who created the experiment.

This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdBy(UserContext).

Parameters:

createdBy - a consumer that will call methods on UserContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

createdBy(UserContext)

lastModifiedTime

Experiment.Builder lastModifiedTime(Instant lastModifiedTime)

When the experiment was last modified.

Parameters:

lastModifiedTime - When the experiment was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedBy

Experiment.Builder lastModifiedBy(UserContext lastModifiedBy)

Sets the value of the LastModifiedBy property for this object.

Parameters:

lastModifiedBy - The new value for the LastModifiedBy property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedBy

default Experiment.Builder lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy)

Sets the value of the LastModifiedBy property for this object. This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastModifiedBy(UserContext).

Parameters:

lastModifiedBy - a consumer that will call methods on UserContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lastModifiedBy(UserContext)

tags

Experiment.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Experiment.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Experiment.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)