Package software.amazon.awssdk.services.sagemakera2iruntime.model

Class DescribeHumanLoopResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemakera2iruntime.model.SageMakerA2IRuntimeResponse

software.amazon.awssdk.services.sagemakera2iruntime.model.DescribeHumanLoopResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeHumanLoopResponse
extends SageMakerA2IRuntimeResponse
implements ToCopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeHumanLoopResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeHumanLoopResponse.Builder	builder()
Instant	creationTime()	The creation time when Amazon Augmented AI created the human loop.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureCode()	A failure code that identifies the type of failure.
String	failureReason()	The reason why a human loop failed.
String	flowDefinitionArn()	The Amazon Resource Name (ARN) of the flow definition.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	humanLoopArn()	The Amazon Resource Name (ARN) of the human loop.
String	humanLoopName()	The name of the human loop.
HumanLoopOutput	humanLoopOutput()	An object that contains information about the output of the human loop.
HumanLoopStatus	humanLoopStatus()	The status of the human loop.
String	humanLoopStatusAsString()	The status of the human loop.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeHumanLoopResponse.Builder>	serializableBuilderClass()
DescribeHumanLoopResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemakera2iruntime.model.SageMakerA2IRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

creationTime

public final Instant creationTime()

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

Returns:

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

failureReason

public final String failureReason()

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

Returns:

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

failureCode

public final String failureCode()

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

Returns:

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

humanLoopStatus

public final HumanLoopStatus humanLoopStatus()

The status of the human loop.

If the service returns an enum value that is not available in the current SDK version, humanLoopStatus will return HumanLoopStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from humanLoopStatusAsString().

Returns:

The status of the human loop.

See Also:

HumanLoopStatus

humanLoopStatusAsString

public final String humanLoopStatusAsString()

The status of the human loop.

If the service returns an enum value that is not available in the current SDK version, humanLoopStatus will return HumanLoopStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from humanLoopStatusAsString().

Returns:

The status of the human loop.

See Also:

HumanLoopStatus

humanLoopName

public final 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).

Returns:

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

humanLoopArn

public final String humanLoopArn()

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

Returns:

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

flowDefinitionArn

public final String flowDefinitionArn()

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

Returns:

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

humanLoopOutput

public final HumanLoopOutput humanLoopOutput()

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

Returns:

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

toBuilder

public DescribeHumanLoopResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeHumanLoopResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeHumanLoopResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo