ActionReviewPayloadField (AWS Java SDK for QBusiness 1.12.610 API)

java.lang.Object
- com.amazonaws.services.qbusiness.model.ActionReviewPayloadField

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@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.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActionReviewPayloadField()

Constructors
Constructor and Description
`ActionReviewPayloadField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionReviewPayloadField`	`clone()`
`boolean`	`equals(Object obj)`
`List<ActionReviewPayloadFieldAllowedValue>`	`getAllowedValues()` Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
`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)`
`void`	`setAllowedValues(Collection<ActionReviewPayloadFieldAllowedValue> allowedValues)` Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
`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`	`withAllowedValues(ActionReviewPayloadFieldAllowedValue... allowedValues)` Information about the field values that an end user can use to provide to Amazon Q for Amazon Q 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 for Amazon Q to perform the requested plugin action.
`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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ActionReviewPayloadField
```
public ActionReviewPayloadField()
```
- Method Detail
  - getAllowedValues
```
public List<ActionReviewPayloadFieldAllowedValue> getAllowedValues()
```
    Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    
    Returns:
    
    Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
  - setAllowedValues
```
public void setAllowedValues(Collection<ActionReviewPayloadFieldAllowedValue> allowedValues)
```
    Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    
    Parameters:
    
    allowedValues - Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
  - withAllowedValues
```
public ActionReviewPayloadField withAllowedValues(ActionReviewPayloadFieldAllowedValue... allowedValues)
```
    Information about the field values that an end user can use to provide to Amazon Q for Amazon Q 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.
    
    Parameters:
    
    allowedValues - Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedValues
```
public ActionReviewPayloadField withAllowedValues(Collection<ActionReviewPayloadFieldAllowedValue> allowedValues)
```
    Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    
    Parameters:
    
    allowedValues - Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The name of the field.
    
    Parameters:
    
    displayName - The name of the field.
  - getDisplayName
```
public String getDisplayName()
```
    The name of the field.
    
    Returns:
    
    The name of the field.
  - withDisplayName
```
public ActionReviewPayloadField withDisplayName(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.
  - setDisplayOrder
```
public void setDisplayOrder(Integer displayOrder)
```
    The display order of fields in a payload.
    
    Parameters:
    
    displayOrder - The display order of fields in a payload.
  - getDisplayOrder
```
public Integer getDisplayOrder()
```
    The display order of fields in a payload.
    
    Returns:
    
    The display order of fields in a payload.
  - withDisplayOrder
```
public ActionReviewPayloadField withDisplayOrder(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.
  - setRequired
```
public void setRequired(Boolean required)
```
    Information about whether the field is required.
    
    Parameters:
    
    required - Information about whether the field is required.
  - getRequired
```
public Boolean getRequired()
```
    Information about whether the field is required.
    
    Returns:
    
    Information about whether the field is required.
  - withRequired
```
public ActionReviewPayloadField withRequired(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.
  - isRequired
```
public Boolean isRequired()
```
    Information about whether the field is required.
    
    Returns:
    
    Information about whether the field is required.
  - setType
```
public void setType(String type)
```
    The type of field.
    
    Parameters:
    
    type - The type of field.
    
    See Also:
    
    ActionPayloadFieldType
  - getType
```
public String getType()
```
    The type of field.
    
    Returns:
    
    The type of field.
    
    See Also:
    
    ActionPayloadFieldType
  - withType
```
public ActionReviewPayloadField withType(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
  - withType
```
public ActionReviewPayloadField withType(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
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ActionReviewPayloadField clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ActionReviewPayloadField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActionReviewPayloadField

Method Detail

getAllowedValues

setAllowedValues

withAllowedValues

withAllowedValues

setDisplayName

getDisplayName

withDisplayName

setDisplayOrder

getDisplayOrder

withDisplayOrder

setRequired

getRequired

withRequired

isRequired

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall