Interface SearchResponse.Summary.SummaryWithMetadataOrBuilder (0.41.0)

public static interface SearchResponse.Summary.SummaryWithMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCitationMetadata()

public abstract SearchResponse.Summary.CitationMetadata getCitationMetadata()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
Type Description
SearchResponse.Summary.CitationMetadata

The citationMetadata.

getCitationMetadataOrBuilder()

public abstract SearchResponse.Summary.CitationMetadataOrBuilder getCitationMetadataOrBuilder()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
Type Description
SearchResponse.Summary.CitationMetadataOrBuilder

getReferences(int index)

public abstract SearchResponse.Summary.Reference getReferences(int index)

Document References.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference

getReferencesCount()

public abstract int getReferencesCount()

Document References.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;

Returns
Type Description
int

getReferencesList()

public abstract List<SearchResponse.Summary.Reference> getReferencesList()

Document References.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;

Returns
Type Description
List<Reference>

getReferencesOrBuilder(int index)

public abstract SearchResponse.Summary.ReferenceOrBuilder getReferencesOrBuilder(int index)

Document References.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.ReferenceOrBuilder

getReferencesOrBuilderList()

public abstract List<? extends SearchResponse.Summary.ReferenceOrBuilder> getReferencesOrBuilderList()

Document References.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Summary.ReferenceOrBuilder>

getSummary()

public abstract String getSummary()

Summary text with no citation information.

string summary = 1;

Returns
Type Description
String

The summary.

getSummaryBytes()

public abstract ByteString getSummaryBytes()

Summary text with no citation information.

string summary = 1;

Returns
Type Description
ByteString

The bytes for summary.

hasCitationMetadata()

public abstract boolean hasCitationMetadata()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
Type Description
boolean

Whether the citationMetadata field is set.