Class FlowSummary

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

The basic information of the flow exluding 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.

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

    • publishState

      public final FlowPublishState publishState()

      The publish state for the flow. The 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 for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
      See Also:

    • publishStateAsString

      public final String publishStateAsString()

      The publish state for the flow. The 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 for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
      See Also:

    • runCount

      public final Integer runCount()

      The number of runs done for the flow.

      Returns:
      The number of runs done for the flow.

    • userCount

      public final Integer userCount()

      The number of users who have used the flow.

      Returns:
      The number of users who have used the flow.

    • lastPublishedBy

      public final String lastPublishedBy()

      The identifier of the last principal who published the flow.

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

    • lastPublishedAt

      public final Instant lastPublishedAt()

      The last time this flow was published.

      Returns:
      The last time this flow was published.

    • toBuilder

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

    • builder

      public static FlowSummary.Builder builder()

    • serializableBuilderClass

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