Class DescribeFlowDefinitionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeFlowDefinitionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFlowDefinitionResponse.Builder,DescribeFlowDefinitionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFlowDefinitionResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeFlowDefinitionResponse.Builder,DescribeFlowDefinitionResponse>

  • Method Details

    • flowDefinitionArn

      public final String flowDefinitionArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the flow defintion.

    • flowDefinitionName

      public final String flowDefinitionName()

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

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

    • flowDefinitionStatus

      public final FlowDefinitionStatus flowDefinitionStatus()

      The status of the flow definition. Valid values are listed below.

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

      Returns:
      The status of the flow definition. Valid values are listed below.
      See Also:

    • flowDefinitionStatusAsString

      public final String flowDefinitionStatusAsString()

      The status of the flow definition. Valid values are listed below.

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

      Returns:
      The status of the flow definition. Valid values are listed below.
      See Also:

    • creationTime

      public final Instant creationTime()

      The timestamp when the flow definition was created.

      Returns:
      The timestamp when the flow definition was created.

    • humanLoopRequestSource

      public final HumanLoopRequestSource humanLoopRequestSource()

      Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

      Returns:
      Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

    • humanLoopActivationConfig

      public final HumanLoopActivationConfig humanLoopActivationConfig()

      An object containing information about what triggers a human review workflow.

      Returns:
      An object containing information about what triggers a human review workflow.

    • humanLoopConfig

      public final HumanLoopConfig humanLoopConfig()

      An object containing information about who works on the task, the workforce task price, and other task details.

      Returns:
      An object containing information about who works on the task, the workforce task price, and other task details.

    • outputConfig

      public final FlowDefinitionOutputConfig outputConfig()

      An object containing information about the output file.

      Returns:
      An object containing information about the output file.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

    • failureReason

      public final String failureReason()

      The reason your flow definition failed.

      Returns:
      The reason your flow definition failed.

    • toBuilder

      public DescribeFlowDefinitionResponse.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<DescribeFlowDefinitionResponse.Builder,DescribeFlowDefinitionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeFlowDefinitionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeFlowDefinitionResponse.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.