software.amazon.awssdk.services.sagemakera2iruntime.model

Interface DescribeHumanLoopResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>, SageMakerA2IRuntimeResponse.Builder, SdkBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeHumanLoopResponse

public static interface DescribeHumanLoopResponse.Builder
extends SageMakerA2IRuntimeResponse.Builder, SdkPojo, CopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>

Method Summary

Modifier and Type	Method and Description
DescribeHumanLoopResponse.Builder	creationTime(Instant creationTime) The creation time when Amazon Augmented AI created the human loop.
DescribeHumanLoopResponse.Builder	failureCode(String failureCode) A failure code that identifies the type of failure.
DescribeHumanLoopResponse.Builder	failureReason(String failureReason) The reason why a human loop failed.
DescribeHumanLoopResponse.Builder	flowDefinitionArn(String flowDefinitionArn) The Amazon Resource Name (ARN) of the flow definition.
DescribeHumanLoopResponse.Builder	humanLoopArn(String humanLoopArn) The Amazon Resource Name (ARN) of the human loop.
DescribeHumanLoopResponse.Builder	humanLoopName(String humanLoopName) The name of the human loop.
default DescribeHumanLoopResponse.Builder	humanLoopOutput(Consumer<HumanLoopOutput.Builder> humanLoopOutput) An object that contains information about the output of the human loop.
DescribeHumanLoopResponse.Builder	humanLoopOutput(HumanLoopOutput humanLoopOutput) An object that contains information about the output of the human loop.
DescribeHumanLoopResponse.Builder	humanLoopStatus(HumanLoopStatus humanLoopStatus) The status of the human loop.
DescribeHumanLoopResponse.Builder	humanLoopStatus(String humanLoopStatus) The status of the human loop.

Methods inherited from interface software.amazon.awssdk.services.sagemakera2iruntime.model.SageMakerA2IRuntimeResponse.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

creationTime

DescribeHumanLoopResponse.Builder creationTime(Instant creationTime)

The creation time when Amazon Augmented AI created the human loop.

Parameters:

creationTime - The creation time when Amazon Augmented AI created the human loop.

Returns:

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

failureReason

DescribeHumanLoopResponse.Builder failureReason(String failureReason)

The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.

Parameters:

failureReason - The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.

Returns:

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

failureCode

DescribeHumanLoopResponse.Builder failureCode(String failureCode)

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

Parameters:

failureCode - A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

Returns:

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

humanLoopStatus

DescribeHumanLoopResponse.Builder humanLoopStatus(String humanLoopStatus)

The status of the human loop.

Parameters:

humanLoopStatus - The status of the human loop.

Returns:

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

See Also:

HumanLoopStatus, HumanLoopStatus

humanLoopStatus

DescribeHumanLoopResponse.Builder humanLoopStatus(HumanLoopStatus humanLoopStatus)

The status of the human loop.

Parameters:

humanLoopStatus - The status of the human loop.

Returns:

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

See Also:

HumanLoopStatus, HumanLoopStatus

humanLoopName

DescribeHumanLoopResponse.Builder humanLoopName(String humanLoopName)

The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

Parameters:

humanLoopName - The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

Returns:

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

humanLoopArn

DescribeHumanLoopResponse.Builder humanLoopArn(String humanLoopArn)

The Amazon Resource Name (ARN) of the human loop.

Parameters:

humanLoopArn - The Amazon Resource Name (ARN) of the human loop.

Returns:

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

flowDefinitionArn

DescribeHumanLoopResponse.Builder flowDefinitionArn(String flowDefinitionArn)

The Amazon Resource Name (ARN) of the flow definition.

Parameters:

flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition.

Returns:

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

humanLoopOutput

DescribeHumanLoopResponse.Builder humanLoopOutput(HumanLoopOutput humanLoopOutput)

An object that contains information about the output of the human loop.

Parameters:

humanLoopOutput - An object that contains information about the output of the human loop.

Returns:

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

humanLoopOutput

default DescribeHumanLoopResponse.Builder humanLoopOutput(Consumer<HumanLoopOutput.Builder> humanLoopOutput)

An object that contains information about the output of the human loop.

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

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

Parameters:

humanLoopOutput - a consumer that will call methods on HumanLoopOutput.Builder

Returns:

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

See Also:

humanLoopOutput(HumanLoopOutput)