Class CreateContactFlowRequest

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

  • Method Details

    • instanceId

      public final String instanceId()

      The identifier of the Amazon Connect instance.

      Returns:
      The identifier of the Amazon Connect instance.

    • name

      public final String name()

      The name of the flow.

      Returns:
      The name of the flow.

    • type

      public final ContactFlowType type()

      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

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

      Returns:
      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

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

      Returns:
      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
      See Also:

    • description

      public final String description()

      The description of the flow.

      Returns:
      The description of the flow.

    • content

      public final String content()

      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

      Length Constraints: Minimum length of 1. Maximum length of 256000.

      Returns:
      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

      Length Constraints: Minimum length of 1. Maximum length of 256000.

    • status

      public final ContactFlowStatus status()

      Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

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

      Returns:
      Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
      See Also:

    • statusAsString

      public final String statusAsString()

      Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

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

      Returns:
      Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
      See Also:

    • 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 this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      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 this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • toBuilder

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

    • builder

      public static CreateContactFlowRequest.Builder builder()

    • serializableBuilderClass

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