Struct ActionReviewPayloadField 

#[non_exhaustive]
pub struct ActionReviewPayloadField {
    pub display_name: Option<String>,
    pub display_order: Option<i32>,
    pub display_description: Option<String>,
    pub type: Option<ActionPayloadFieldType>,
    pub value: Option<Document>,
    pub allowed_values: Option<Vec<ActionReviewPayloadFieldAllowedValue>>,
    pub allowed_format: Option<String>,
    pub array_item_json_schema: Option<Document>,
    pub required: Option<bool>,
}

A user input field in an plugin action review payload.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

display_name: Option<String>

The name of the field.

display_order: Option<i32>

The display order of fields in a payload.

display_description: Option<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.

type: Option<ActionPayloadFieldType>

The type of field.

value: Option<Document>

The field value.

allowed_values: Option<Vec<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.

allowed_format: Option<String>

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.

array_item_json_schema: Option<Document>

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

required: Option<bool>

Information about whether the field is required.

Implementations

impl ActionReviewPayloadField

pub fn display_name(&self) -> Option<&str>

The name of the field.

pub fn display_order(&self) -> Option<i32>

The display order of fields in a payload.

pub fn display_description(&self) -> Option<&str>

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.

pub fn type(&self) -> Option<&ActionPayloadFieldType>

The type of field.

pub fn value(&self) -> Option<&Document>

The field value.

pub fn allowed_values(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_values.is_none().

pub fn allowed_format(&self) -> Option<&str>

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.

pub fn array_item_json_schema(&self) -> Option<&Document>

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

pub fn required(&self) -> Option<bool>

Information about whether the field is required.

impl ActionReviewPayloadField

pub fn builder() -> ActionReviewPayloadFieldBuilder

Creates a new builder-style object to manufacture ActionReviewPayloadField.

Trait Implementations

impl Clone for ActionReviewPayloadField

fn clone(&self) -> ActionReviewPayloadField

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActionReviewPayloadField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ActionReviewPayloadField

fn eq(&self, other: &ActionReviewPayloadField) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ActionReviewPayloadField