Class MetaFlowSummary

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

Contains summary information about a WhatsApp Flow, including its ID, name, status, and categories.

See Also:

  • Method Details

    • flowId

      public final String flowId()

      The unique identifier of the Flow assigned by Meta.

      Returns:
      The unique identifier of the Flow assigned by Meta.

    • flowName

      public final String flowName()

      The name of the Flow.

      Returns:
      The name of the Flow.

    • flowStatus

      public final String flowStatus()

      The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).

      Returns:
      The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).

    • flowCategories

      public final List<MetaFlowCategory> flowCategories()

      The categories that classify the business purpose of 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 hasFlowCategories() method.

      Returns:
      The categories that classify the business purpose of the Flow.

    • hasFlowCategories

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

    • flowCategoriesAsStrings

      public final List<String> flowCategoriesAsStrings()

      The categories that classify the business purpose of 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 hasFlowCategories() method.

      Returns:
      The categories that classify the business purpose of the Flow.

    • hasValidationErrors

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

    • validationErrors

      public final List<String> validationErrors()

      A list of validation errors from Meta, if any.

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

      Returns:
      A list of validation errors from Meta, if any.

    • toBuilder

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

    • builder

      public static MetaFlowSummary.Builder builder()

    • serializableBuilderClass

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