@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeFlowResult() |
Modifier and Type | Method and Description |
---|---|
DescribeFlowResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
DescribeFlowResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
DescribeFlowResult |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedAt()
Specifies when the flow was created.
|
String |
getCreatedBy()
The ARN of the user who created the flow.
|
String |
getDescription()
A description of the flow.
|
List<DestinationFlowConfig> |
getDestinationFlowConfigList()
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
|
String |
getFlowArn()
The flow's Amazon Resource Name (ARN).
|
String |
getFlowName()
The specified name of the flow.
|
String |
getFlowStatus()
Indicates the current status of the flow.
|
String |
getFlowStatusMessage()
Contains an error message if the flow status is in a suspended or error state.
|
String |
getKmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
ExecutionDetails |
getLastRunExecutionDetails()
Describes the details of the most recent flow run.
|
List<MetadataCatalogDetail> |
getLastRunMetadataCatalogDetails()
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
flow run.
|
Date |
getLastUpdatedAt()
Specifies when the flow was last updated.
|
String |
getLastUpdatedBy()
Specifies the user name of the account that performed the most recent update.
|
MetadataCatalogConfig |
getMetadataCatalogConfig()
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow.
|
Long |
getSchemaVersion()
The version number of your data schema.
|
SourceFlowConfig |
getSourceFlowConfig()
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
|
Map<String,String> |
getTags()
The tags used to organize, track, or control access for your flow.
|
List<Task> |
getTasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
TriggerConfig |
getTriggerConfig()
The trigger settings that determine how and when the flow runs.
|
int |
hashCode() |
void |
setCreatedAt(Date createdAt)
Specifies when the flow was created.
|
void |
setCreatedBy(String createdBy)
The ARN of the user who created the flow.
|
void |
setDescription(String description)
A description of the flow.
|
void |
setDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
|
void |
setFlowArn(String flowArn)
The flow's Amazon Resource Name (ARN).
|
void |
setFlowName(String flowName)
The specified name of the flow.
|
void |
setFlowStatus(String flowStatus)
Indicates the current status of the flow.
|
void |
setFlowStatusMessage(String flowStatusMessage)
Contains an error message if the flow status is in a suspended or error state.
|
void |
setKmsArn(String kmsArn)
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
void |
setLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
Describes the details of the most recent flow run.
|
void |
setLastRunMetadataCatalogDetails(Collection<MetadataCatalogDetail> lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
flow run.
|
void |
setLastUpdatedAt(Date lastUpdatedAt)
Specifies when the flow was last updated.
|
void |
setLastUpdatedBy(String lastUpdatedBy)
Specifies the user name of the account that performed the most recent update.
|
void |
setMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow.
|
void |
setSchemaVersion(Long schemaVersion)
The version number of your data schema.
|
void |
setSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
|
void |
setTags(Map<String,String> tags)
The tags used to organize, track, or control access for your flow.
|
void |
setTasks(Collection<Task> tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
void |
setTriggerConfig(TriggerConfig triggerConfig)
The trigger settings that determine how and when the flow runs.
|
String |
toString()
Returns a string representation of this object.
|
DescribeFlowResult |
withCreatedAt(Date createdAt)
Specifies when the flow was created.
|
DescribeFlowResult |
withCreatedBy(String createdBy)
The ARN of the user who created the flow.
|
DescribeFlowResult |
withDescription(String description)
A description of the flow.
|
DescribeFlowResult |
withDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
|
DescribeFlowResult |
withDestinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
|
DescribeFlowResult |
withFlowArn(String flowArn)
The flow's Amazon Resource Name (ARN).
|
DescribeFlowResult |
withFlowName(String flowName)
The specified name of the flow.
|
DescribeFlowResult |
withFlowStatus(FlowStatus flowStatus)
Indicates the current status of the flow.
|
DescribeFlowResult |
withFlowStatus(String flowStatus)
Indicates the current status of the flow.
|
DescribeFlowResult |
withFlowStatusMessage(String flowStatusMessage)
Contains an error message if the flow status is in a suspended or error state.
|
DescribeFlowResult |
withKmsArn(String kmsArn)
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
DescribeFlowResult |
withLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
Describes the details of the most recent flow run.
|
DescribeFlowResult |
withLastRunMetadataCatalogDetails(Collection<MetadataCatalogDetail> lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
flow run.
|
DescribeFlowResult |
withLastRunMetadataCatalogDetails(MetadataCatalogDetail... lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
flow run.
|
DescribeFlowResult |
withLastUpdatedAt(Date lastUpdatedAt)
Specifies when the flow was last updated.
|
DescribeFlowResult |
withLastUpdatedBy(String lastUpdatedBy)
Specifies the user name of the account that performed the most recent update.
|
DescribeFlowResult |
withMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow.
|
DescribeFlowResult |
withSchemaVersion(Long schemaVersion)
The version number of your data schema.
|
DescribeFlowResult |
withSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
|
DescribeFlowResult |
withTags(Map<String,String> tags)
The tags used to organize, track, or control access for your flow.
|
DescribeFlowResult |
withTasks(Collection<Task> tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
DescribeFlowResult |
withTasks(Task... tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
DescribeFlowResult |
withTriggerConfig(TriggerConfig triggerConfig)
The trigger settings that determine how and when the flow runs.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setFlowArn(String flowArn)
The flow's Amazon Resource Name (ARN).
flowArn
- The flow's Amazon Resource Name (ARN).public String getFlowArn()
The flow's Amazon Resource Name (ARN).
public DescribeFlowResult withFlowArn(String flowArn)
The flow's Amazon Resource Name (ARN).
flowArn
- The flow's Amazon Resource Name (ARN).public void setDescription(String description)
A description of the flow.
description
- A description of the flow.public String getDescription()
A description of the flow.
public DescribeFlowResult withDescription(String description)
A description of the flow.
description
- A description of the flow.public void setFlowName(String flowName)
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
flowName
- The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.public String getFlowName()
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
public DescribeFlowResult withFlowName(String flowName)
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
flowName
- The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.public void setKmsArn(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.
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.public String getKmsArn()
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.
public DescribeFlowResult withKmsArn(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.
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.public void setFlowStatus(String flowStatus)
Indicates the current status of the flow.
flowStatus
- Indicates the current status of the flow.FlowStatus
public String getFlowStatus()
Indicates the current status of the flow.
FlowStatus
public DescribeFlowResult withFlowStatus(String flowStatus)
Indicates the current status of the flow.
flowStatus
- Indicates the current status of the flow.FlowStatus
public DescribeFlowResult withFlowStatus(FlowStatus flowStatus)
Indicates the current status of the flow.
flowStatus
- Indicates the current status of the flow.FlowStatus
public void setFlowStatusMessage(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.
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.public String getFlowStatusMessage()
Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
public DescribeFlowResult withFlowStatusMessage(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.
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.public void setSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
sourceFlowConfig
- The configuration that controls how Amazon AppFlow retrieves data from the source connector.public SourceFlowConfig getSourceFlowConfig()
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
public DescribeFlowResult withSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
sourceFlowConfig
- The configuration that controls how Amazon AppFlow retrieves data from the source connector.public List<DestinationFlowConfig> getDestinationFlowConfigList()
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
public void setDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
destinationFlowConfigList
- The configuration that controls how Amazon AppFlow transfers data to the destination connector.public DescribeFlowResult withDestinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
NOTE: This method appends the values to the existing list (if any). Use
setDestinationFlowConfigList(java.util.Collection)
or
withDestinationFlowConfigList(java.util.Collection)
if you want to override the existing values.
destinationFlowConfigList
- The configuration that controls how Amazon AppFlow transfers data to the destination connector.public DescribeFlowResult withDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
destinationFlowConfigList
- The configuration that controls how Amazon AppFlow transfers data to the destination connector.public void setLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
Describes the details of the most recent flow run.
lastRunExecutionDetails
- Describes the details of the most recent flow run.public ExecutionDetails getLastRunExecutionDetails()
Describes the details of the most recent flow run.
public DescribeFlowResult withLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
Describes the details of the most recent flow run.
lastRunExecutionDetails
- Describes the details of the most recent flow run.public void setTriggerConfig(TriggerConfig triggerConfig)
The trigger settings that determine how and when the flow runs.
triggerConfig
- The trigger settings that determine how and when the flow runs.public TriggerConfig getTriggerConfig()
The trigger settings that determine how and when the flow runs.
public DescribeFlowResult withTriggerConfig(TriggerConfig triggerConfig)
The trigger settings that determine how and when the flow runs.
triggerConfig
- The trigger settings that determine how and when the flow runs.public List<Task> getTasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
public void setTasks(Collection<Task> tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
tasks
- A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.public DescribeFlowResult withTasks(Task... tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
NOTE: This method appends the values to the existing list (if any). Use
setTasks(java.util.Collection)
or withTasks(java.util.Collection)
if you want to override the
existing values.
tasks
- A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.public DescribeFlowResult withTasks(Collection<Task> tasks)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
tasks
- A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.public void setCreatedAt(Date createdAt)
Specifies when the flow was created.
createdAt
- Specifies when the flow was created.public Date getCreatedAt()
Specifies when the flow was created.
public DescribeFlowResult withCreatedAt(Date createdAt)
Specifies when the flow was created.
createdAt
- Specifies when the flow was created.public void setLastUpdatedAt(Date lastUpdatedAt)
Specifies when the flow was last updated.
lastUpdatedAt
- Specifies when the flow was last updated.public Date getLastUpdatedAt()
Specifies when the flow was last updated.
public DescribeFlowResult withLastUpdatedAt(Date lastUpdatedAt)
Specifies when the flow was last updated.
lastUpdatedAt
- Specifies when the flow was last updated.public void setCreatedBy(String createdBy)
The ARN of the user who created the flow.
createdBy
- The ARN of the user who created the flow.public String getCreatedBy()
The ARN of the user who created the flow.
public DescribeFlowResult withCreatedBy(String createdBy)
The ARN of the user who created the flow.
createdBy
- The ARN of the user who created the flow.public void setLastUpdatedBy(String lastUpdatedBy)
Specifies the user name of the account that performed the most recent update.
lastUpdatedBy
- Specifies the user name of the account that performed the most recent update.public String getLastUpdatedBy()
Specifies the user name of the account that performed the most recent update.
public DescribeFlowResult withLastUpdatedBy(String lastUpdatedBy)
Specifies the user name of the account that performed the most recent update.
lastUpdatedBy
- Specifies the user name of the account that performed the most recent update.public Map<String,String> getTags()
The tags used to organize, track, or control access for your flow.
public void setTags(Map<String,String> tags)
The tags used to organize, track, or control access for your flow.
tags
- The tags used to organize, track, or control access for your flow.public DescribeFlowResult withTags(Map<String,String> tags)
The tags used to organize, track, or control access for your flow.
tags
- The tags used to organize, track, or control access for your flow.public DescribeFlowResult addTagsEntry(String key, String value)
public DescribeFlowResult clearTagsEntries()
public void setMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
metadataCatalogConfig
- Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.public MetadataCatalogConfig getMetadataCatalogConfig()
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
public DescribeFlowResult withMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
metadataCatalogConfig
- Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.public List<MetadataCatalogDetail> getLastRunMetadataCatalogDetails()
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
public void setLastRunMetadataCatalogDetails(Collection<MetadataCatalogDetail> lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
lastRunMetadataCatalogDetails
- Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the
associated flow run.public DescribeFlowResult withLastRunMetadataCatalogDetails(MetadataCatalogDetail... lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
NOTE: This method appends the values to the existing list (if any). Use
setLastRunMetadataCatalogDetails(java.util.Collection)
or
withLastRunMetadataCatalogDetails(java.util.Collection)
if you want to override the existing values.
lastRunMetadataCatalogDetails
- Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the
associated flow run.public DescribeFlowResult withLastRunMetadataCatalogDetails(Collection<MetadataCatalogDetail> lastRunMetadataCatalogDetails)
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
lastRunMetadataCatalogDetails
- Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the
associated flow run.public void setSchemaVersion(Long schemaVersion)
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
schemaVersion
- The version number of your data schema. Amazon AppFlow assigns this version number. The version number
increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
public Long getSchemaVersion()
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
Source-to-destination field mappings
Field data types
Partition keys
public DescribeFlowResult withSchemaVersion(Long schemaVersion)
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
schemaVersion
- The version number of your data schema. Amazon AppFlow assigns this version number. The version number
increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
public String toString()
toString
in class Object
Object.toString()
public DescribeFlowResult clone()