FlowDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appflow.model.FlowDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FlowDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The properties of the flow, such as its source, destination, trigger type, and so on.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FlowDefinition()

Constructors
Constructor and Description
`FlowDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FlowDefinition`	`addTagsEntry(String key, String value)` Add a single Tags entry
`FlowDefinition`	`clearTagsEntries()` Removes all the entries added into Tags.
`FlowDefinition`	`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 user-entered description of the flow.
`String`	`getDestinationConnectorType()` Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`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.
`ExecutionDetails`	`getLastRunExecutionDetails()` Describes the details of the most recent flow run.
`Date`	`getLastUpdatedAt()` Specifies when the flow was last updated.
`String`	`getLastUpdatedBy()` Specifies the account user name that most recently updated the flow.
`String`	`getSourceConnectorType()` Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for your flow.
`String`	`getTriggerType()` Specifies the type of flow trigger.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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 user-entered description of the flow.
`void`	`setDestinationConnectorType(String destinationConnectorType)` Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`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`	`setLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)` Describes the details of the most recent flow run.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` Specifies when the flow was last updated.
`void`	`setLastUpdatedBy(String lastUpdatedBy)` Specifies the account user name that most recently updated the flow.
`void`	`setSourceConnectorType(String sourceConnectorType)` Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for your flow.
`void`	`setTriggerType(String triggerType)` Specifies the type of flow trigger.
`String`	`toString()` Returns a string representation of this object.
`FlowDefinition`	`withCreatedAt(Date createdAt)` Specifies when the flow was created.
`FlowDefinition`	`withCreatedBy(String createdBy)` The ARN of the user who created the flow.
`FlowDefinition`	`withDescription(String description)` A user-entered description of the flow.
`FlowDefinition`	`withDestinationConnectorType(ConnectorType destinationConnectorType)` Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`FlowDefinition`	`withDestinationConnectorType(String destinationConnectorType)` Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`FlowDefinition`	`withFlowArn(String flowArn)` The flow's Amazon Resource Name (ARN).
`FlowDefinition`	`withFlowName(String flowName)` The specified name of the flow.
`FlowDefinition`	`withFlowStatus(FlowStatus flowStatus)` Indicates the current status of the flow.
`FlowDefinition`	`withFlowStatus(String flowStatus)` Indicates the current status of the flow.
`FlowDefinition`	`withLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)` Describes the details of the most recent flow run.
`FlowDefinition`	`withLastUpdatedAt(Date lastUpdatedAt)` Specifies when the flow was last updated.
`FlowDefinition`	`withLastUpdatedBy(String lastUpdatedBy)` Specifies the account user name that most recently updated the flow.
`FlowDefinition`	`withSourceConnectorType(ConnectorType sourceConnectorType)` Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`FlowDefinition`	`withSourceConnectorType(String sourceConnectorType)` Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
`FlowDefinition`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for your flow.
`FlowDefinition`	`withTriggerType(String triggerType)` Specifies the type of flow trigger.
`FlowDefinition`	`withTriggerType(TriggerType triggerType)` Specifies the type of flow trigger.

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

- Constructor Detail
  - FlowDefinition
```
public FlowDefinition()
```
- Method Detail
  - setFlowArn
```
public void setFlowArn(String flowArn)
```
    The flow's Amazon Resource Name (ARN).
    
    Parameters:
    
    flowArn - The flow's Amazon Resource Name (ARN).
  - getFlowArn
```
public String getFlowArn()
```
    The flow's Amazon Resource Name (ARN).
    
    Returns:
    
    The flow's Amazon Resource Name (ARN).
  - withFlowArn
```
public FlowDefinition withFlowArn(String flowArn)
```
    The flow's Amazon Resource Name (ARN).
    
    Parameters:
    
    flowArn - The flow's Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A user-entered description of the flow.
    
    Parameters:
    
    description - A user-entered description of the flow.
  - getDescription
```
public String getDescription()
```
    A user-entered description of the flow.
    
    Returns:
    
    A user-entered description of the flow.
  - withDescription
```
public FlowDefinition withDescription(String description)
```
    A user-entered description of the flow.
    
    Parameters:
    
    description - A user-entered description of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowName
```
public void setFlowName(String flowName)
```
    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    
    Parameters:
    
    flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
  - getFlowName
```
public String getFlowName()
```
    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.
  - withFlowName
```
public FlowDefinition withFlowName(String flowName)
```
    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    
    Parameters:
    
    flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowStatus
```
public void setFlowStatus(String flowStatus)
```
    Indicates the current status of the flow.
    
    Parameters:
    
    flowStatus - Indicates the current status of the flow.
    
    See Also:
    
    FlowStatus
  - getFlowStatus
```
public String getFlowStatus()
```
    Indicates the current status of the flow.
    
    Returns:
    
    Indicates the current status of the flow.
    
    See Also:
    
    FlowStatus
  - withFlowStatus
```
public FlowDefinition withFlowStatus(String flowStatus)
```
    Indicates the current status of the flow.
    
    Parameters:
    
    flowStatus - Indicates the current status of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlowStatus
  - withFlowStatus
```
public FlowDefinition withFlowStatus(FlowStatus flowStatus)
```
    Indicates the current status of the flow.
    
    Parameters:
    
    flowStatus - Indicates the current status of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FlowStatus
  - setSourceConnectorType
```
public void setSourceConnectorType(String sourceConnectorType)
```
    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    sourceConnectorType - Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    See Also:
    
    ConnectorType
  - getSourceConnectorType
```
public String getSourceConnectorType()
```
    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    See Also:
    
    ConnectorType
  - withSourceConnectorType
```
public FlowDefinition withSourceConnectorType(String sourceConnectorType)
```
    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    sourceConnectorType - Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectorType
  - withSourceConnectorType
```
public FlowDefinition withSourceConnectorType(ConnectorType sourceConnectorType)
```
    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    sourceConnectorType - Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectorType
  - setDestinationConnectorType
```
public void setDestinationConnectorType(String destinationConnectorType)
```
    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    destinationConnectorType - Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    See Also:
    
    ConnectorType
  - getDestinationConnectorType
```
public String getDestinationConnectorType()
```
    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    See Also:
    
    ConnectorType
  - withDestinationConnectorType
```
public FlowDefinition withDestinationConnectorType(String destinationConnectorType)
```
    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    destinationConnectorType - Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectorType
  - withDestinationConnectorType
```
public FlowDefinition withDestinationConnectorType(ConnectorType destinationConnectorType)
```
    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Parameters:
    
    destinationConnectorType - Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectorType
  - setTriggerType
```
public void setTriggerType(String triggerType)
```
    Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Parameters:
    
    triggerType - Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    See Also:
    
    TriggerType
  - getTriggerType
```
public String getTriggerType()
```
    Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Returns:
    
    Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    See Also:
    
    TriggerType
  - withTriggerType
```
public FlowDefinition withTriggerType(String triggerType)
```
    Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Parameters:
    
    triggerType - Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TriggerType
  - withTriggerType
```
public FlowDefinition withTriggerType(TriggerType triggerType)
```
    Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Parameters:
    
    triggerType - Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TriggerType
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Specifies when the flow was created.
    
    Parameters:
    
    createdAt - Specifies when the flow was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    Specifies when the flow was created.
    
    Returns:
    
    Specifies when the flow was created.
  - withCreatedAt
```
public FlowDefinition withCreatedAt(Date createdAt)
```
    Specifies when the flow was created.
    
    Parameters:
    
    createdAt - Specifies when the flow was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    Specifies when the flow was last updated.
    
    Parameters:
    
    lastUpdatedAt - Specifies when the flow was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    Specifies when the flow was last updated.
    
    Returns:
    
    Specifies when the flow was last updated.
  - withLastUpdatedAt
```
public FlowDefinition withLastUpdatedAt(Date lastUpdatedAt)
```
    Specifies when the flow was last updated.
    
    Parameters:
    
    lastUpdatedAt - Specifies when the flow was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    The ARN of the user who created the flow.
    
    Parameters:
    
    createdBy - The ARN of the user who created the flow.
  - getCreatedBy
```
public String getCreatedBy()
```
    The ARN of the user who created the flow.
    
    Returns:
    
    The ARN of the user who created the flow.
  - withCreatedBy
```
public FlowDefinition withCreatedBy(String createdBy)
```
    The ARN of the user who created the flow.
    
    Parameters:
    
    createdBy - The ARN of the user who created the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedBy
```
public void setLastUpdatedBy(String lastUpdatedBy)
```
    Specifies the account user name that most recently updated the flow.
    
    Parameters:
    
    lastUpdatedBy - Specifies the account user name that most recently updated the flow.
  - getLastUpdatedBy
```
public String getLastUpdatedBy()
```
    Specifies the account user name that most recently updated the flow.
    
    Returns:
    
    Specifies the account user name that most recently updated the flow.
  - withLastUpdatedBy
```
public FlowDefinition withLastUpdatedBy(String lastUpdatedBy)
```
    Specifies the account user name that most recently updated the flow.
    
    Parameters:
    
    lastUpdatedBy - Specifies the account user name that most recently updated the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags used to organize, track, or control access for your flow.
    
    Returns:
    
    The tags used to organize, track, or control access for your flow.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for your flow.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for your flow.
  - withTags
```
public FlowDefinition withTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for your flow.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for your flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public FlowDefinition addTagsEntry(String key,
                                   String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public FlowDefinition clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastRunExecutionDetails
```
public void setLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
```
    Describes the details of the most recent flow run.
    
    Parameters:
    
    lastRunExecutionDetails - Describes the details of the most recent flow run.
  - getLastRunExecutionDetails
```
public ExecutionDetails getLastRunExecutionDetails()
```
    Describes the details of the most recent flow run.
    
    Returns:
    
    Describes the details of the most recent flow run.
  - withLastRunExecutionDetails
```
public FlowDefinition withLastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)
```
    Describes the details of the most recent flow run.
    
    Parameters:
    
    lastRunExecutionDetails - Describes the details of the most recent flow run.
    
    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 FlowDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FlowDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowDefinition

Method Detail

setFlowArn

getFlowArn

withFlowArn

setDescription

getDescription

withDescription

setFlowName

getFlowName

withFlowName

setFlowStatus

getFlowStatus

withFlowStatus

withFlowStatus

setSourceConnectorType

getSourceConnectorType

withSourceConnectorType

withSourceConnectorType

setDestinationConnectorType

getDestinationConnectorType

withDestinationConnectorType

withDestinationConnectorType

setTriggerType

getTriggerType

withTriggerType

withTriggerType

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setCreatedBy

getCreatedBy

withCreatedBy

setLastUpdatedBy

getLastUpdatedBy

withLastUpdatedBy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setLastRunExecutionDetails

getLastRunExecutionDetails

withLastRunExecutionDetails

toString

equals

hashCode

clone

marshall