Interface CreateTrialComponentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTrialComponentRequest.Builder,CreateTrialComponentRequest>, SageMakerRequest.Builder, SdkBuilder<CreateTrialComponentRequest.Builder,CreateTrialComponentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateTrialComponentRequest

public static interface CreateTrialComponentRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateTrialComponentRequest.Builder,CreateTrialComponentRequest>

Method Summary

Modifier and Type	Method	Description
CreateTrialComponentRequest.Builder	displayName(String displayName)	The name of the component as displayed.
CreateTrialComponentRequest.Builder	endTime(Instant endTime)	When the component ended.
CreateTrialComponentRequest.Builder	inputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)	The input artifacts for the component.
default CreateTrialComponentRequest.Builder	metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties)	Sets the value of the MetadataProperties property for this object.
CreateTrialComponentRequest.Builder	metadataProperties(MetadataProperties metadataProperties)	Sets the value of the MetadataProperties property for this object.
CreateTrialComponentRequest.Builder	outputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)	The output artifacts for the component.
CreateTrialComponentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateTrialComponentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateTrialComponentRequest.Builder	parameters(Map<String,TrialComponentParameterValue> parameters)	The hyperparameters for the component.
CreateTrialComponentRequest.Builder	startTime(Instant startTime)	When the component started.
default CreateTrialComponentRequest.Builder	status(Consumer<TrialComponentStatus.Builder> status)	The status of the component.
CreateTrialComponentRequest.Builder	status(TrialComponentStatus status)	The status of the component.
CreateTrialComponentRequest.Builder	tags(Collection<Tag> tags)	A list of tags to associate with the component.
CreateTrialComponentRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to associate with the component.
CreateTrialComponentRequest.Builder	tags(Tag... tags)	A list of tags to associate with the component.
CreateTrialComponentRequest.Builder	trialComponentName(String trialComponentName)	The name of the component.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

CreateTrialComponentRequest.Builder trialComponentName(String trialComponentName)

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Parameters:

trialComponentName - The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Returns:

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

displayName

CreateTrialComponentRequest.Builder displayName(String displayName)

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

Parameters:

displayName - The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

Returns:

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

status

CreateTrialComponentRequest.Builder status(TrialComponentStatus status)

The status of the component. States include:

• InProgress

• Completed

• Failed

Parameters:

status - The status of the component. States include:

• InProgress

• Completed

• Failed

Returns:

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

status

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

The status of the component. States include:

• InProgress

• Completed

• Failed

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

CreateTrialComponentRequest.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

CreateTrialComponentRequest.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.

parameters

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

The hyperparameters for the component.

Parameters:

parameters - The hyperparameters for the component.

Returns:

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

inputArtifacts

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

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

Parameters:

inputArtifacts - The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

Returns:

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

outputArtifacts

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

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

Parameters:

outputArtifacts - The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

Returns:

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

metadataProperties

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

tags

CreateTrialComponentRequest.Builder tags(Collection<Tag> tags)

A list of tags to associate with the component. You can use Search API to search on the tags.

Parameters:

tags - A list of tags to associate 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

CreateTrialComponentRequest.Builder tags(Tag... tags)

A list of tags to associate with the component. You can use Search API to search on the tags.

Parameters:

tags - A list of tags to associate 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

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

A list of tags to associate 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>)

overrideConfiguration

CreateTrialComponentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateTrialComponentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.