Class SearchResponse.Summary.Citation (0.38.0)

public static final class SearchResponse.Summary.Citation extends GeneratedMessageV3 implements SearchResponse.Summary.CitationOrBuilder

Citation info for a segment.

Protobuf type google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Citation

Inheritance

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

Static Fields

END_INDEX_FIELD_NUMBER

public static final int END_INDEX_FIELD_NUMBER
Field Value
Type Description
int

SOURCES_FIELD_NUMBER

public static final int SOURCES_FIELD_NUMBER
Field Value
Type Description
int

START_INDEX_FIELD_NUMBER

public static final int START_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(SearchResponse.Summary.Citation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getEndIndex()

public long getEndIndex()

End of the attributed segment, exclusive.

int64 end_index = 2;

Returns
Type Description
long

The endIndex.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSources(int index)

public SearchResponse.Summary.CitationSource getSources(int index)

Citation sources for the attributed segment.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource sources = 3;

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

getSourcesCount()

public int getSourcesCount()

Citation sources for the attributed segment.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource sources = 3;

Returns
Type Description
int

getSourcesList()

public List<SearchResponse.Summary.CitationSource> getSourcesList()

Citation sources for the attributed segment.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource sources = 3;

Returns
Type Description
List<CitationSource>

getSourcesOrBuilder(int index)

public SearchResponse.Summary.CitationSourceOrBuilder getSourcesOrBuilder(int index)

Citation sources for the attributed segment.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource sources = 3;

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

getSourcesOrBuilderList()

public List<? extends SearchResponse.Summary.CitationSourceOrBuilder> getSourcesOrBuilderList()

Citation sources for the attributed segment.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource sources = 3;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSourceOrBuilder>

getStartIndex()

public long getStartIndex()

Index indicates the start of the segment, measured in bytes/unicode.

int64 start_index = 1;

Returns
Type Description
long

The startIndex.

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.Citation.Builder newBuilderForType()
Returns
Type Description
SearchResponse.Summary.Citation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.Citation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.Summary.Citation.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.Citation.Builder toBuilder()
Returns
Type Description
SearchResponse.Summary.Citation.Builder

writeTo(CodedOutputStream output)

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