Class SearchResponse.Summary.SummaryWithMetadata (0.38.0)

public static final class SearchResponse.Summary.SummaryWithMetadata extends GeneratedMessageV3 implements SearchResponse.Summary.SummaryWithMetadataOrBuilder

Summary with metadata information.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.Summary.SummaryWithMetadata

Static Fields

CITATION_METADATA_FIELD_NUMBER

public static final int CITATION_METADATA_FIELD_NUMBER
Field Value
Type Description
int

REFERENCES_FIELD_NUMBER

public static final int REFERENCES_FIELD_NUMBER
Field Value
Type Description
int

SUMMARY_FIELD_NUMBER

public static final int SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.Summary.SummaryWithMetadata getDefaultInstance()
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchResponse.Summary.SummaryWithMetadata.Builder newBuilder()
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata.Builder

newBuilder(SearchResponse.Summary.SummaryWithMetadata prototype)

public static SearchResponse.Summary.SummaryWithMetadata.Builder newBuilder(SearchResponse.Summary.SummaryWithMetadata prototype)
Parameter
Name Description
prototype SearchResponse.Summary.SummaryWithMetadata
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Summary.SummaryWithMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SummaryWithMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.Summary.SummaryWithMetadata> parser()
Returns
Type Description
Parser<SummaryWithMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCitationMetadata()

public 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 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

getDefaultInstanceForType()

public SearchResponse.Summary.SummaryWithMetadata getDefaultInstanceForType()
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata

getParserForType()

public Parser<SearchResponse.Summary.SummaryWithMetadata> getParserForType()
Returns
Type Description
Parser<SummaryWithMetadata>
Overrides

getReferences(int index)

public 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 int getReferencesCount()

Document References.

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

Returns
Type Description
int

getReferencesList()

public 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 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 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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSummary()

public String getSummary()

Summary text with no citation information.

string summary = 1;

Returns
Type Description
String

The summary.

getSummaryBytes()

public ByteString getSummaryBytes()

Summary text with no citation information.

string summary = 1;

Returns
Type Description
ByteString

The bytes for summary.

hasCitationMetadata()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchResponse.Summary.SummaryWithMetadata.Builder newBuilderForType()
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.SummaryWithMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchResponse.Summary.SummaryWithMetadata.Builder toBuilder()
Returns
Type Description
SearchResponse.Summary.SummaryWithMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException