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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.