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

Interface TrialComponent.Builder

All Superinterfaces:

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

Enclosing class:

TrialComponent

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

Method Summary

Modifier and Type	Method	Description
default TrialComponent.Builder	createdBy(Consumer<UserContext.Builder> createdBy)	Who created the trial component.
TrialComponent.Builder	createdBy(UserContext createdBy)	Who created the trial component.
TrialComponent.Builder	creationTime(Instant creationTime)	When the component was created.
TrialComponent.Builder	displayName(String displayName)	The name of the component as displayed.
TrialComponent.Builder	endTime(Instant endTime)	When the component ended.
TrialComponent.Builder	inputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)	The input artifacts of the component.
default TrialComponent.Builder	lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy)	Sets the value of the LastModifiedBy property for this object.
TrialComponent.Builder	lastModifiedBy(UserContext lastModifiedBy)	Sets the value of the LastModifiedBy property for this object.
TrialComponent.Builder	lastModifiedTime(Instant lastModifiedTime)	When the component was last modified.
TrialComponent.Builder	lineageGroupArn(String lineageGroupArn)	The Amazon Resource Name (ARN) of the lineage group resource.
default TrialComponent.Builder	metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties)	Sets the value of the MetadataProperties property for this object.
TrialComponent.Builder	metadataProperties(MetadataProperties metadataProperties)	Sets the value of the MetadataProperties property for this object.
TrialComponent.Builder	metrics(Collection<TrialComponentMetricSummary> metrics)	The metrics for the component.
TrialComponent.Builder	metrics(Consumer<TrialComponentMetricSummary.Builder>... metrics)	The metrics for the component.
TrialComponent.Builder	metrics(TrialComponentMetricSummary... metrics)	The metrics for the component.
TrialComponent.Builder	outputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)	The output artifacts of the component.
TrialComponent.Builder	parameters(Map<String,TrialComponentParameterValue> parameters)	The hyperparameters of the component.
TrialComponent.Builder	parents(Collection<Parent> parents)	An array of the parents of the component.
TrialComponent.Builder	parents(Consumer<Parent.Builder>... parents)	An array of the parents of the component.
TrialComponent.Builder	parents(Parent... parents)	An array of the parents of the component.
TrialComponent.Builder	runName(String runName)	The name of the experiment run.
default TrialComponent.Builder	source(Consumer<TrialComponentSource.Builder> source)	The Amazon Resource Name (ARN) and job type of the source of the component.
TrialComponent.Builder	source(TrialComponentSource source)	The Amazon Resource Name (ARN) and job type of the source of the component.
default TrialComponent.Builder	sourceDetail(Consumer<TrialComponentSourceDetail.Builder> sourceDetail)	Details of the source of the component.
TrialComponent.Builder	sourceDetail(TrialComponentSourceDetail sourceDetail)	Details of the source of the component.
TrialComponent.Builder	startTime(Instant startTime)	When the component started.
default TrialComponent.Builder	status(Consumer<TrialComponentStatus.Builder> status)	Sets the value of the Status property for this object.
TrialComponent.Builder	status(TrialComponentStatus status)	Sets the value of the Status property for this object.
TrialComponent.Builder	tags(Collection<Tag> tags)	The list of tags that are associated with the component.
TrialComponent.Builder	tags(Consumer<Tag.Builder>... tags)	The list of tags that are associated with the component.
TrialComponent.Builder	tags(Tag... tags)	The list of tags that are associated with the component.
TrialComponent.Builder	trialComponentArn(String trialComponentArn)	The Amazon Resource Name (ARN) of the trial component.
TrialComponent.Builder	trialComponentName(String trialComponentName)	The name of the trial component.

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, sdkFields

Method Details

trialComponentName

TrialComponent.Builder trialComponentName(String trialComponentName)

The name of the trial component.

Parameters:

trialComponentName - The name of the trial component.

Returns:

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

displayName

TrialComponent.Builder displayName(String displayName)

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

Parameters:

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

Returns:

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

trialComponentArn

TrialComponent.Builder trialComponentArn(String trialComponentArn)

The Amazon Resource Name (ARN) of the trial component.

Parameters:

trialComponentArn - The Amazon Resource Name (ARN) of the trial component.

Returns:

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

source

TrialComponent.Builder source(TrialComponentSource source)

The Amazon Resource Name (ARN) and job type of the source of the component.

Parameters:

source - The Amazon Resource Name (ARN) and job type of the source of the component.

Returns:

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

source

default TrialComponent.Builder source(Consumer<TrialComponentSource.Builder> source)

The Amazon Resource Name (ARN) and job type of the source of the component.

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

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

Parameters:

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

Returns:

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

See Also:

• source(TrialComponentSource)

status

TrialComponent.Builder status(TrialComponentStatus status)

Sets the value of the Status property for this object.

Parameters:

status - The new value for the Status property for this object.

Returns:

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

status

default TrialComponent.Builder status(Consumer<TrialComponentStatus.Builder> status)

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

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

Parameters:

status - a consumer that will call methods on TrialComponentStatus.Builder

Returns:

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

See Also:

• status(TrialComponentStatus)

startTime

TrialComponent.Builder startTime(Instant startTime)

When the component started.

Parameters:

startTime - When the component started.

Returns:

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

endTime

TrialComponent.Builder endTime(Instant endTime)

When the component ended.

Parameters:

endTime - When the component ended.

Returns:

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

creationTime

TrialComponent.Builder creationTime(Instant creationTime)

When the component was created.

Parameters:

creationTime - When the component was created.

Returns:

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

createdBy

TrialComponent.Builder createdBy(UserContext createdBy)

Who created the trial component.

Parameters:

createdBy - Who created the trial component.

Returns:

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

createdBy

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

Who created the trial component.

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

TrialComponent.Builder lastModifiedTime(Instant lastModifiedTime)

When the component was last modified.

Parameters:

lastModifiedTime - When the component was last modified.

Returns:

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

lastModifiedBy

TrialComponent.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 TrialComponent.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)

parameters

TrialComponent.Builder parameters(Map<String,TrialComponentParameterValue> parameters)

The hyperparameters of the component.

Parameters:

parameters - The hyperparameters of the component.

Returns:

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

inputArtifacts

TrialComponent.Builder inputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)

The input artifacts of the component.

Parameters:

inputArtifacts - The input artifacts of the component.

Returns:

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

outputArtifacts

TrialComponent.Builder outputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)

The output artifacts of the component.

Parameters:

outputArtifacts - The output artifacts of the component.

Returns:

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

metrics

TrialComponent.Builder metrics(Collection<TrialComponentMetricSummary> metrics)

The metrics for the component.

Parameters:

metrics - The metrics for the component.

Returns:

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

metrics

TrialComponent.Builder metrics(TrialComponentMetricSummary... metrics)

The metrics for the component.

Parameters:

metrics - The metrics for the component.

Returns:

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

metrics

TrialComponent.Builder metrics(Consumer<TrialComponentMetricSummary.Builder>... metrics)

The metrics for the component.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(List<TrialComponentMetricSummary>).

Parameters:

metrics - a consumer that will call methods on TrialComponentMetricSummary.Builder

Returns:

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

See Also:

• metrics(java.util.Collection<TrialComponentMetricSummary>)

metadataProperties

TrialComponent.Builder metadataProperties(MetadataProperties metadataProperties)

Sets the value of the MetadataProperties property for this object.

Parameters:

metadataProperties - The new value for the MetadataProperties property for this object.

Returns:

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

metadataProperties

default TrialComponent.Builder metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties)

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

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

Parameters:

metadataProperties - a consumer that will call methods on MetadataProperties.Builder

Returns:

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

See Also:

• metadataProperties(MetadataProperties)

sourceDetail

TrialComponent.Builder sourceDetail(TrialComponentSourceDetail sourceDetail)

Details of the source of the component.

Parameters:

sourceDetail - Details of the source of the component.

Returns:

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

sourceDetail

default TrialComponent.Builder sourceDetail(Consumer<TrialComponentSourceDetail.Builder> sourceDetail)

Details of the source of the component.

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

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

Parameters:

sourceDetail - a consumer that will call methods on TrialComponentSourceDetail.Builder

Returns:

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

See Also:

• sourceDetail(TrialComponentSourceDetail)

lineageGroupArn

TrialComponent.Builder lineageGroupArn(String lineageGroupArn)

The Amazon Resource Name (ARN) of the lineage group resource.

Parameters:

lineageGroupArn - The Amazon Resource Name (ARN) of the lineage group resource.

Returns:

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

tags

TrialComponent.Builder tags(Collection<Tag> tags)

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

Parameters:

tags - The list of tags that are associated with the component. 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

TrialComponent.Builder tags(Tag... tags)

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

Parameters:

tags - The list of tags that are associated with the component. 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

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

The list of tags that are associated with the component. 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<Tag>).

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<Tag>)

parents

TrialComponent.Builder parents(Collection<Parent> parents)

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

Parameters:

parents - An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

Returns:

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

parents

TrialComponent.Builder parents(Parent... parents)

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

Parameters:

parents - An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

Returns:

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

parents

TrialComponent.Builder parents(Consumer<Parent.Builder>... parents)

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parents(List<Parent>).

Parameters:

parents - a consumer that will call methods on Parent.Builder

Returns:

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

See Also:

• parents(java.util.Collection<Parent>)

runName

TrialComponent.Builder runName(String runName)

The name of the experiment run.

Parameters:

runName - The name of the experiment run.

Returns:

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