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

Class ActionReview

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.ActionReview

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ActionReview.Builder,ActionReview>

@Generated("software.amazon.awssdk:codegen")
public final class ActionReview
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ActionReview.Builder,ActionReview>

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActionReview.Builder

Method Summary

Modifier and Type	Method	Description
static ActionReview.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPayload()	For responses, this returns true if the service returned a value for the Payload property.
Map<String,ActionReviewPayloadField>	payload()	Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
String	payloadFieldNameSeparator()	A string used to retain information about the hierarchical contexts within an action review payload.
String	pluginId()	The identifier of the plugin associated with the action review.
PluginType	pluginType()	The type of plugin.
String	pluginTypeAsString()	The type of plugin.
List<SdkField<?>>	sdkFields()
static Class<? extends ActionReview.Builder>	serializableBuilderClass()
ActionReview.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pluginId

public final String pluginId()

The identifier of the plugin associated with the action review.

Returns:

The identifier of the plugin associated with the action review.

pluginType

public final PluginType pluginType()

The type of plugin.

If the service returns an enum value that is not available in the current SDK version, pluginType will return PluginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pluginTypeAsString().

Returns:

The type of plugin.

See Also:

PluginType

pluginTypeAsString

public final String pluginTypeAsString()

The type of plugin.

If the service returns an enum value that is not available in the current SDK version, pluginType will return PluginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pluginTypeAsString().

Returns:

The type of plugin.

See Also:

PluginType

hasPayload

public final boolean hasPayload()

For responses, this returns true if the service returned a value for the Payload property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

payload

public final Map<String,ActionReviewPayloadField> payload()

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPayload() method.

Returns:

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

payloadFieldNameSeparator

public final String payloadFieldNameSeparator()

A string used to retain information about the hierarchical contexts within an action review payload.

Returns:

A string used to retain information about the hierarchical contexts within an action review payload.

toBuilder

public ActionReview.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ActionReview.Builder,ActionReview>

builder

public static ActionReview.Builder builder()

serializableBuilderClass

public static Class<? extends ActionReview.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo