@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ActionReviewPayloadField extends Object implements Serializable, Cloneable, StructuredPojo
A user input field in an plugin action review payload.
Constructor and Description |
---|
ActionReviewPayloadField() |
Modifier and Type | Method and Description |
---|---|
ActionReviewPayloadField |
clone() |
boolean |
equals(Object obj) |
String |
getAllowedFormat()
The expected data format for the action review input field value.
|
List<ActionReviewPayloadFieldAllowedValue> |
getAllowedValues()
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.
|
String |
getDisplayDescription()
The field level description of each action review input field.
|
String |
getDisplayName()
The name of the field.
|
Integer |
getDisplayOrder()
The display order of fields in a payload.
|
Boolean |
getRequired()
Information about whether the field is required.
|
String |
getType()
The type of field.
|
int |
hashCode() |
Boolean |
isRequired()
Information about whether the field is required.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAllowedFormat(String allowedFormat)
The expected data format for the action review input field value.
|
void |
setAllowedValues(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.
|
void |
setDisplayDescription(String displayDescription)
The field level description of each action review input field.
|
void |
setDisplayName(String displayName)
The name of the field.
|
void |
setDisplayOrder(Integer displayOrder)
The display order of fields in a payload.
|
void |
setRequired(Boolean required)
Information about whether the field is required.
|
void |
setType(String type)
The type of field.
|
String |
toString()
Returns a string representation of this object.
|
ActionReviewPayloadField |
withAllowedFormat(String allowedFormat)
The expected data format for the action review input field value.
|
ActionReviewPayloadField |
withAllowedValues(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 |
withAllowedValues(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 |
withDisplayDescription(String displayDescription)
The field level description of each action review input field.
|
ActionReviewPayloadField |
withDisplayName(String displayName)
The name of the field.
|
ActionReviewPayloadField |
withDisplayOrder(Integer displayOrder)
The display order of fields in a payload.
|
ActionReviewPayloadField |
withRequired(Boolean required)
Information about whether the field is required.
|
ActionReviewPayloadField |
withType(ActionPayloadFieldType type)
The type of field.
|
ActionReviewPayloadField |
withType(String type)
The type of field.
|
public void setDisplayName(String displayName)
The name of the field.
displayName
- The name of the field.public String getDisplayName()
The name of the field.
public ActionReviewPayloadField withDisplayName(String displayName)
The name of the field.
displayName
- The name of the field.public void setDisplayOrder(Integer displayOrder)
The display order of fields in a payload.
displayOrder
- The display order of fields in a payload.public Integer getDisplayOrder()
The display order of fields in a payload.
public ActionReviewPayloadField withDisplayOrder(Integer displayOrder)
The display order of fields in a payload.
displayOrder
- The display order of fields in a payload.public void setDisplayDescription(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.
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.public String getDisplayDescription()
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.
public ActionReviewPayloadField withDisplayDescription(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.
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.public void setType(String type)
The type of field.
type
- The type of field.ActionPayloadFieldType
public String getType()
The type of field.
ActionPayloadFieldType
public ActionReviewPayloadField withType(String type)
The type of field.
type
- The type of field.ActionPayloadFieldType
public ActionReviewPayloadField withType(ActionPayloadFieldType type)
The type of field.
type
- The type of field.ActionPayloadFieldType
public List<ActionReviewPayloadFieldAllowedValue> getAllowedValues()
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.
public void setAllowedValues(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.
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.public ActionReviewPayloadField withAllowedValues(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.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedValues(java.util.Collection)
or withAllowedValues(java.util.Collection)
if you want
to override the existing values.
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.public ActionReviewPayloadField withAllowedValues(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.
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.public void setAllowedFormat(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.
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.public String getAllowedFormat()
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.
from
and to
would be of datetime
allowed format.public ActionReviewPayloadField withAllowedFormat(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.
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.public void setRequired(Boolean required)
Information about whether the field is required.
required
- Information about whether the field is required.public Boolean getRequired()
Information about whether the field is required.
public ActionReviewPayloadField withRequired(Boolean required)
Information about whether the field is required.
required
- Information about whether the field is required.public Boolean isRequired()
Information about whether the field is required.
public String toString()
toString
in class Object
Object.toString()
public ActionReviewPayloadField clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.