Class DescribeHumanLoopResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeHumanLoopResponse.Builder,
DescribeHumanLoopResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The creation time when Amazon Augmented AI created the human loop.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A failure code that identifies the type of failure.final String
The reason why a human loop failed.final String
The Amazon Resource Name (ARN) of the flow definition.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the human loop.final String
The name of the human loop.final HumanLoopOutput
An object that contains information about the output of the human loop.final HumanLoopStatus
The status of the human loop.final String
The status of the human loop.static Class
<? extends DescribeHumanLoopResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
The status of the human loop.
If the service returns an enum value that is not available in the current SDK version,
humanLoopStatus
will returnHumanLoopStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhumanLoopStatusAsString()
.- Returns:
- The status of the human loop.
- See Also:
-
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 returnHumanLoopStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhumanLoopStatusAsString()
.- Returns:
- The status of the human loop.
- See Also:
-
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
The Amazon Resource Name (ARN) of the human loop.
- Returns:
- The Amazon Resource Name (ARN) of the human loop.
-
flowDefinitionArn
The Amazon Resource Name (ARN) of the flow definition.
- Returns:
- The Amazon Resource Name (ARN) of the flow definition.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeHumanLoopResponse.Builder,
DescribeHumanLoopResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-