Class SearchDocumentsResponse.MatchingDocument (0.4.0)

Version 0.4.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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

Implements

SearchDocumentsResponse.MatchingDocumentOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_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

AbstractMessage.equals(Object other)

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

getParserForType()

public Parser<SearchDocumentsResponse.MatchingDocument> getParserForType()

Returns

Type	Description
Parser<MatchingDocument>

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException