qbusiness/aws.sdk.kotlin.services.qbusiness.model/ActionReviewPayloadField/Builder

Builder

Properties

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.

allowedValues

var allowedValues: List<ActionReviewPayloadFieldAllowedValue>?

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.

arrayItemJsonSchema

var arrayItemJsonSchema: Document?

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

displayDescription

var displayDescription: String?

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.

displayName

var displayName: String?

The name of the field.

displayOrder

var displayOrder: Int?

The display order of fields in a payload.

required

var required: Boolean?

Information about whether the field is required.

type

var type: ActionPayloadFieldType?

The type of field.

value

var value: Document?

The field value.