Class GetFlowResponse

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

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the flow.

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

    • createdAt

      public final Instant createdAt()

      The time at which the flow was created.

      Returns:
      The time at which the flow was created.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

    • definition

      public final FlowDefinition definition()

      The definition of the nodes and connections between the nodes in the flow.

      Returns:
      The definition of the nodes and connections between the nodes in the flow.

    • description

      public final String description()

      The description of the flow.

      Returns:
      The description of the flow.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

    • id

      public final String id()

      The unique identifier of the flow.

      Returns:
      The unique identifier of the flow.

    • name

      public final String name()

      The name of the flow.

      Returns:
      The name of the flow.

    • status

      public final FlowStatus status()

      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

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

      Returns:
      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

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

      Returns:
      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

      See Also:

    • updatedAt

      public final Instant updatedAt()

      The time at which the flow was last updated.

      Returns:
      The time at which the flow was last updated.

    • hasValidations

      public final boolean hasValidations()
      For responses, this returns true if the service returned a value for the Validations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • validations

      public final List<FlowValidation> validations()

      A list of validation error messages related to the last failed operation on the flow.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidations() method.

      Returns:
      A list of validation error messages related to the last failed operation on the flow.

    • version

      public final String version()

      The version of the flow for which information was retrieved.

      Returns:
      The version of the flow for which information was retrieved.

    • toBuilder

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

    • builder

      public static GetFlowResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.