Class SearchDocumentsResponse.MatchingDocument (0.41.0)

public static final class SearchDocumentsResponse.MatchingDocument extends GeneratedMessageV3 implements SearchDocumentsResponse.MatchingDocumentOrBuilder

Document entry with metadata inside SearchDocumentsResponse

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchDocumentsResponse.MatchingDocument

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

MATCHED_TOKEN_PAGE_INDICES_FIELD_NUMBER

public static final int MATCHED_TOKEN_PAGE_INDICES_FIELD_NUMBER
Field Value
Type Description
int

QA_RESULT_FIELD_NUMBER

public static final int QA_RESULT_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_TEXT_SNIPPET_FIELD_NUMBER

public static final int SEARCH_TEXT_SNIPPET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDocumentsResponse.MatchingDocument getDefaultInstance()
Returns
Type Description
SearchDocumentsResponse.MatchingDocument

getDescriptor()

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

newBuilder()

public static SearchDocumentsResponse.MatchingDocument.Builder newBuilder()
Returns
Type Description
SearchDocumentsResponse.MatchingDocument.Builder

newBuilder(SearchDocumentsResponse.MatchingDocument prototype)

public static SearchDocumentsResponse.MatchingDocument.Builder newBuilder(SearchDocumentsResponse.MatchingDocument prototype)
Parameter
Name Description
prototype SearchDocumentsResponse.MatchingDocument
Returns
Type Description
SearchDocumentsResponse.MatchingDocument.Builder

parseDelimitedFrom(InputStream input)

public static SearchDocumentsResponse.MatchingDocument parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDocumentsResponse.MatchingDocument parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchDocumentsResponse.MatchingDocument parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsResponse.MatchingDocument
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchDocumentsResponse.MatchingDocument> parser()
Returns
Type Description
Parser<MatchingDocument>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchDocumentsResponse.MatchingDocument getDefaultInstanceForType()
Returns
Type Description
SearchDocumentsResponse.MatchingDocument

getDocument()

public Document getDocument()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type Description
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type Description
DocumentOrBuilder

getMatchedTokenPageIndices(int index)

public long getMatchedTokenPageIndices(int index)

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The matchedTokenPageIndices at the given index.

getMatchedTokenPageIndicesCount()

public int getMatchedTokenPageIndicesCount()

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Returns
Type Description
int

The count of matchedTokenPageIndices.

getMatchedTokenPageIndicesList()

public List<Long> getMatchedTokenPageIndicesList()

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Returns
Type Description
List<Long>

A list containing the matchedTokenPageIndices.

getParserForType()

public Parser<SearchDocumentsResponse.MatchingDocument> getParserForType()
Returns
Type Description
Parser<MatchingDocument>
Overrides

getQaResult()

public QAResult getQaResult()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type Description
QAResult

The qaResult.

getQaResultOrBuilder()

public QAResultOrBuilder getQaResultOrBuilder()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type Description
QAResultOrBuilder

getSearchTextSnippet()

public String getSearchTextSnippet()

Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.

string search_text_snippet = 2;

Returns
Type Description
String

The searchTextSnippet.

getSearchTextSnippetBytes()

public ByteString getSearchTextSnippetBytes()

Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.

string search_text_snippet = 2;

Returns
Type Description
ByteString

The bytes for searchTextSnippet.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDocument()

public boolean hasDocument()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type Description
boolean

Whether the document field is set.

hasQaResult()

public boolean hasQaResult()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type Description
boolean

Whether the qaResult 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 SearchDocumentsResponse.MatchingDocument.Builder newBuilderForType()
Returns
Type Description
SearchDocumentsResponse.MatchingDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDocumentsResponse.MatchingDocument.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchDocumentsResponse.MatchingDocument.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchDocumentsResponse.MatchingDocument.Builder toBuilder()
Returns
Type Description
SearchDocumentsResponse.MatchingDocument.Builder

writeTo(CodedOutputStream output)

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