FlowDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.customerprofiles.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 configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

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`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the flow you want to create.
`String`	`getFlowName()` The specified name of the flow.
`String`	`getKmsArn()` The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
`SourceFlowConfig`	`getSourceFlowConfig()` The configuration that controls how Customer Profiles retrieves data from the source.
`List<Task>`	`getTasks()` A list of tasks that Customer Profiles 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A description of the flow you want to create.
`void`	`setFlowName(String flowName)` The specified name of the flow.
`void`	`setKmsArn(String kmsArn)` The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
`void`	`setSourceFlowConfig(SourceFlowConfig sourceFlowConfig)` The configuration that controls how Customer Profiles retrieves data from the source.
`void`	`setTasks(Collection<Task> tasks)` A list of tasks that Customer Profiles 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.
`FlowDefinition`	`withDescription(String description)` A description of the flow you want to create.
`FlowDefinition`	`withFlowName(String flowName)` The specified name of the flow.
`FlowDefinition`	`withKmsArn(String kmsArn)` The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
`FlowDefinition`	`withSourceFlowConfig(SourceFlowConfig sourceFlowConfig)` The configuration that controls how Customer Profiles retrieves data from the source.
`FlowDefinition`	`withTasks(Collection<Task> tasks)` A list of tasks that Customer Profiles performs while transferring the data in the flow run.
`FlowDefinition`	`withTasks(Task... tasks)` A list of tasks that Customer Profiles performs while transferring the data in the flow run.
`FlowDefinition`	`withTriggerConfig(TriggerConfig triggerConfig)` The trigger settings that determine how and when the flow runs.

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

- Constructor Detail
  - FlowDefinition
```
public FlowDefinition()
```
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    A description of the flow you want to create.
    
    Parameters:
    
    description - A description of the flow you want to create.
  - getDescription
```
public String getDescription()
```
    A description of the flow you want to create.
    
    Returns:
    
    A description of the flow you want to create.
  - withDescription
```
public FlowDefinition withDescription(String description)
```
    A description of the flow you want to create.
    
    Parameters:
    
    description - A description of the flow you want to create.
    
    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. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
    
    Parameters:
    
    flowName - The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
  - getFlowName
```
public String getFlowName()
```
    The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
    
    Returns:
    
    The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
  - withFlowName
```
public FlowDefinition withFlowName(String flowName)
```
    The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
    
    Parameters:
    
    flowName - The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsArn
```
public void setKmsArn(String kmsArn)
```
    The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
    
    Parameters:
    
    kmsArn - The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
  - getKmsArn
```
public String getKmsArn()
```
    The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
    
    Returns:
    
    The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
  - withKmsArn
```
public FlowDefinition withKmsArn(String kmsArn)
```
    The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
    
    Parameters:
    
    kmsArn - The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceFlowConfig
```
public void setSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
```
    The configuration that controls how Customer Profiles retrieves data from the source.
    
    Parameters:
    
    sourceFlowConfig - The configuration that controls how Customer Profiles retrieves data from the source.
  - getSourceFlowConfig
```
public SourceFlowConfig getSourceFlowConfig()
```
    The configuration that controls how Customer Profiles retrieves data from the source.
    
    Returns:
    
    The configuration that controls how Customer Profiles retrieves data from the source.
  - withSourceFlowConfig
```
public FlowDefinition withSourceFlowConfig(SourceFlowConfig sourceFlowConfig)
```
    The configuration that controls how Customer Profiles retrieves data from the source.
    
    Parameters:
    
    sourceFlowConfig - The configuration that controls how Customer Profiles retrieves data from the source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTasks
```
public List<Task> getTasks()
```
    A list of tasks that Customer Profiles performs while transferring the data in the flow run.
    
    Returns:
    
    A list of tasks that Customer Profiles performs while transferring the data in the flow run.
  - setTasks
```
public void setTasks(Collection<Task> tasks)
```
    A list of tasks that Customer Profiles performs while transferring the data in the flow run.
    
    Parameters:
    
    tasks - A list of tasks that Customer Profiles performs while transferring the data in the flow run.
  - withTasks
```
public FlowDefinition withTasks(Task... tasks)
```
    A list of tasks that Customer Profiles 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.
    
    Parameters:
    
    tasks - A list of tasks that Customer Profiles performs while transferring the data in the flow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTasks
```
public FlowDefinition withTasks(Collection<Task> tasks)
```
    A list of tasks that Customer Profiles performs while transferring the data in the flow run.
    
    Parameters:
    
    tasks - A list of tasks that Customer Profiles performs while transferring the data in the flow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTriggerConfig
```
public void setTriggerConfig(TriggerConfig triggerConfig)
```
    The trigger settings that determine how and when the flow runs.
    
    Parameters:
    
    triggerConfig - The trigger settings that determine how and when the flow runs.
  - getTriggerConfig
```
public TriggerConfig getTriggerConfig()
```
    The trigger settings that determine how and when the flow runs.
    
    Returns:
    
    The trigger settings that determine how and when the flow runs.
  - withTriggerConfig
```
public FlowDefinition withTriggerConfig(TriggerConfig triggerConfig)
```
    The trigger settings that determine how and when the flow runs.
    
    Parameters:
    
    triggerConfig - The trigger settings that determine how and when the flow runs.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class FlowDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowDefinition

Method Detail

setDescription

getDescription

withDescription

setFlowName

getFlowName

withFlowName

setKmsArn

getKmsArn

withKmsArn

setSourceFlowConfig

getSourceFlowConfig

withSourceFlowConfig

getTasks

setTasks

withTasks

withTasks

setTriggerConfig

getTriggerConfig

withTriggerConfig

toString

equals

hashCode

clone

marshall