Package software.amazon.awssdk.services.qbusiness.model

Interface ActionReviewPayloadField.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ActionReviewPayloadField.Builder,ActionReviewPayloadField>, SdkBuilder<ActionReviewPayloadField.Builder,ActionReviewPayloadField>, SdkPojo

Enclosing class:

ActionReviewPayloadField

public static interface ActionReviewPayloadField.Builder
extends SdkPojo, CopyableBuilder<ActionReviewPayloadField.Builder,ActionReviewPayloadField>

Method Summary

Modifier and Type	Method	Description
ActionReviewPayloadField.Builder	allowedFormat(String allowedFormat)	The expected data format for the action review input field value.
ActionReviewPayloadField.Builder	allowedValues(Collection<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.
ActionReviewPayloadField.Builder	allowedValues(Consumer<ActionReviewPayloadFieldAllowedValue.Builder>... 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.
ActionReviewPayloadField.Builder	allowedValues(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.
ActionReviewPayloadField.Builder	displayDescription(String displayDescription)	The field level description of each action review input field.
ActionReviewPayloadField.Builder	displayName(String displayName)	The name of the field.
ActionReviewPayloadField.Builder	displayOrder(Integer displayOrder)	The display order of fields in a payload.
ActionReviewPayloadField.Builder	required(Boolean required)	Information about whether the field is required.
ActionReviewPayloadField.Builder	type(String type)	The type of field.
ActionReviewPayloadField.Builder	type(ActionPayloadFieldType type)	The type of field.
ActionReviewPayloadField.Builder	value(Document value)	The field value.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

displayName

ActionReviewPayloadField.Builder displayName(String displayName)

The name of the field.

Parameters:

displayName - The name of the field.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayOrder

ActionReviewPayloadField.Builder displayOrder(Integer displayOrder)

The display order of fields in a payload.

Parameters:

displayOrder - The display order of fields in a payload.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayDescription

ActionReviewPayloadField.Builder displayDescription(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

type

ActionReviewPayloadField.Builder type(String type)

The type of field.

Parameters:

type - The type of field.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionPayloadFieldType, ActionPayloadFieldType

type

ActionReviewPayloadField.Builder type(ActionPayloadFieldType type)

The type of field.

Parameters:

type - The type of field.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionPayloadFieldType, ActionPayloadFieldType

value

ActionReviewPayloadField.Builder value(Document value)

The field value.

Parameters:

value - The field value.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedValues

ActionReviewPayloadField.Builder allowedValues(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedValues

ActionReviewPayloadField.Builder allowedValues(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedValues

ActionReviewPayloadField.Builder allowedValues(Consumer<ActionReviewPayloadFieldAllowedValue.Builder>... 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.

This is a convenience method that creates an instance of the ActionReviewPayloadFieldAllowedValue.Builder avoiding the need to create one manually via ActionReviewPayloadFieldAllowedValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #allowedValues(List).

Parameters:

allowedValues - a consumer that will call methods on ActionReviewPayloadFieldAllowedValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#allowedValues(java.util.Collection)

allowedFormat

ActionReviewPayloadField.Builder allowedFormat(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

required

ActionReviewPayloadField.Builder required(Boolean required)

Information about whether the field is required.

Parameters:

required - Information about whether the field is required.

Returns:

Returns a reference to this object so that method calls can be chained together.