Class CreateWhatsAppFlowRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.socialmessaging.model.SocialMessagingRequest
software.amazon.awssdk.services.socialmessaging.model.CreateWhatsAppFlowRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWhatsAppFlowRequest.Builder,CreateWhatsAppFlowRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWhatsAppFlowRequest extends SocialMessagingRequest implements ToCopyableBuilder<CreateWhatsAppFlowRequest.Builder,CreateWhatsAppFlowRequest>

  • Method Details

    • id

      public final String id()

      The ID of the WhatsApp Business Account to associate with this Flow.

      Returns:
      The ID of the WhatsApp Business Account to associate with this Flow.

    • flowName

      public final String flowName()

      The name of the Flow. Must be unique within the WhatsApp Business Account.

      Returns:
      The name of the Flow. Must be unique within the WhatsApp Business Account.

    • categories

      public final List<MetaFlowCategory> categories()

      The categories that classify the business purpose of the Flow. At least one category is required.

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

      Returns:
      The categories that classify the business purpose of the Flow. At least one category is required.

    • hasCategories

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

    • categoriesAsStrings

      public final List<String> categoriesAsStrings()

      The categories that classify the business purpose of the Flow. At least one category is required.

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

      Returns:
      The categories that classify the business purpose of the Flow. At least one category is required.

    • flowJson

      public final SdkBytes flowJson()

      The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.

      Returns:
      The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.

    • publish

      public final Boolean publish()

      Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta's validation.

      Returns:
      Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta's validation.

    • cloneFlowId

      public final String cloneFlowId()

      The ID of an existing Flow within the same WhatsApp Business Account to clone.

      Returns:
      The ID of an existing Flow within the same WhatsApp Business Account to clone.

    • toBuilder

      public CreateWhatsAppFlowRequest.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<CreateWhatsAppFlowRequest.Builder,CreateWhatsAppFlowRequest>
      Specified by:
      toBuilder in class SocialMessagingRequest
      Returns:
      a builder for type T

    • builder

      public static CreateWhatsAppFlowRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWhatsAppFlowRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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