Class SearchDocumentsResponse (0.51.0) 

public final class SearchDocumentsResponse extends GeneratedMessageV3 implements SearchDocumentsResponseOrBuilder

Response message for DocumentService.SearchDocuments.

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse

Inheritance

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

Static Fields

HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER

public static final int HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

MATCHING_DOCUMENTS_FIELD_NUMBER

public static final int MATCHING_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUESTION_ANSWER_FIELD_NUMBER

public static final int QUESTION_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDocumentsResponse getDefaultInstance()
Returns
Type Description
SearchDocumentsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(SearchDocumentsResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchDocumentsResponse getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

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

getQuestionAnswer()

public String getQuestionAnswer()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
Type Description
String

The questionAnswer.

getQuestionAnswerBytes()

public ByteString getQuestionAnswerBytes()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
Type Description
ByteString

The bytes for questionAnswer.

getSerializedSize()

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

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchDocumentsResponse.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.Builder toBuilder()
Returns
Type Description
SearchDocumentsResponse.Builder

writeTo(CodedOutputStream output)

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