DescribeFlowResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.appflow.model.AppflowResponse
    - - software.amazon.awssdk.services.appflow.model.DescribeFlowResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeFlowResponse
extends AppflowResponse
implements ToCopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeFlowResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeFlowResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeFlowResponse.Builder`	`builder()`
`Instant`	`createdAt()` Specifies when the flow was created.
`String`	`createdBy()` The ARN of the user who created the flow.
`String`	`description()` A description of the flow.
`List<DestinationFlowConfig>`	`destinationFlowConfigList()` The configuration that controls how Amazon AppFlow transfers data to the destination connector.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flowArn()` The flow's Amazon Resource Name (ARN).
`String`	`flowName()` The specified name of the flow.
`FlowStatus`	`flowStatus()` Indicates the current status of the flow.
`String`	`flowStatusAsString()` Indicates the current status of the flow.
`String`	`flowStatusMessage()` Contains an error message if the flow status is in a suspended or error state.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinationFlowConfigList()` Returns true if the DestinationFlowConfigList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTasks()` Returns true if the Tasks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsArn()` The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
`ExecutionDetails`	`lastRunExecutionDetails()` Describes the details of the most recent flow run.
`Instant`	`lastUpdatedAt()` Specifies when the flow was last updated.
`String`	`lastUpdatedBy()` Specifies the user name of the account that performed the most recent update.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeFlowResponse.Builder>`	`serializableBuilderClass()`
`SourceFlowConfig`	`sourceFlowConfig()` The configuration that controls how Amazon AppFlow retrieves data from the source connector.
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for your flow.
`List<Task>`	`tasks()` A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
`DescribeFlowResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TriggerConfig`	`triggerConfig()` The trigger settings that determine how and when the flow runs.

Methods inherited from class software.amazon.awssdk.services.appflow.model.AppflowResponse
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
  - flowArn
```
public final String flowArn()
```
    The flow's Amazon Resource Name (ARN).
    
    Returns:
    
    The flow's Amazon Resource Name (ARN).
  - description
```
public final String description()
```
    A description of the flow.
    
    Returns:
    
    A description of the flow.
  - flowName
```
public final String flowName()
```
    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    
    Returns:
    
    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
  - kmsArn
```
public final String kmsArn()
```
    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
    
    Returns:
    
    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
  - flowStatus
```
public final FlowStatus flowStatus()
```
    Indicates the current status of the flow.
    
    If the service returns an enum value that is not available in the current SDK version, flowStatus will return FlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowStatusAsString().
    
    Returns:
    
    Indicates the current status of the flow.
    
    See Also:
    
    FlowStatus
  - flowStatusAsString
```
public final String flowStatusAsString()
```
    Indicates the current status of the flow.
    
    If the service returns an enum value that is not available in the current SDK version, flowStatus will return FlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowStatusAsString().
    
    Returns:
    
    Indicates the current status of the flow.
    
    See Also:
    
    FlowStatus
  - flowStatusMessage
```
public final String flowStatusMessage()
```
    Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
    
    Returns:
    
    Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
  - sourceFlowConfig
```
public final SourceFlowConfig sourceFlowConfig()
```
    The configuration that controls how Amazon AppFlow retrieves data from the source connector.
    
    Returns:
    
    The configuration that controls how Amazon AppFlow retrieves data from the source connector.
  - hasDestinationFlowConfigList
```
public final boolean hasDestinationFlowConfigList()
```
    Returns true if the DestinationFlowConfigList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - destinationFlowConfigList
```
public final List<DestinationFlowConfig> destinationFlowConfigList()
```
    The configuration that controls how Amazon AppFlow transfers data to the destination connector.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDestinationFlowConfigList() to see if a value was sent in this field.
    
    Returns:
    
    The configuration that controls how Amazon AppFlow transfers data to the destination connector.
  - lastRunExecutionDetails
```
public final ExecutionDetails lastRunExecutionDetails()
```
    Describes the details of the most recent flow run.
    
    Returns:
    
    Describes the details of the most recent flow run.
  - triggerConfig
```
public final TriggerConfig triggerConfig()
```
    The trigger settings that determine how and when the flow runs.
    
    Returns:
    
    The trigger settings that determine how and when the flow runs.
  - hasTasks
```
public final boolean hasTasks()
```
    Returns true if the Tasks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tasks
```
public final List<Task> tasks()
```
    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTasks() to see if a value was sent in this field.
    
    Returns:
    
    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
  - createdAt
```
public final Instant createdAt()
```
    Specifies when the flow was created.
    
    Returns:
    
    Specifies when the flow was created.
  - lastUpdatedAt
```
public final Instant lastUpdatedAt()
```
    Specifies when the flow was last updated.
    
    Returns:
    
    Specifies when the flow was last updated.
  - createdBy
```
public final String createdBy()
```
    The ARN of the user who created the flow.
    
    Returns:
    
    The ARN of the user who created the flow.
  - lastUpdatedBy
```
public final String lastUpdatedBy()
```
    Specifies the user name of the account that performed the most recent update.
    
    Returns:
    
    Specifies the user name of the account that performed the most recent update.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for your flow.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags used to organize, track, or control access for your flow.
  - toBuilder
```
public DescribeFlowResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeFlowResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeFlowResponse.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 DescribeFlowResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.appflow.model.AppflowResponse

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

flowArn

description

flowName

kmsArn

flowStatus

flowStatusAsString

flowStatusMessage

sourceFlowConfig

hasDestinationFlowConfigList

destinationFlowConfigList

lastRunExecutionDetails

triggerConfig

hasTasks

tasks

createdAt

lastUpdatedAt

createdBy

lastUpdatedBy

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields