Class SearchResponse.Summary.Reference (0.42.0) 

public static final class SearchResponse.Summary.Reference extends GeneratedMessageV3 implements SearchResponse.Summary.ReferenceOrBuilder

Document reference.

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

Inheritance

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

Static Fields

CHUNK_CONTENTS_FIELD_NUMBER

public static final int CHUNK_CONTENTS_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(SearchResponse.Summary.Reference prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getChunkContents(int index)

public SearchResponse.Summary.Reference.ChunkContent getChunkContents(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

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

getChunkContentsCount()

public int getChunkContentsCount()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
int

getChunkContentsList()

public List<SearchResponse.Summary.Reference.ChunkContent> getChunkContentsList()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
List<ChunkContent>

getChunkContentsOrBuilder(int index)

public SearchResponse.Summary.Reference.ChunkContentOrBuilder getChunkContentsOrBuilder(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

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

getChunkContentsOrBuilderList()

public List<? extends SearchResponse.Summary.Reference.ChunkContentOrBuilder> getChunkContentsOrBuilderList()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

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

getDefaultInstanceForType()

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

getDocument()

public String getDocument()

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for document.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTitle()

public String getTitle()

Title of the document.

string title = 1;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Title of the document.

string title = 1;

Returns
Type Description
ByteString

The bytes for title.

getUri()

public String getUri()

Cloud Storage or HTTP uri for the document.

string uri = 3;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Cloud Storage or HTTP uri for the document.

string uri = 3;

Returns
Type Description
ByteString

The bytes for uri.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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