Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface CitationEvent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CitationEvent.Builder,CitationEvent>, SdkBuilder<CitationEvent.Builder,CitationEvent>, SdkPojo

All Known Subinterfaces:

DefaultCitation.Builder

All Known Implementing Classes:

CitationEvent.BuilderImpl

Enclosing class:

CitationEvent

@Mutable
@NotThreadSafe
public static interface CitationEvent.Builder
extends SdkPojo, CopyableBuilder<CitationEvent.Builder,CitationEvent>

Method Summary

Modifier and Type	Method	Description
default CitationEvent.Builder	citation(Consumer<Citation.Builder> citation)	Deprecated. Citation is deprecated.
CitationEvent.Builder	citation(Citation citation)	Deprecated. Citation is deprecated.
default CitationEvent.Builder	generatedResponsePart(Consumer<GeneratedResponsePart.Builder> generatedResponsePart)	The generated response to the citation event.
CitationEvent.Builder	generatedResponsePart(GeneratedResponsePart generatedResponsePart)	The generated response to the citation event.
CitationEvent.Builder	retrievedReferences(Collection<RetrievedReference> retrievedReferences)	The retrieved references of the citation event.
CitationEvent.Builder	retrievedReferences(Consumer<RetrievedReference.Builder>... retrievedReferences)	The retrieved references of the citation event.
CitationEvent.Builder	retrievedReferences(RetrievedReference... retrievedReferences)	The retrieved references of the citation event.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

citation

@Deprecated
CitationEvent.Builder citation(Citation citation)

Deprecated.

Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.

The citation.

Parameters:

citation - The citation.

Returns:

Returns a reference to this object so that method calls can be chained together.

citation

@Deprecated
default CitationEvent.Builder citation(Consumer<Citation.Builder> citation)

Deprecated.

Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.

The citation.

This is a convenience method that creates an instance of the Citation.Builder avoiding the need to create one manually via Citation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to citation(Citation).

Parameters:

citation - a consumer that will call methods on Citation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

citation(Citation)

generatedResponsePart

CitationEvent.Builder generatedResponsePart(GeneratedResponsePart generatedResponsePart)

The generated response to the citation event.

Parameters:

generatedResponsePart - The generated response to the citation event.

Returns:

Returns a reference to this object so that method calls can be chained together.

generatedResponsePart

default CitationEvent.Builder generatedResponsePart(Consumer<GeneratedResponsePart.Builder> generatedResponsePart)

The generated response to the citation event.

This is a convenience method that creates an instance of the GeneratedResponsePart.Builder avoiding the need to create one manually via GeneratedResponsePart.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to generatedResponsePart(GeneratedResponsePart).

Parameters:

generatedResponsePart - a consumer that will call methods on GeneratedResponsePart.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

generatedResponsePart(GeneratedResponsePart)

retrievedReferences

CitationEvent.Builder retrievedReferences(Collection<RetrievedReference> retrievedReferences)

The retrieved references of the citation event.

Parameters:

retrievedReferences - The retrieved references of the citation event.

Returns:

Returns a reference to this object so that method calls can be chained together.

retrievedReferences

CitationEvent.Builder retrievedReferences(RetrievedReference... retrievedReferences)

The retrieved references of the citation event.

Parameters:

retrievedReferences - The retrieved references of the citation event.

Returns:

Returns a reference to this object so that method calls can be chained together.

retrievedReferences

CitationEvent.Builder retrievedReferences(Consumer<RetrievedReference.Builder>... retrievedReferences)

The retrieved references of the citation event.

This is a convenience method that creates an instance of the RetrievedReference.Builder avoiding the need to create one manually via RetrievedReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #retrievedReferences(List).

Parameters:

retrievedReferences - a consumer that will call methods on RetrievedReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#retrievedReferences(java.util.Collection)