Class SearchDocumentsResponse (0.31.0)

public final class SearchDocumentsResponse extends GeneratedMessageV3 implements SearchDocumentsResponseOrBuilder

Response message for DocumentService.SearchDocuments.

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse

Static Fields

HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER

public static final int HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

MATCHING_DOCUMENTS_FIELD_NUMBER

public static final int MATCHING_DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUESTION_ANSWER_FIELD_NUMBER

public static final int QUESTION_ANSWER_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchDocumentsResponse getDefaultInstance()
Returns
TypeDescription
SearchDocumentsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(SearchDocumentsResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
SearchDocumentsResponse

getHistogramQueryResults(int index)

public HistogramQueryResult getHistogramQueryResults(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResult

getHistogramQueryResultsCount()

public int getHistogramQueryResultsCount()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
int

getHistogramQueryResultsList()

public List<HistogramQueryResult> getHistogramQueryResultsList()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
List<HistogramQueryResult>

getHistogramQueryResultsOrBuilder(int index)

public HistogramQueryResultOrBuilder getHistogramQueryResultsOrBuilder(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResultOrBuilder

getHistogramQueryResultsOrBuilderList()

public List<? extends HistogramQueryResultOrBuilder> getHistogramQueryResultsOrBuilderList()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder>

getMatchingDocuments(int index)

public SearchDocumentsResponse.MatchingDocument getMatchingDocuments(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument

getMatchingDocumentsCount()

public int getMatchingDocumentsCount()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
int

getMatchingDocumentsList()

public List<SearchDocumentsResponse.MatchingDocument> getMatchingDocumentsList()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
List<MatchingDocument>

getMatchingDocumentsOrBuilder(int index)

public SearchDocumentsResponse.MatchingDocumentOrBuilder getMatchingDocumentsOrBuilder(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocumentOrBuilder

getMatchingDocumentsOrBuilderList()

public List<? extends SearchDocumentsResponse.MatchingDocumentOrBuilder> getMatchingDocumentsOrBuilderList()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocumentOrBuilder>

getMetadata()

public ResponseMetadata getMetadata()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
ResponseMetadata

The metadata.

getMetadataOrBuilder()

public ResponseMetadataOrBuilder getMetadataOrBuilder()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
ResponseMetadataOrBuilder

getNextPageToken()

public String getNextPageToken()

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<SearchDocumentsResponse> getParserForType()
Returns
TypeDescription
Parser<SearchDocumentsResponse>
Overrides

getQuestionAnswer()

public String getQuestionAnswer()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
TypeDescription
String

The questionAnswer.

getQuestionAnswerBytes()

public ByteString getQuestionAnswerBytes()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
TypeDescription
ByteString

The bytes for questionAnswer.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTotalSize()

public int getTotalSize()

The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set SearchDocumentsRequest.total_result_size to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying &quot;of many&quot;, for example: &quot;Displaying 10 of many&quot;.

int32 total_size = 3;

Returns
TypeDescription
int

The totalSize.

hasMetadata()

public boolean hasMetadata()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
boolean

Whether the metadata 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.Builder newBuilderForType()
Returns
TypeDescription
SearchDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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