java.lang.Object
- software.amazon.awssdk.services.qbusiness.model.MetadataEvent

All Implemented Interfaces:

Serializable, SdkPojo, ChatOutputStream, ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>

Direct Known Subclasses:

DefaultMetadataEvent
```
@Generated("software.amazon.awssdk:codegen")
public class MetadataEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>, ChatOutputStream
```
A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MetadataEvent.Builder

protected static class MetadataEvent.BuilderImpl
- Nested classes/interfaces inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream
  ChatOutputStream.EventType

Field Summary
- Fields inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream
  UNKNOWN

Constructor Summary

Constructors
Modifier Constructor Description

protected MetadataEvent(MetadataEvent.BuilderImpl builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(ChatResponseHandler.Visitor visitor)`	Calls the appropriate visit method depending on the subtype of `MetadataEvent`.
`static MetadataEvent.Builder`	`builder()`
`String`	`conversationId()`	The identifier of the conversation with which the generated metadata is associated.
`MetadataEvent`	`copy(Consumer<? super MetadataEvent.Builder> modifier)`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`finalTextMessage()`	The final text output message generated by the system.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSourceAttributions()`	For responses, this returns true if the service returned a value for the SourceAttributions property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MetadataEvent.Builder>`	`serializableBuilderClass()`
`List<SourceAttribution>`	`sourceAttributions()`	The source documents used to generate the conversation response.
`String`	`systemMessageId()`	The identifier of an Amazon Q Business AI generated message within the conversation.
`MetadataEvent.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userMessageId()`	The identifier of an Amazon Q Business end user text input message within the conversation.

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.ChatOutputStream
sdkEventType

- Constructor Detail
  - MetadataEvent
```
protected MetadataEvent(MetadataEvent.BuilderImpl builder)
```
- Method Detail
  - conversationId
```
public final String conversationId()
```
    The identifier of the conversation with which the generated metadata is associated.
    
    Returns:
    
    The identifier of the conversation with which the generated metadata is associated.
  - userMessageId
```
public final String userMessageId()
```
    The identifier of an Amazon Q Business end user text input message within the conversation.
    
    Returns:
    
    The identifier of an Amazon Q Business end user text input message within the conversation.
  - systemMessageId
```
public final String systemMessageId()
```
    The identifier of an Amazon Q Business AI generated message within the conversation.
    
    Returns:
    
    The identifier of an Amazon Q Business AI generated message within the conversation.
  - hasSourceAttributions
```
public final boolean hasSourceAttributions()
```
    For responses, this returns true if the service returned a value for the SourceAttributions 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.
  - sourceAttributions
```
public final List<SourceAttribution> sourceAttributions()
```
    The source documents used to generate the conversation response.
    
    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 hasSourceAttributions() method.
    
    Returns:
    
    The source documents used to generate the conversation response.
  - finalTextMessage
```
public final String finalTextMessage()
```
    The final text output message generated by the system.
    
    Returns:
    
    The final text output message generated by the system.
  - toBuilder
```
public MetadataEvent.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>
  - builder
```
public static MetadataEvent.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MetadataEvent.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 MetadataEvent copy(Consumer<? super MetadataEvent.Builder> modifier)
```
    Specified by:
    
    copy in interface ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - accept
```
public void accept(ChatResponseHandler.Visitor visitor)
```
    Calls the appropriate visit method depending on the subtype of MetadataEvent.
    
    Specified by:
    
    accept in interface ChatOutputStream
    
    Parameters:
    
    visitor - Visitor to invoke.

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

Class MetadataEvent

Nested Class Summary

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

Field Summary

Fields inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream

Constructor Detail

MetadataEvent

Method Detail

conversationId

userMessageId

systemMessageId

hasSourceAttributions

sourceAttributions

finalTextMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

copy

sdkFields

accept