Package software.amazon.awssdk.services.customerprofiles.model

Class FlowDefinition

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.FlowDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class FlowDefinition
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static FlowDefinition.Builder	builder()
String	description()	A description of the flow you want to create.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flowName()	The specified name of the flow.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTasks()	For responses, this returns true if the service returned a value for the Tasks property.
String	kmsArn()	The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends FlowDefinition.Builder>	serializableBuilderClass()
SourceFlowConfig	sourceFlowConfig()	The configuration that controls how Customer Profiles retrieves data from the source.
List<Task>	tasks()	A list of tasks that Customer Profiles performs while transferring the data in the flow run.
FlowDefinition.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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public final String description()

A description of the flow you want to create.

Returns:

A description of the flow you want to create.

flowName

public final String 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

public final String 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

public final SourceFlowConfig 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 the isEmpty() 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

public final List<Task> 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

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.

toBuilder

public FlowDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>

builder

public static FlowDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends FlowDefinition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo