Class FlowDetail

java.lang.Object
software.amazon.awssdk.services.quicksight.model.FlowDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FlowDetail.Builder,FlowDetail>
@Generated("software.amazon.awssdk:codegen") public final class FlowDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FlowDetail.Builder,FlowDetail>

The full details of a flow, including its definition specifying the steps.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the flow.

      Returns:
      The Amazon Resource Name (ARN) of the flow.

    • flowId

      public final String flowId()

      The unique identifier of the flow.

      Returns:
      The unique identifier of the flow.

    • name

      public final String name()

      The display name of the flow.

      Returns:
      The display name of the flow.

    • description

      public final String description()

      The description of the flow.

      Returns:
      The description of the flow.

    • publishState

      public final FlowPublishState publishState()

      The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

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

      Returns:
      The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
      See Also:

    • publishStateAsString

      public final String publishStateAsString()

      The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

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

      Returns:
      The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
      See Also:

    • createdTime

      public final Instant createdTime()

      The time this flow was created.

      Returns:
      The time this flow was created.

    • createdBy

      public final String createdBy()

      The identifier of the principal who created the flow.

      Returns:
      The identifier of the principal who created the flow.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The last time this flow was modified.

      Returns:
      The last time this flow was modified.

    • lastUpdatedBy

      public final String lastUpdatedBy()

      The identifier of the last principal who updated the flow.

      Returns:
      The identifier of the last principal who updated the flow.

    • flowDefinition

      public final Document flowDefinition()

      The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

      Returns:
      The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

    • hasStepAliases

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

    • stepAliases

      public final List<StepAliasMapping> stepAliases()

      A list of step alias mappings for the 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 hasStepAliases() method.

      Returns:
      A list of step alias mappings for the flow.

    • toBuilder

      public FlowDetail.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<FlowDetail.Builder,FlowDetail>
      Returns:
      a builder for type T

    • builder

      public static FlowDetail.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FlowDetail.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.