Class ActionReviewPayloadField

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

A user input field in an plugin action review payload.

See Also:

  • Method Details

    • displayName

      public final String displayName()

      The name of the field.

      Returns:
      The name of the field.

    • displayOrder

      public final Integer displayOrder()

      The display order of fields in a payload.

      Returns:
      The display order of fields in a payload.

    • displayDescription

      public final String displayDescription()

      The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

      Returns:
      The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

    • type

      public final ActionPayloadFieldType type()

      The type of field.

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

      Returns:
      The type of field.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of field.

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

      Returns:
      The type of field.
      See Also:

    • value

      public final Document value()

      The field value.

      Returns:
      The field value.

    • hasAllowedValues

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

    • allowedValues

      public final List<ActionReviewPayloadFieldAllowedValue> allowedValues()

      Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

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

      Returns:
      Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

    • allowedFormat

      public final String allowedFormat()

      The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

      Returns:
      The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

    • arrayItemJsonSchema

      public final Document arrayItemJsonSchema()

      Use to create a custom form with array fields (fields with nested objects inside an array).

      Returns:
      Use to create a custom form with array fields (fields with nested objects inside an array).

    • required

      public final Boolean required()

      Information about whether the field is required.

      Returns:
      Information about whether the field is required.

    • toBuilder

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

    • builder

      public static ActionReviewPayloadField.Builder builder()

    • serializableBuilderClass

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