Send feedback
Class SearchDocumentsResponse.MatchingDocument (0.24.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.24.0 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchDocumentsResponse . MatchingDocument . Builder newBuilder ()
newBuilder(SearchDocumentsResponse.MatchingDocument prototype)
public static SearchDocumentsResponse . MatchingDocument . Builder newBuilder ( SearchDocumentsResponse . MatchingDocument prototype )
parseDelimitedFrom(InputStream input)
public static SearchDocumentsResponse . MatchingDocument parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse . MatchingDocument parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchDocumentsResponse . MatchingDocument > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getDefaultInstanceForType()
public SearchDocumentsResponse . MatchingDocument getDefaultInstanceForType ()
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;
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 indexint 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 ()
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;
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()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchDocumentsResponse . MatchingDocument . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchDocumentsResponse . MatchingDocument . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public SearchDocumentsResponse . MatchingDocument . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
