Class SearchDocumentsRequest (0.23.0)

Version 0.23.0

• 0.50.0 (latest)
• 0.49.0
• 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 final class SearchDocumentsRequest extends GeneratedMessageV3 implements SearchDocumentsRequestOrBuilder

Request message for DocumentService.SearchDocuments.

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsRequest

Inheritance

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

Implements

SearchDocumentsRequestOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

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)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

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_QUERY_FIELD_NUMBER

public static final int DOCUMENT_QUERY_FIELD_NUMBER

Field Value
Type	Description
int

HISTOGRAM_QUERIES_FIELD_NUMBER

public static final int HISTOGRAM_QUERIES_FIELD_NUMBER

Field Value
Type	Description
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER

Field Value
Type	Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

QA_SIZE_LIMIT_FIELD_NUMBER

public static final int QA_SIZE_LIMIT_FIELD_NUMBER

Field Value
Type	Description
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

REQUIRE_TOTAL_SIZE_FIELD_NUMBER

public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

TOTAL_RESULT_SIZE_FIELD_NUMBER

public static final int TOTAL_RESULT_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchDocumentsRequest getDefaultInstance()

Returns
Type	Description
SearchDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchDocumentsRequest.Builder newBuilder()

Returns
Type	Description
SearchDocumentsRequest.Builder

newBuilder(SearchDocumentsRequest prototype)

public static SearchDocumentsRequest.Builder newBuilder(SearchDocumentsRequest prototype)

Parameter
Name	Description
prototype	SearchDocumentsRequest

Returns
Type	Description
SearchDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchDocumentsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchDocumentsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchDocumentsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDocumentsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchDocumentsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchDocumentsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchDocumentsRequest> parser()

Returns
Type	Description
Parser<SearchDocumentsRequest>

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 SearchDocumentsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchDocumentsRequest

getDocumentQuery()

public DocumentQuery getDocumentQuery()

Query used to search against documents (keyword, filters, etc.).

.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;

Returns
Type	Description
DocumentQuery	The documentQuery.

getDocumentQueryOrBuilder()

public DocumentQueryOrBuilder getDocumentQueryOrBuilder()

Query used to search against documents (keyword, filters, etc.).

.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;

Returns
Type	Description
DocumentQueryOrBuilder

getHistogramQueries(int index)

public HistogramQuery getHistogramQueries(int index)

An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options.

The following aggregation functions are supported:

• count(string_histogram_facet): Count the number of matching entities for each distinct attribute value.

  Data types:

• Histogram facet (aka filterable properties): Facet names with format &lt;schema id&gt;.&lt;facet&gt;. Facets will have the format of: a-zA-Z. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. &lt;child facet name&gt;. Example: schema123.root_parent_facet.middle_facet.child_facet

• DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123).

  Example expression:

• Document type counts: count('DocumentSchemaId')

• For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')

repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
HistogramQuery

getHistogramQueriesCount()

public int getHistogramQueriesCount()

An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options.

The following aggregation functions are supported:

• count(string_histogram_facet): Count the number of matching entities for each distinct attribute value.

  Data types:

• Histogram facet (aka filterable properties): Facet names with format &lt;schema id&gt;.&lt;facet&gt;. Facets will have the format of: a-zA-Z. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. &lt;child facet name&gt;. Example: schema123.root_parent_facet.middle_facet.child_facet

• DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123).

  Example expression:

• Document type counts: count('DocumentSchemaId')

• For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')

repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

Returns
Type	Description
int

getHistogramQueriesList()

public List<HistogramQuery> getHistogramQueriesList()

An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options.

The following aggregation functions are supported:

• count(string_histogram_facet): Count the number of matching entities for each distinct attribute value.

  Data types:

• Histogram facet (aka filterable properties): Facet names with format &lt;schema id&gt;.&lt;facet&gt;. Facets will have the format of: a-zA-Z. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. &lt;child facet name&gt;. Example: schema123.root_parent_facet.middle_facet.child_facet

• DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123).

  Example expression:

• Document type counts: count('DocumentSchemaId')

• For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')

repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

Returns
Type	Description
List<HistogramQuery>

getHistogramQueriesOrBuilder(int index)

public HistogramQueryOrBuilder getHistogramQueriesOrBuilder(int index)

An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options.

The following aggregation functions are supported:

• count(string_histogram_facet): Count the number of matching entities for each distinct attribute value.

  Data types:

• Histogram facet (aka filterable properties): Facet names with format &lt;schema id&gt;.&lt;facet&gt;. Facets will have the format of: a-zA-Z. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. &lt;child facet name&gt;. Example: schema123.root_parent_facet.middle_facet.child_facet

• DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123).

  Example expression:

• Document type counts: count('DocumentSchemaId')

• For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')

repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
HistogramQueryOrBuilder

getHistogramQueriesOrBuilderList()

public List<? extends HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()

An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options.

The following aggregation functions are supported:

• count(string_histogram_facet): Count the number of matching entities for each distinct attribute value.

  Data types:

• Histogram facet (aka filterable properties): Facet names with format &lt;schema id&gt;.&lt;facet&gt;. Facets will have the format of: a-zA-Z. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. &lt;child facet name&gt;. Example: schema123.root_parent_facet.middle_facet.child_facet

• DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123).

  Example expression:

• Document type counts: count('DocumentSchemaId')

• For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')

repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

Returns
Type	Description
List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder>

getOffset()

public int getOffset()

An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

The maximum allowed value is 5000. Otherwise an error is thrown.

For example, 0 means to return results starting from the first matching document, and 10 means to return from the 11th document. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).

int32 offset = 5;

Returns
Type	Description
int	The offset.

getOrderBy()

public String getOrderBy()

The criteria determining how search results are sorted. For non-empty query, default is "relevance desc". For empty query, default is "upload_date desc".

Supported options are:

• "relevance desc": By relevance descending, as determined by the API algorithms.
• "upload_date desc": By upload date descending.
• "upload_date": By upload date ascending.
• "update_date desc": By last updated date descending.
• "update_date": By last updated date ascending.
• "retrieval_importance desc": By retrieval importance of properties descending. This feature is still under development, please do not use unless otherwise instructed to do so.

string order_by = 8;

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

The criteria determining how search results are sorted. For non-empty query, default is "relevance desc". For empty query, default is "upload_date desc".

Supported options are:

• "relevance desc": By relevance descending, as determined by the API algorithms.
• "upload_date desc": By upload date descending.
• "upload_date": By upload date ascending.
• "update_date desc": By last updated date descending.
• "update_date": By last updated date ascending.
• "retrieval_importance desc": By retrieval importance of properties descending. This feature is still under development, please do not use unless otherwise instructed to do so.

string order_by = 8;

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

A limit on the number of documents returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.

int32 page_size = 6;

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

The token specifying the current offset within search results. See SearchDocumentsResponse.next_page_token for an explanation of how to obtain the next set of query results.

string page_token = 7;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The token specifying the current offset within search results. See SearchDocumentsResponse.next_page_token for an explanation of how to obtain the next set of query results.

string page_token = 7;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<SearchDocumentsRequest> getParserForType()

Returns
Type	Description
Parser<SearchDocumentsRequest>

Overrides

GeneratedMessageV3.getParserForType()

getQaSizeLimit()

public int getQaSizeLimit()

Experimental, do not use. The limit on the number of documents returned for the question-answering feature. To enable the question-answering feature, set [DocumentQuery].[is_nl_query][] to true.

int32 qa_size_limit = 11;

Returns
Type	Description
int	The qaSizeLimit.

getRequestMetadata()

public RequestMetadata getRequestMetadata()

The meta information collected about the end user, used to enforce access control and improve the search quality of the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type	Description
RequestMetadata	The requestMetadata.

getRequestMetadataOrBuilder()

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

The meta information collected about the end user, used to enforce access control and improve the search quality of the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type	Description
RequestMetadataOrBuilder

getRequireTotalSize()

public boolean getRequireTotalSize()

Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size.

Enabling this flag may adversely impact performance. Hint: If this is used with pagination, set this flag on the initial query but set this to false on subsequent page calls (keep the total count locally).

Defaults to false.

bool require_total_size = 10;

Returns
Type	Description
boolean	The requireTotalSize.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTotalResultSize()

public SearchDocumentsRequest.TotalResultSize getTotalResultSize()

Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size.

.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;

Returns
Type	Description
SearchDocumentsRequest.TotalResultSize	The totalResultSize.

getTotalResultSizeValue()

public int getTotalResultSizeValue()

Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size.

.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;

Returns
Type	Description
int	The enum numeric value on the wire for totalResultSize.

hasDocumentQuery()

public boolean hasDocumentQuery()

Query used to search against documents (keyword, filters, etc.).

.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;

Returns
Type	Description
boolean	Whether the documentQuery field is set.

hasRequestMetadata()

public boolean hasRequestMetadata()

The meta information collected about the end user, used to enforce access control and improve the search quality of the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type	Description
boolean	Whether the requestMetadata 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 SearchDocumentsRequest.Builder newBuilderForType()

Returns
Type	Description
SearchDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchDocumentsRequest.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 SearchDocumentsRequest.Builder toBuilder()

Returns
Type	Description
SearchDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException