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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ActionReviewPayloadField.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`allowedFormat()`	The expected data format for the action review input field value.
`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.
`static ActionReviewPayloadField.Builder`	`builder()`
`String`	`displayDescription()`	The field level description of each action review input field.
`String`	`displayName()`	The name of the field.
`Integer`	`displayOrder()`	The display order of fields in a payload.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedValues()`	For responses, this returns true if the service returned a value for the AllowedValues property.
`int`	`hashCode()`
`Boolean`	`required()`	Information about whether the field is required.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ActionReviewPayloadField.Builder>`	`serializableBuilderClass()`
`ActionReviewPayloadField.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ActionPayloadFieldType`	`type()`	The type of field.
`String`	`typeAsString()`	The type of field.
`Document`	`value()`	The field value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ActionPayloadFieldType
  - 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:
    
    ActionPayloadFieldType
  - 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.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ActionReviewPayloadField.Builder,ActionReviewPayloadField>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ActionReviewPayloadField

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

displayName

displayOrder

displayDescription

type

typeAsString

value

hasAllowedValues

allowedValues

allowedFormat

required

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields