Class SearchDocumentsResponse.MatchingDocument (0.27.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
TypeDescription
int

MATCHED_TOKEN_PAGE_INDICES_FIELD_NUMBER

public static final int MATCHED_TOKEN_PAGE_INDICES_FIELD_NUMBER
Field Value
TypeDescription
int

QA_RESULT_FIELD_NUMBER

public static final int QA_RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

SEARCH_TEXT_SNIPPET_FIELD_NUMBER

public static final int SEARCH_TEXT_SNIPPET_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchDocumentsResponse.MatchingDocument getDefaultInstance()
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchDocumentsResponse.MatchingDocument.Builder newBuilder()
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

newBuilder(SearchDocumentsResponse.MatchingDocument prototype)

public static SearchDocumentsResponse.MatchingDocument.Builder newBuilder(SearchDocumentsResponse.MatchingDocument prototype)
Parameter
NameDescription
prototypeSearchDocumentsResponse.MatchingDocument
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

parseDelimitedFrom(InputStream input)

public static SearchDocumentsResponse.MatchingDocument parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDocumentsResponse.MatchingDocument parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchDocumentsResponse.MatchingDocument parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsResponse.MatchingDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchDocumentsResponse.MatchingDocument getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
List<Long>

A list containing the matchedTokenPageIndices.

getParserForType()

public Parser<SearchDocumentsResponse.MatchingDocument> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for searchTextSnippet.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the qaResult field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchDocumentsResponse.MatchingDocument.Builder newBuilderForType()
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDocumentsResponse.MatchingDocument.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchDocumentsResponse.MatchingDocument.Builder toBuilder()
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException