GetFlowResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.bedrockagent.model.GetFlowResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetFlowResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetFlowResult()

Constructors
Constructor and Description
`GetFlowResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetFlowResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the flow.
`Date`	`getCreatedAt()` The time at which the flow was created.
`String`	`getCustomerEncryptionKeyArn()` The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
`FlowDefinition`	`getDefinition()` The definition of the nodes and connections between the nodes in the flow.
`String`	`getDescription()` The description of the flow.
`String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
`String`	`getId()` The unique identifier of the flow.
`String`	`getName()` The name of the flow.
`String`	`getStatus()` The status of the flow.
`Date`	`getUpdatedAt()` The time at which the flow was last updated.
`List<FlowValidation>`	`getValidations()` A list of validation error messages related to the last failed operation on the flow.
`String`	`getVersion()` The version of the flow for which information was retrieved.
`int`	`hashCode()`
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the flow.
`void`	`setCreatedAt(Date createdAt)` The time at which the flow was created.
`void`	`setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)` The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
`void`	`setDefinition(FlowDefinition definition)` The definition of the nodes and connections between the nodes in the flow.
`void`	`setDescription(String description)` The description of the flow.
`void`	`setExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
`void`	`setId(String id)` The unique identifier of the flow.
`void`	`setName(String name)` The name of the flow.
`void`	`setStatus(String status)` The status of the flow.
`void`	`setUpdatedAt(Date updatedAt)` The time at which the flow was last updated.
`void`	`setValidations(Collection<FlowValidation> validations)` A list of validation error messages related to the last failed operation on the flow.
`void`	`setVersion(String version)` The version of the flow for which information was retrieved.
`String`	`toString()` Returns a string representation of this object.
`GetFlowResult`	`withArn(String arn)` The Amazon Resource Name (ARN) of the flow.
`GetFlowResult`	`withCreatedAt(Date createdAt)` The time at which the flow was created.
`GetFlowResult`	`withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)` The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
`GetFlowResult`	`withDefinition(FlowDefinition definition)` The definition of the nodes and connections between the nodes in the flow.
`GetFlowResult`	`withDescription(String description)` The description of the flow.
`GetFlowResult`	`withExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
`GetFlowResult`	`withId(String id)` The unique identifier of the flow.
`GetFlowResult`	`withName(String name)` The name of the flow.
`GetFlowResult`	`withStatus(FlowStatus status)` The status of the flow.
`GetFlowResult`	`withStatus(String status)` The status of the flow.
`GetFlowResult`	`withUpdatedAt(Date updatedAt)` The time at which the flow was last updated.
`GetFlowResult`	`withValidations(Collection<FlowValidation> validations)` A list of validation error messages related to the last failed operation on the flow.
`GetFlowResult`	`withValidations(FlowValidation... validations)` A list of validation error messages related to the last failed operation on the flow.
`GetFlowResult`	`withVersion(String version)` The version of the flow for which information was retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetFlowResult
```
public GetFlowResult()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the flow.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the flow.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the flow.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the flow.
  - withArn
```
public GetFlowResult withArn(String arn)
```
    The Amazon Resource Name (ARN) of the flow.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time at which the flow was created.
    
    Parameters:
    
    createdAt - The time at which the flow was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time at which the flow was created.
    
    Returns:
    
    The time at which the flow was created.
  - withCreatedAt
```
public GetFlowResult withCreatedAt(Date createdAt)
```
    The time at which the flow was created.
    
    Parameters:
    
    createdAt - The time at which the flow was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerEncryptionKeyArn
```
public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
```
    The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
    
    Parameters:
    
    customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
  - getCustomerEncryptionKeyArn
```
public String getCustomerEncryptionKeyArn()
```
    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.
  - withCustomerEncryptionKeyArn
```
public GetFlowResult withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
```
    The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
    
    Parameters:
    
    customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(FlowDefinition definition)
```
    The definition of the nodes and connections between the nodes in the flow.
    
    Parameters:
    
    definition - The definition of the nodes and connections between the nodes in the flow.
  - getDefinition
```
public FlowDefinition getDefinition()
```
    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.
  - withDefinition
```
public GetFlowResult withDefinition(FlowDefinition definition)
```
    The definition of the nodes and connections between the nodes in the flow.
    
    Parameters:
    
    definition - The definition of the nodes and connections between the nodes in the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the flow.
    
    Parameters:
    
    description - The description of the flow.
  - getDescription
```
public String getDescription()
```
    The description of the flow.
    
    Returns:
    
    The description of the flow.
  - withDescription
```
public GetFlowResult withDescription(String description)
```
    The description of the flow.
    
    Parameters:
    
    description - The description of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRoleArn
```
public void setExecutionRoleArn(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.
    
    Parameters:
    
    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.
  - getExecutionRoleArn
```
public String getExecutionRoleArn()
```
    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.
  - withExecutionRoleArn
```
public GetFlowResult withExecutionRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique identifier of the flow.
    
    Parameters:
    
    id - The unique identifier of the flow.
  - getId
```
public String getId()
```
    The unique identifier of the flow.
    
    Returns:
    
    The unique identifier of the flow.
  - withId
```
public GetFlowResult withId(String id)
```
    The unique identifier of the flow.
    
    Parameters:
    
    id - The unique identifier of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the flow.
    
    Parameters:
    
    name - The name of the flow.
  - getName
```
public String getName()
```
    The name of the flow.
    
    Returns:
    
    The name of the flow.
  - withName
```
public GetFlowResult withName(String name)
```
    The name of the flow.
    
    Parameters:
    
    name - The name of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    FlowStatus
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public GetFlowResult withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlowStatus
  - withStatus
```
public GetFlowResult withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlowStatus
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The time at which the flow was last updated.
    
    Parameters:
    
    updatedAt - The time at which the flow was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The time at which the flow was last updated.
    
    Returns:
    
    The time at which the flow was last updated.
  - withUpdatedAt
```
public GetFlowResult withUpdatedAt(Date updatedAt)
```
    The time at which the flow was last updated.
    
    Parameters:
    
    updatedAt - The time at which the flow was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValidations
```
public List<FlowValidation> getValidations()
```
    A list of validation error messages related to the last failed operation on the flow.
    
    Returns:
    
    A list of validation error messages related to the last failed operation on the flow.
  - setValidations
```
public void setValidations(Collection<FlowValidation> validations)
```
    A list of validation error messages related to the last failed operation on the flow.
    
    Parameters:
    
    validations - A list of validation error messages related to the last failed operation on the flow.
  - withValidations
```
public GetFlowResult withValidations(FlowValidation... validations)
```
    A list of validation error messages related to the last failed operation on the flow.
    
    NOTE: This method appends the values to the existing list (if any). Use setValidations(java.util.Collection) or withValidations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    validations - A list of validation error messages related to the last failed operation on the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidations
```
public GetFlowResult withValidations(Collection<FlowValidation> validations)
```
    A list of validation error messages related to the last failed operation on the flow.
    
    Parameters:
    
    validations - A list of validation error messages related to the last failed operation on the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version of the flow for which information was retrieved.
    
    Parameters:
    
    version - The version of the flow for which information was retrieved.
  - getVersion
```
public String getVersion()
```
    The version of the flow for which information was retrieved.
    
    Returns:
    
    The version of the flow for which information was retrieved.
  - withVersion
```
public GetFlowResult withVersion(String version)
```
    The version of the flow for which information was retrieved.
    
    Parameters:
    
    version - The version of the flow for which information was retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetFlowResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class GetFlowResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetFlowResult

Method Detail

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setCustomerEncryptionKeyArn

getCustomerEncryptionKeyArn

withCustomerEncryptionKeyArn

setDefinition

getDefinition

withDefinition

setDescription

getDescription

withDescription

setExecutionRoleArn

getExecutionRoleArn

withExecutionRoleArn

setId

getId

withId

setName

getName

withName

setStatus

getStatus

withStatus

withStatus

setUpdatedAt

getUpdatedAt

withUpdatedAt

getValidations

setValidations

withValidations

withValidations

setVersion

getVersion

withVersion

toString

equals

hashCode

clone