Class: Aws::QBusiness::Types::ActionReviewPayloadField

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::ActionReviewPayloadField

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

A user input field in an plugin action review payload.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_format ⇒ String

  The expected data format for the action review input field value.

• #allowed_values ⇒ Array<Types::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.

• #display_description ⇒ String

  The field level description of each action review input field.

• #display_name ⇒ String

  The name of the field.

• #display_order ⇒ Integer

  The display order of fields in a payload.

• #required ⇒ Boolean

  Information about whether the field is required.

• #type ⇒ String

  The type of field.

• #value ⇒ Hash, ...

  The field value.

Instance Attribute Details

#allowed_format ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_values ⇒ Array<Types::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.

Returns:

• (Array<Types::ActionReviewPayloadFieldAllowedValue>)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_description ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the field.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_order ⇒ Integer

The display order of fields in a payload.

Returns:

• (Integer)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

Information about whether the field is required.

Returns:

• (Boolean)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of field.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Hash, ...

The field value.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 313

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :required)
  SENSITIVE = []
  include Aws::Structure
end