RetrieveAndGenerateStreamResponseOutput (AWS Java SDK :: Services :: Bedrock Agent Runtime 2.31.73 API)

All Superinterfaces:

SdkPojo

All Known Implementing Classes:

CitationEvent, DefaultCitation, DefaultGuardrail, DefaultOutput, GuardrailEvent, RetrieveAndGenerateOutputEvent
```
@Generated("software.amazon.awssdk:codegen")
public interface RetrieveAndGenerateStreamResponseOutput
extends SdkPojo
```
Base interface for all event types in RetrieveAndGenerateStreamResponseOutput.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`RetrieveAndGenerateStreamResponseOutput.EventType`	The known possible types of events for `RetrieveAndGenerateStreamResponseOutput`.

Field Summary

Fields
Modifier and Type	Field	Description
`static RetrieveAndGenerateStreamResponseOutput`	`UNKNOWN`	Special type of `RetrieveAndGenerateStreamResponseOutput` for unknown types of events that this version of the SDK does not know about

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)`	Calls the appropriate visit method depending on the subtype of `RetrieveAndGenerateStreamResponseOutput`.
`static CitationEvent.Builder`	`citationBuilder()`	Create a builder for the `citation` event type for this stream.
`static GuardrailEvent.Builder`	`guardrailBuilder()`	Create a builder for the `guardrail` event type for this stream.
`static RetrieveAndGenerateOutputEvent.Builder`	`outputBuilder()`	Create a builder for the `output` event type for this stream.
`default RetrieveAndGenerateStreamResponseOutput.EventType`	`sdkEventType()`	The type of this event.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

- Field Detail
  - UNKNOWN
```
static final RetrieveAndGenerateStreamResponseOutput UNKNOWN
```
    Special type of RetrieveAndGenerateStreamResponseOutput for unknown types of events that this version of the SDK does not know about
- Method Detail
  - citationBuilder
```
static CitationEvent.Builder citationBuilder()
```
    Create a builder for the citation event type for this stream.
  - guardrailBuilder
```
static GuardrailEvent.Builder guardrailBuilder()
```
    Create a builder for the guardrail event type for this stream.
  - outputBuilder
```
static RetrieveAndGenerateOutputEvent.Builder outputBuilder()
```
    Create a builder for the output event type for this stream.
  - sdkEventType
```
default RetrieveAndGenerateStreamResponseOutput.EventType sdkEventType()
```
    The type of this event. Corresponds to the :event-type header on the Message.
  - accept
```
void accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)
```
    Calls the appropriate visit method depending on the subtype of RetrieveAndGenerateStreamResponseOutput.
    
    Parameters:
    
    visitor - Visitor to invoke.