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

Class ActionExecutionEvent

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.ActionExecutionEvent

All Implemented Interfaces:

Serializable, SdkPojo, ChatInputStream, ToCopyableBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>

Direct Known Subclasses:

DefaultActionExecutionEvent

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

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActionExecutionEvent.Builder
protected static class	ActionExecutionEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatInputStream

ChatInputStream.EventType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionExecutionEvent(ActionExecutionEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
static ActionExecutionEvent.Builder	builder()
ActionExecutionEvent	copy(Consumer<? super ActionExecutionEvent.Builder> modifier)
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,ActionExecutionPayloadField>	payload()	A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
String	payloadFieldNameSeparator()	A string used to retain information about the hierarchical contexts within a action execution event payload.
String	pluginId()	The identifier of the plugin for which the action is being requested.
List<SdkField<?>>	sdkFields()
static Class<? extends ActionExecutionEvent.Builder>	serializableBuilderClass()
ActionExecutionEvent.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.services.qbusiness.model.ChatInputStream

sdkEventType

Constructor Detail

ActionExecutionEvent

protected ActionExecutionEvent(ActionExecutionEvent.BuilderImpl builder)

Method Detail

pluginId

public final String pluginId()

The identifier of the plugin for which the action is being requested.

Returns:

The identifier of the plugin for which the action is being requested.

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,ActionExecutionPayloadField> payload()

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their 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:

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

payloadFieldNameSeparator

public final String payloadFieldNameSeparator()

A string used to retain information about the hierarchical contexts within a action execution event payload.

Returns:

A string used to retain information about the hierarchical contexts within a action execution event payload.

toBuilder

public ActionExecutionEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>

builder

public static ActionExecutionEvent.Builder builder()

serializableBuilderClass

public static Class<? extends ActionExecutionEvent.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)

copy

public final ActionExecutionEvent copy(Consumer<? super ActionExecutionEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo