Interface CreateTrialComponentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateTrialComponentRequest.Builder,
,CreateTrialComponentRequest> SageMakerRequest.Builder
,SdkBuilder<CreateTrialComponentRequest.Builder,
,CreateTrialComponentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateTrialComponentRequest
-
Method Summary
Modifier and TypeMethodDescriptiondisplayName
(String displayName) The name of the component as displayed.When the component ended.inputArtifacts
(Map<String, TrialComponentArtifact> inputArtifacts) The input artifacts for the component.metadataProperties
(Consumer<MetadataProperties.Builder> metadataProperties) Sets the value of the MetadataProperties property for this object.metadataProperties
(MetadataProperties metadataProperties) Sets the value of the MetadataProperties property for this object.outputArtifacts
(Map<String, TrialComponentArtifact> outputArtifacts) The output artifacts for the component.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(Map<String, TrialComponentParameterValue> parameters) The hyperparameters for the component.When the component started.status
(Consumer<TrialComponentStatus.Builder> status) The status of the component.status
(TrialComponentStatus status) The status of the component.tags
(Collection<Tag> tags) A list of tags to associate with the component.tags
(Consumer<Tag.Builder>... tags) A list of tags to associate with the component.A list of tags to associate with the component.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
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
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. IfDisplayName
isn't specified,TrialComponentName
is displayed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The status of the component. States include:
-
InProgress
-
Completed
-
Failed
TrialComponentStatus.Builder
avoiding the need to create one manually viaTrialComponentStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatus(TrialComponentStatus)
.- Parameters:
status
- a consumer that will call methods onTrialComponentStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
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
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 theMetadataProperties.Builder
avoiding the need to create one manually viaMetadataProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometadataProperties(MetadataProperties)
.- Parameters:
metadataProperties
- a consumer that will call methods onMetadataProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateTrialComponentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-