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>

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<DescribeHumanLoopResponse.Builder,DescribeHumanLoopResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.