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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetFlowResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the flow.
`static GetFlowResponse.Builder`	`builder()`
`Instant`	`createdAt()`	The time at which the flow was created.
`String`	`customerEncryptionKeyArn()`	The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
`FlowDefinition`	`definition()`	The definition of the nodes and connections between the nodes in the flow.
`String`	`description()`	The description of the flow.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()`	The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasValidations()`	For responses, this returns true if the service returned a value for the Validations property.
`String`	`id()`	The unique identifier of the flow.
`String`	`name()`	The name of the flow.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetFlowResponse.Builder>`	`serializableBuilderClass()`
`FlowStatus`	`status()`	The status of the flow.
`String`	`statusAsString()`	The status of the flow.
`GetFlowResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the flow was last updated.
`List<FlowValidation>`	`validations()`	A list of validation error messages related to the last failed operation on the flow.
`String`	`version()`	The version of the flow for which information was retrieved.

Methods inherited from class software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse
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
  - 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:
    
    FlowStatus
  - 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:
    
    FlowStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetFlowResponse.Builder,GetFlowResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    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

Class GetFlowResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse

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

Methods inherited from class java.lang.Object

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

Method Detail

arn

createdAt

customerEncryptionKeyArn

definition

description

executionRoleArn

id

name

status

statusAsString

updatedAt

hasValidations

validations

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields