Class FlowDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FlowDefinition.Builder,
FlowDefinition>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FlowDefinition.Builder
builder()
final String
A description of the flow you want to create.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
flowName()
The specified name of the flow.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTasks()
For responses, this returns true if the service returned a value for the Tasks property.final String
kmsArn()
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.static Class
<? extends FlowDefinition.Builder> final SourceFlowConfig
The configuration that controls how Customer Profiles retrieves data from the source.tasks()
A list of tasks that Customer Profiles performs while transferring the data in the flow run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TriggerConfig
The trigger settings that determine how and when the flow runs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
A description of the flow you want to create.
- Returns:
- A description of the flow you want to create.
-
flowName
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.
-
kmsArn
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.
-
sourceFlowConfig
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.
-
hasTasks
public final boolean hasTasks()For responses, this returns true if the service returned a value for the Tasks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tasks
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTasks()
method.- Returns:
- A list of tasks that Customer Profiles performs while transferring the data in the flow run.
-
triggerConfig
The trigger settings that determine how and when the flow runs.
- Returns:
- The trigger settings that determine how and when the flow runs.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FlowDefinition.Builder,
FlowDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-