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

Interface DescribeAutoMlJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAutoMlJobResponse.Builder,DescribeAutoMlJobResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeAutoMlJobResponse.Builder,DescribeAutoMlJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeAutoMlJobResponse

public static interface DescribeAutoMlJobResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeAutoMlJobResponse.Builder,DescribeAutoMlJobResponse>

Method Summary

Modifier and Type	Method	Description
DescribeAutoMlJobResponse.Builder	autoMLJobArn(String autoMLJobArn)	Returns the ARN of the AutoML job.
default DescribeAutoMlJobResponse.Builder	autoMLJobArtifacts(Consumer<AutoMLJobArtifacts.Builder> autoMLJobArtifacts)	Returns information on the job's artifacts found in AutoMLJobArtifacts.
DescribeAutoMlJobResponse.Builder	autoMLJobArtifacts(AutoMLJobArtifacts autoMLJobArtifacts)	Returns information on the job's artifacts found in AutoMLJobArtifacts.
default DescribeAutoMlJobResponse.Builder	autoMLJobConfig(Consumer<AutoMLJobConfig.Builder> autoMLJobConfig)	Returns the configuration for the AutoML job.
DescribeAutoMlJobResponse.Builder	autoMLJobConfig(AutoMLJobConfig autoMLJobConfig)	Returns the configuration for the AutoML job.
DescribeAutoMlJobResponse.Builder	autoMLJobName(String autoMLJobName)	Returns the name of the AutoML job.
default DescribeAutoMlJobResponse.Builder	autoMLJobObjective(Consumer<AutoMLJobObjective.Builder> autoMLJobObjective)	Returns the job's objective.
DescribeAutoMlJobResponse.Builder	autoMLJobObjective(AutoMLJobObjective autoMLJobObjective)	Returns the job's objective.
DescribeAutoMlJobResponse.Builder	autoMLJobSecondaryStatus(String autoMLJobSecondaryStatus)	Returns the secondary status of the AutoML job.
DescribeAutoMlJobResponse.Builder	autoMLJobSecondaryStatus(AutoMLJobSecondaryStatus autoMLJobSecondaryStatus)	Returns the secondary status of the AutoML job.
DescribeAutoMlJobResponse.Builder	autoMLJobStatus(String autoMLJobStatus)	Returns the status of the AutoML job.
DescribeAutoMlJobResponse.Builder	autoMLJobStatus(AutoMLJobStatus autoMLJobStatus)	Returns the status of the AutoML job.
default DescribeAutoMlJobResponse.Builder	bestCandidate(Consumer<AutoMLCandidate.Builder> bestCandidate)	The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
DescribeAutoMlJobResponse.Builder	bestCandidate(AutoMLCandidate bestCandidate)	The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
DescribeAutoMlJobResponse.Builder	creationTime(Instant creationTime)	Returns the creation time of the AutoML job.
DescribeAutoMlJobResponse.Builder	endTime(Instant endTime)	Returns the end time of the AutoML job.
DescribeAutoMlJobResponse.Builder	failureReason(String failureReason)	Returns the failure reason for an AutoML job, when applicable.
DescribeAutoMlJobResponse.Builder	generateCandidateDefinitionsOnly(Boolean generateCandidateDefinitionsOnly)	Indicates whether the output for an AutoML job generates candidate definitions only.
DescribeAutoMlJobResponse.Builder	inputDataConfig(Collection<AutoMLChannel> inputDataConfig)	Returns the input data configuration for the AutoML job.
DescribeAutoMlJobResponse.Builder	inputDataConfig(Consumer<AutoMLChannel.Builder>... inputDataConfig)	Returns the input data configuration for the AutoML job.
DescribeAutoMlJobResponse.Builder	inputDataConfig(AutoMLChannel... inputDataConfig)	Returns the input data configuration for the AutoML job.
DescribeAutoMlJobResponse.Builder	lastModifiedTime(Instant lastModifiedTime)	Returns the job's last modified time.
default DescribeAutoMlJobResponse.Builder	modelDeployConfig(Consumer<ModelDeployConfig.Builder> modelDeployConfig)	Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
DescribeAutoMlJobResponse.Builder	modelDeployConfig(ModelDeployConfig modelDeployConfig)	Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
default DescribeAutoMlJobResponse.Builder	modelDeployResult(Consumer<ModelDeployResult.Builder> modelDeployResult)	Provides information about endpoint for the model deployment.
DescribeAutoMlJobResponse.Builder	modelDeployResult(ModelDeployResult modelDeployResult)	Provides information about endpoint for the model deployment.
default DescribeAutoMlJobResponse.Builder	outputDataConfig(Consumer<AutoMLOutputDataConfig.Builder> outputDataConfig)	Returns the job's output data config.
DescribeAutoMlJobResponse.Builder	outputDataConfig(AutoMLOutputDataConfig outputDataConfig)	Returns the job's output data config.
DescribeAutoMlJobResponse.Builder	partialFailureReasons(Collection<AutoMLPartialFailureReason> partialFailureReasons)	Returns a list of reasons for partial failures within an AutoML job.
DescribeAutoMlJobResponse.Builder	partialFailureReasons(Consumer<AutoMLPartialFailureReason.Builder>... partialFailureReasons)	Returns a list of reasons for partial failures within an AutoML job.
DescribeAutoMlJobResponse.Builder	partialFailureReasons(AutoMLPartialFailureReason... partialFailureReasons)	Returns a list of reasons for partial failures within an AutoML job.
DescribeAutoMlJobResponse.Builder	problemType(String problemType)	Returns the job's problem type.
DescribeAutoMlJobResponse.Builder	problemType(ProblemType problemType)	Returns the job's problem type.
default DescribeAutoMlJobResponse.Builder	resolvedAttributes(Consumer<ResolvedAttributes.Builder> resolvedAttributes)	Contains ProblemType, AutoMLJobObjective, and CompletionCriteria.
DescribeAutoMlJobResponse.Builder	resolvedAttributes(ResolvedAttributes resolvedAttributes)	Contains ProblemType, AutoMLJobObjective, and CompletionCriteria.
DescribeAutoMlJobResponse.Builder	roleArn(String roleArn)	The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

autoMLJobName

DescribeAutoMlJobResponse.Builder autoMLJobName(String autoMLJobName)

Returns the name of the AutoML job.

Parameters:

autoMLJobName - Returns the name of the AutoML job.

Returns:

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

autoMLJobArn

DescribeAutoMlJobResponse.Builder autoMLJobArn(String autoMLJobArn)

Returns the ARN of the AutoML job.

Parameters:

autoMLJobArn - Returns the ARN of the AutoML job.

Returns:

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

inputDataConfig

DescribeAutoMlJobResponse.Builder inputDataConfig(Collection<AutoMLChannel> inputDataConfig)

Returns the input data configuration for the AutoML job.

Parameters:

inputDataConfig - Returns the input data configuration for the AutoML job.

Returns:

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

inputDataConfig

DescribeAutoMlJobResponse.Builder inputDataConfig(AutoMLChannel... inputDataConfig)

Returns the input data configuration for the AutoML job.

Parameters:

inputDataConfig - Returns the input data configuration for the AutoML job.

Returns:

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

inputDataConfig

DescribeAutoMlJobResponse.Builder inputDataConfig(Consumer<AutoMLChannel.Builder>... inputDataConfig)

Returns the input data configuration for the AutoML job.

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

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

Parameters:

inputDataConfig - a consumer that will call methods on AutoMLChannel.Builder

Returns:

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

See Also:

• inputDataConfig(java.util.Collection<AutoMLChannel>)

outputDataConfig

DescribeAutoMlJobResponse.Builder outputDataConfig(AutoMLOutputDataConfig outputDataConfig)

Returns the job's output data config.

Parameters:

outputDataConfig - Returns the job's output data config.

Returns:

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

outputDataConfig

default DescribeAutoMlJobResponse.Builder outputDataConfig(Consumer<AutoMLOutputDataConfig.Builder> outputDataConfig)

Returns the job's output data config.

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

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

Parameters:

outputDataConfig - a consumer that will call methods on AutoMLOutputDataConfig.Builder

Returns:

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

See Also:

• outputDataConfig(AutoMLOutputDataConfig)

roleArn

DescribeAutoMlJobResponse.Builder roleArn(String roleArn)

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

Parameters:

roleArn - The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

Returns:

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

autoMLJobObjective

DescribeAutoMlJobResponse.Builder autoMLJobObjective(AutoMLJobObjective autoMLJobObjective)

Returns the job's objective.

Parameters:

autoMLJobObjective - Returns the job's objective.

Returns:

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

autoMLJobObjective

default DescribeAutoMlJobResponse.Builder autoMLJobObjective(Consumer<AutoMLJobObjective.Builder> autoMLJobObjective)

Returns the job's objective.

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

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

Parameters:

autoMLJobObjective - a consumer that will call methods on AutoMLJobObjective.Builder

Returns:

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

See Also:

• autoMLJobObjective(AutoMLJobObjective)

problemType

DescribeAutoMlJobResponse.Builder problemType(String problemType)

Returns the job's problem type.

Parameters:

problemType - Returns the job's problem type.

Returns:

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

See Also:

• ProblemType
• ProblemType

problemType

DescribeAutoMlJobResponse.Builder problemType(ProblemType problemType)

Returns the job's problem type.

Parameters:

problemType - Returns the job's problem type.

Returns:

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

See Also:

• ProblemType
• ProblemType

autoMLJobConfig

DescribeAutoMlJobResponse.Builder autoMLJobConfig(AutoMLJobConfig autoMLJobConfig)

Returns the configuration for the AutoML job.

Parameters:

autoMLJobConfig - Returns the configuration for the AutoML job.

Returns:

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

autoMLJobConfig

default DescribeAutoMlJobResponse.Builder autoMLJobConfig(Consumer<AutoMLJobConfig.Builder> autoMLJobConfig)

Returns the configuration for the AutoML job.

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

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

Parameters:

autoMLJobConfig - a consumer that will call methods on AutoMLJobConfig.Builder

Returns:

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

See Also:

• autoMLJobConfig(AutoMLJobConfig)

creationTime

DescribeAutoMlJobResponse.Builder creationTime(Instant creationTime)

Returns the creation time of the AutoML job.

Parameters:

creationTime - Returns the creation time of the AutoML job.

Returns:

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

endTime

DescribeAutoMlJobResponse.Builder endTime(Instant endTime)

Returns the end time of the AutoML job.

Parameters:

endTime - Returns the end time of the AutoML job.

Returns:

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

lastModifiedTime

DescribeAutoMlJobResponse.Builder lastModifiedTime(Instant lastModifiedTime)

Returns the job's last modified time.

Parameters:

lastModifiedTime - Returns the job's last modified time.

Returns:

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

failureReason

DescribeAutoMlJobResponse.Builder failureReason(String failureReason)

Returns the failure reason for an AutoML job, when applicable.

Parameters:

failureReason - Returns the failure reason for an AutoML job, when applicable.

Returns:

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

partialFailureReasons

DescribeAutoMlJobResponse.Builder partialFailureReasons(Collection<AutoMLPartialFailureReason> partialFailureReasons)

Returns a list of reasons for partial failures within an AutoML job.

Parameters:

partialFailureReasons - Returns a list of reasons for partial failures within an AutoML job.

Returns:

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

partialFailureReasons

DescribeAutoMlJobResponse.Builder partialFailureReasons(AutoMLPartialFailureReason... partialFailureReasons)

Returns a list of reasons for partial failures within an AutoML job.

Parameters:

partialFailureReasons - Returns a list of reasons for partial failures within an AutoML job.

Returns:

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

partialFailureReasons

DescribeAutoMlJobResponse.Builder partialFailureReasons(Consumer<AutoMLPartialFailureReason.Builder>... partialFailureReasons)

Returns a list of reasons for partial failures within an AutoML job.

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

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

Parameters:

partialFailureReasons - a consumer that will call methods on AutoMLPartialFailureReason.Builder

Returns:

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

See Also:

• partialFailureReasons(java.util.Collection<AutoMLPartialFailureReason>)

bestCandidate

DescribeAutoMlJobResponse.Builder bestCandidate(AutoMLCandidate bestCandidate)

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

Parameters:

bestCandidate - The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

Returns:

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

bestCandidate

default DescribeAutoMlJobResponse.Builder bestCandidate(Consumer<AutoMLCandidate.Builder> bestCandidate)

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

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

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

Parameters:

bestCandidate - a consumer that will call methods on AutoMLCandidate.Builder

Returns:

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

See Also:

• bestCandidate(AutoMLCandidate)

autoMLJobStatus

DescribeAutoMlJobResponse.Builder autoMLJobStatus(String autoMLJobStatus)

Returns the status of the AutoML job.

Parameters:

autoMLJobStatus - Returns the status of the AutoML job.

Returns:

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

See Also:

• AutoMLJobStatus
• AutoMLJobStatus

autoMLJobStatus

DescribeAutoMlJobResponse.Builder autoMLJobStatus(AutoMLJobStatus autoMLJobStatus)

Returns the status of the AutoML job.

Parameters:

autoMLJobStatus - Returns the status of the AutoML job.

Returns:

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

See Also:

• AutoMLJobStatus
• AutoMLJobStatus

autoMLJobSecondaryStatus

DescribeAutoMlJobResponse.Builder autoMLJobSecondaryStatus(String autoMLJobSecondaryStatus)

Returns the secondary status of the AutoML job.

Parameters:

autoMLJobSecondaryStatus - Returns the secondary status of the AutoML job.

Returns:

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

See Also:

• AutoMLJobSecondaryStatus
• AutoMLJobSecondaryStatus

autoMLJobSecondaryStatus

DescribeAutoMlJobResponse.Builder autoMLJobSecondaryStatus(AutoMLJobSecondaryStatus autoMLJobSecondaryStatus)

Returns the secondary status of the AutoML job.

Parameters:

autoMLJobSecondaryStatus - Returns the secondary status of the AutoML job.

Returns:

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

See Also:

• AutoMLJobSecondaryStatus
• AutoMLJobSecondaryStatus

generateCandidateDefinitionsOnly

DescribeAutoMlJobResponse.Builder generateCandidateDefinitionsOnly(Boolean generateCandidateDefinitionsOnly)

Indicates whether the output for an AutoML job generates candidate definitions only.

Parameters:

generateCandidateDefinitionsOnly - Indicates whether the output for an AutoML job generates candidate definitions only.

Returns:

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

autoMLJobArtifacts

DescribeAutoMlJobResponse.Builder autoMLJobArtifacts(AutoMLJobArtifacts autoMLJobArtifacts)

Returns information on the job's artifacts found in AutoMLJobArtifacts.

Parameters:

autoMLJobArtifacts - Returns information on the job's artifacts found in AutoMLJobArtifacts.

Returns:

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

autoMLJobArtifacts

default DescribeAutoMlJobResponse.Builder autoMLJobArtifacts(Consumer<AutoMLJobArtifacts.Builder> autoMLJobArtifacts)

Returns information on the job's artifacts found in AutoMLJobArtifacts.

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

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

Parameters:

autoMLJobArtifacts - a consumer that will call methods on AutoMLJobArtifacts.Builder

Returns:

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

See Also:

• autoMLJobArtifacts(AutoMLJobArtifacts)

resolvedAttributes

DescribeAutoMlJobResponse.Builder resolvedAttributes(ResolvedAttributes resolvedAttributes)

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

Parameters:

resolvedAttributes - Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

Returns:

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

resolvedAttributes

default DescribeAutoMlJobResponse.Builder resolvedAttributes(Consumer<ResolvedAttributes.Builder> resolvedAttributes)

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

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

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

Parameters:

resolvedAttributes - a consumer that will call methods on ResolvedAttributes.Builder

Returns:

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

See Also:

• resolvedAttributes(ResolvedAttributes)

modelDeployConfig

DescribeAutoMlJobResponse.Builder modelDeployConfig(ModelDeployConfig modelDeployConfig)

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

Parameters:

modelDeployConfig - Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

Returns:

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

modelDeployConfig

default DescribeAutoMlJobResponse.Builder modelDeployConfig(Consumer<ModelDeployConfig.Builder> modelDeployConfig)

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

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

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

Parameters:

modelDeployConfig - a consumer that will call methods on ModelDeployConfig.Builder

Returns:

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

See Also:

• modelDeployConfig(ModelDeployConfig)

modelDeployResult

DescribeAutoMlJobResponse.Builder modelDeployResult(ModelDeployResult modelDeployResult)

Provides information about endpoint for the model deployment.

Parameters:

modelDeployResult - Provides information about endpoint for the model deployment.

Returns:

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

modelDeployResult

default DescribeAutoMlJobResponse.Builder modelDeployResult(Consumer<ModelDeployResult.Builder> modelDeployResult)

Provides information about endpoint for the model deployment.

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

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

Parameters:

modelDeployResult - a consumer that will call methods on ModelDeployResult.Builder

Returns:

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

See Also:

• modelDeployResult(ModelDeployResult)