Class FlowDefinition

java.lang.Object
software.amazon.awssdk.services.appflow.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 properties of the flow, such as its source, destination, trigger type, and so on.

See Also:

  • Method Details

    • flowArn

      public final String flowArn()

      The flow's Amazon Resource Name (ARN).

      Returns:
      The flow's Amazon Resource Name (ARN).

    • description

      public final String description()

      A user-entered description of the flow.

      Returns:
      A user-entered description of the flow.

    • flowName

      public final String flowName()

      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.

    • flowStatus

      public final FlowStatus flowStatus()

      Indicates the current status of the flow.

      If the service returns an enum value that is not available in the current SDK version, flowStatus will return FlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowStatusAsString().

      Returns:
      Indicates the current status of the flow.
      See Also:

    • flowStatusAsString

      public final String flowStatusAsString()

      Indicates the current status of the flow.

      If the service returns an enum value that is not available in the current SDK version, flowStatus will return FlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowStatusAsString().

      Returns:
      Indicates the current status of the flow.
      See Also:

    • sourceConnectorType

      public final ConnectorType sourceConnectorType()

      Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, sourceConnectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceConnectorTypeAsString().

      Returns:
      Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
      See Also:

    • sourceConnectorTypeAsString

      public final String sourceConnectorTypeAsString()

      Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, sourceConnectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceConnectorTypeAsString().

      Returns:
      Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
      See Also:

    • sourceConnectorLabel

      public final String sourceConnectorLabel()

      The label of the source connector in the flow.

      Returns:
      The label of the source connector in the flow.

    • destinationConnectorType

      public final ConnectorType destinationConnectorType()

      Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, destinationConnectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationConnectorTypeAsString().

      Returns:
      Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
      See Also:

    • destinationConnectorTypeAsString

      public final String destinationConnectorTypeAsString()

      Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

      If the service returns an enum value that is not available in the current SDK version, destinationConnectorType will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationConnectorTypeAsString().

      Returns:
      Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
      See Also:

    • destinationConnectorLabel

      public final String destinationConnectorLabel()

      The label of the destination connector in the flow.

      Returns:
      The label of the destination connector in the flow.

    • triggerType

      public final TriggerType triggerType()

      Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

      If the service returns an enum value that is not available in the current SDK version, triggerType will return TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerTypeAsString().

      Returns:
      Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
      See Also:

    • triggerTypeAsString

      public final String triggerTypeAsString()

      Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

      If the service returns an enum value that is not available in the current SDK version, triggerType will return TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerTypeAsString().

      Returns:
      Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
      See Also:

    • createdAt

      public final Instant createdAt()

      Specifies when the flow was created.

      Returns:
      Specifies when the flow was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      Specifies when the flow was last updated.

      Returns:
      Specifies when the flow was last updated.

    • createdBy

      public final String createdBy()

      The ARN of the user who created the flow.

      Returns:
      The ARN of the user who created the flow.

    • lastUpdatedBy

      public final String lastUpdatedBy()

      Specifies the account user name that most recently updated the flow.

      Returns:
      Specifies the account user name that most recently updated the flow.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for your flow.

      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 hasTags() method.

      Returns:
      The tags used to organize, track, or control access for your flow.

    • lastRunExecutionDetails

      public final ExecutionDetails lastRunExecutionDetails()

      Describes the details of the most recent flow run.

      Returns:
      Describes the details of the most recent flow run.

    • 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.