Class SearchDocumentsRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
- com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.Builder
-
- All Implemented Interfaces:
SearchDocumentsRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchDocumentsRequest
public static final class SearchDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder> implements SearchDocumentsRequestOrBuilder
Request message for DocumentService.SearchDocuments.
Protobuf typegoogle.cloud.contentwarehouse.v1.SearchDocumentsRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchDocumentsRequest.BuilderaddAllHistogramQueries(Iterable<? extends HistogramQuery> values)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderaddHistogramQueries(int index, HistogramQuery value)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderaddHistogramQueries(int index, HistogramQuery.Builder builderForValue)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderaddHistogramQueries(HistogramQuery value)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderaddHistogramQueries(HistogramQuery.Builder builderForValue)An expression specifying a histogram request against matching documents.HistogramQuery.BuilderaddHistogramQueriesBuilder()An expression specifying a histogram request against matching documents.HistogramQuery.BuilderaddHistogramQueriesBuilder(int index)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchDocumentsRequestbuild()SearchDocumentsRequestbuildPartial()SearchDocumentsRequest.Builderclear()SearchDocumentsRequest.BuilderclearDocumentQuery()Query used to search against documents (keyword, filters, etc.).SearchDocumentsRequest.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)SearchDocumentsRequest.BuilderclearHistogramQueries()An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuilderclearOffset()An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results.SearchDocumentsRequest.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)SearchDocumentsRequest.BuilderclearOrderBy()The criteria determining how search results are sorted.SearchDocumentsRequest.BuilderclearPageSize()A limit on the number of documents returned in the search results.SearchDocumentsRequest.BuilderclearPageToken()The token specifying the current offset within search results.SearchDocumentsRequest.BuilderclearParent()Required.SearchDocumentsRequest.BuilderclearQaSizeLimit()Experimental, do not use.SearchDocumentsRequest.BuilderclearRequestMetadata()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.SearchDocumentsRequest.BuilderclearRequireTotalSize()Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.BuilderclearTotalResultSize()Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.Builderclone()SearchDocumentsRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()DocumentQuerygetDocumentQuery()Query used to search against documents (keyword, filters, etc.).DocumentQuery.BuildergetDocumentQueryBuilder()Query used to search against documents (keyword, filters, etc.).DocumentQueryOrBuildergetDocumentQueryOrBuilder()Query used to search against documents (keyword, filters, etc.).HistogramQuerygetHistogramQueries(int index)An expression specifying a histogram request against matching documents.HistogramQuery.BuildergetHistogramQueriesBuilder(int index)An expression specifying a histogram request against matching documents.List<HistogramQuery.Builder>getHistogramQueriesBuilderList()An expression specifying a histogram request against matching documents.intgetHistogramQueriesCount()An expression specifying a histogram request against matching documents.List<HistogramQuery>getHistogramQueriesList()An expression specifying a histogram request against matching documents.HistogramQueryOrBuildergetHistogramQueriesOrBuilder(int index)An expression specifying a histogram request against matching documents.List<? extends HistogramQueryOrBuilder>getHistogramQueriesOrBuilderList()An expression specifying a histogram request against matching documents.intgetOffset()An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results.StringgetOrderBy()The criteria determining how search results are sorted.com.google.protobuf.ByteStringgetOrderByBytes()The criteria determining how search results are sorted.intgetPageSize()A limit on the number of documents returned in the search results.StringgetPageToken()The token specifying the current offset within search results.com.google.protobuf.ByteStringgetPageTokenBytes()The token specifying the current offset within search results.StringgetParent()Required.com.google.protobuf.ByteStringgetParentBytes()Required.intgetQaSizeLimit()Experimental, do not use.RequestMetadatagetRequestMetadata()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.RequestMetadata.BuildergetRequestMetadataBuilder()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.RequestMetadataOrBuildergetRequestMetadataOrBuilder()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.booleangetRequireTotalSize()Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.TotalResultSizegetTotalResultSize()Controls if the search document request requires the return of a total size of matched documents.intgetTotalResultSizeValue()Controls if the search document request requires the return of a total size of matched documents.booleanhasDocumentQuery()Query used to search against documents (keyword, filters, etc.).booleanhasRequestMetadata()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()SearchDocumentsRequest.BuildermergeDocumentQuery(DocumentQuery value)Query used to search against documents (keyword, filters, etc.).SearchDocumentsRequest.BuildermergeFrom(SearchDocumentsRequest other)SearchDocumentsRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)SearchDocumentsRequest.BuildermergeFrom(com.google.protobuf.Message other)SearchDocumentsRequest.BuildermergeRequestMetadata(RequestMetadata value)The meta information collected about the end user, used to enforce access control and improve the search quality of the service.SearchDocumentsRequest.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)SearchDocumentsRequest.BuilderremoveHistogramQueries(int index)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuildersetDocumentQuery(DocumentQuery value)Query used to search against documents (keyword, filters, etc.).SearchDocumentsRequest.BuildersetDocumentQuery(DocumentQuery.Builder builderForValue)Query used to search against documents (keyword, filters, etc.).SearchDocumentsRequest.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchDocumentsRequest.BuildersetHistogramQueries(int index, HistogramQuery value)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuildersetHistogramQueries(int index, HistogramQuery.Builder builderForValue)An expression specifying a histogram request against matching documents.SearchDocumentsRequest.BuildersetOffset(int value)An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results.SearchDocumentsRequest.BuildersetOrderBy(String value)The criteria determining how search results are sorted.SearchDocumentsRequest.BuildersetOrderByBytes(com.google.protobuf.ByteString value)The criteria determining how search results are sorted.SearchDocumentsRequest.BuildersetPageSize(int value)A limit on the number of documents returned in the search results.SearchDocumentsRequest.BuildersetPageToken(String value)The token specifying the current offset within search results.SearchDocumentsRequest.BuildersetPageTokenBytes(com.google.protobuf.ByteString value)The token specifying the current offset within search results.SearchDocumentsRequest.BuildersetParent(String value)Required.SearchDocumentsRequest.BuildersetParentBytes(com.google.protobuf.ByteString value)Required.SearchDocumentsRequest.BuildersetQaSizeLimit(int value)Experimental, do not use.SearchDocumentsRequest.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)SearchDocumentsRequest.BuildersetRequestMetadata(RequestMetadata value)The meta information collected about the end user, used to enforce access control and improve the search quality of the service.SearchDocumentsRequest.BuildersetRequestMetadata(RequestMetadata.Builder builderForValue)The meta information collected about the end user, used to enforce access control and improve the search quality of the service.SearchDocumentsRequest.BuildersetRequireTotalSize(boolean value)Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.BuildersetTotalResultSize(SearchDocumentsRequest.TotalResultSize value)Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.BuildersetTotalResultSizeValue(int value)Controls if the search document request requires the return of a total size of matched documents.SearchDocumentsRequest.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
clear
public SearchDocumentsRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
getDefaultInstanceForType
public SearchDocumentsRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchDocumentsRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchDocumentsRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchDocumentsRequest.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
setField
public SearchDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
clearField
public SearchDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
clearOneof
public SearchDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
setRepeatedField
public SearchDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
addRepeatedField
public SearchDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
mergeFrom
public SearchDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchDocumentsRequest.Builder>
-
mergeFrom
public SearchDocumentsRequest.Builder mergeFrom(SearchDocumentsRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
mergeFrom
public SearchDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchDocumentsRequest.Builder>- Throws:
IOException
-
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) = { ... }- Specified by:
getParentin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The parent.
-
getParentBytes
public com.google.protobuf.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) = { ... }- Specified by:
getParentBytesin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The bytes for parent.
-
setParent
public SearchDocumentsRequest.Builder setParent(String value)
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) = { ... }- Parameters:
value- The parent to set.- Returns:
- This builder for chaining.
-
clearParent
public SearchDocumentsRequest.Builder clearParent()
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:
- This builder for chaining.
-
setParentBytes
public SearchDocumentsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
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) = { ... }- Parameters:
value- The bytes for parent to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
hasRequestMetadatain interfaceSearchDocumentsRequestOrBuilder- Returns:
- Whether the requestMetadata field is set.
-
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;- Specified by:
getRequestMetadatain interfaceSearchDocumentsRequestOrBuilder- Returns:
- The requestMetadata.
-
setRequestMetadata
public SearchDocumentsRequest.Builder setRequestMetadata(RequestMetadata value)
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;
-
setRequestMetadata
public SearchDocumentsRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)
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;
-
mergeRequestMetadata
public SearchDocumentsRequest.Builder mergeRequestMetadata(RequestMetadata value)
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;
-
clearRequestMetadata
public SearchDocumentsRequest.Builder clearRequestMetadata()
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;
-
getRequestMetadataBuilder
public RequestMetadata.Builder getRequestMetadataBuilder()
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;
-
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;- Specified by:
getRequestMetadataOrBuilderin interfaceSearchDocumentsRequestOrBuilder
-
hasDocumentQuery
public boolean hasDocumentQuery()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;- Specified by:
hasDocumentQueryin interfaceSearchDocumentsRequestOrBuilder- Returns:
- Whether the documentQuery field is set.
-
getDocumentQuery
public DocumentQuery getDocumentQuery()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;- Specified by:
getDocumentQueryin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The documentQuery.
-
setDocumentQuery
public SearchDocumentsRequest.Builder setDocumentQuery(DocumentQuery value)
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
-
setDocumentQuery
public SearchDocumentsRequest.Builder setDocumentQuery(DocumentQuery.Builder builderForValue)
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
-
mergeDocumentQuery
public SearchDocumentsRequest.Builder mergeDocumentQuery(DocumentQuery value)
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
-
clearDocumentQuery
public SearchDocumentsRequest.Builder clearDocumentQuery()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
-
getDocumentQueryBuilder
public DocumentQuery.Builder getDocumentQueryBuilder()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
-
getDocumentQueryOrBuilder
public DocumentQueryOrBuilder getDocumentQueryOrBuilder()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;- Specified by:
getDocumentQueryOrBuilderin interfaceSearchDocumentsRequestOrBuilder
-
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][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.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;- Specified by:
getOffsetin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The offset.
-
setOffset
public SearchDocumentsRequest.Builder setOffset(int value)
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][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.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;- Parameters:
value- The offset to set.- Returns:
- This builder for chaining.
-
clearOffset
public SearchDocumentsRequest.Builder clearOffset()
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][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.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:
- This builder for chaining.
-
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;- Specified by:
getPageSizein interfaceSearchDocumentsRequestOrBuilder- Returns:
- The pageSize.
-
setPageSize
public SearchDocumentsRequest.Builder setPageSize(int value)
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;- Parameters:
value- The pageSize to set.- Returns:
- This builder for chaining.
-
clearPageSize
public SearchDocumentsRequest.Builder clearPageSize()
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:
- This builder for chaining.
-
getPageToken
public String getPageToken()
The token specifying the current offset within search results. See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string page_token = 7;- Specified by:
getPageTokenin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The pageToken.
-
getPageTokenBytes
public com.google.protobuf.ByteString getPageTokenBytes()
The token specifying the current offset within search results. See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string page_token = 7;- Specified by:
getPageTokenBytesin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The bytes for pageToken.
-
setPageToken
public SearchDocumentsRequest.Builder setPageToken(String value)
The token specifying the current offset within search results. See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string page_token = 7;- Parameters:
value- The pageToken to set.- Returns:
- This builder for chaining.
-
clearPageToken
public SearchDocumentsRequest.Builder clearPageToken()
The token specifying the current offset within search results. See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string page_token = 7;- Returns:
- This builder for chaining.
-
setPageTokenBytes
public SearchDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
The token specifying the current offset within search results. See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string page_token = 7;- Parameters:
value- The bytes for pageToken to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
getOrderByin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The orderBy.
-
getOrderByBytes
public com.google.protobuf.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;- Specified by:
getOrderByBytesin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The bytes for orderBy.
-
setOrderBy
public SearchDocumentsRequest.Builder setOrderBy(String value)
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;- Parameters:
value- The orderBy to set.- Returns:
- This builder for chaining.
-
clearOrderBy
public SearchDocumentsRequest.Builder clearOrderBy()
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:
- This builder for chaining.
-
setOrderByBytes
public SearchDocumentsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for orderBy to set.- Returns:
- This builder for chaining.
-
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;- Specified by:
getHistogramQueriesListin interfaceSearchDocumentsRequestOrBuilder
-
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;- Specified by:
getHistogramQueriesCountin interfaceSearchDocumentsRequestOrBuilder
-
getHistogramQueries
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;- Specified by:
getHistogramQueriesin interfaceSearchDocumentsRequestOrBuilder
-
setHistogramQueries
public SearchDocumentsRequest.Builder setHistogramQueries(int index, HistogramQuery value)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
setHistogramQueries
public SearchDocumentsRequest.Builder setHistogramQueries(int index, HistogramQuery.Builder builderForValue)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addHistogramQueries
public SearchDocumentsRequest.Builder addHistogramQueries(HistogramQuery value)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addHistogramQueries
public SearchDocumentsRequest.Builder addHistogramQueries(int index, HistogramQuery value)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addHistogramQueries
public SearchDocumentsRequest.Builder addHistogramQueries(HistogramQuery.Builder builderForValue)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addHistogramQueries
public SearchDocumentsRequest.Builder addHistogramQueries(int index, HistogramQuery.Builder builderForValue)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addAllHistogramQueries
public SearchDocumentsRequest.Builder addAllHistogramQueries(Iterable<? extends HistogramQuery> values)
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
clearHistogramQueries
public SearchDocumentsRequest.Builder clearHistogramQueries()
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
removeHistogramQueries
public SearchDocumentsRequest.Builder removeHistogramQueries(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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
getHistogramQueriesBuilder
public HistogramQuery.Builder getHistogramQueriesBuilder(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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
getHistogramQueriesOrBuilder
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;- Specified by:
getHistogramQueriesOrBuilderin interfaceSearchDocumentsRequestOrBuilder
-
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;- Specified by:
getHistogramQueriesOrBuilderListin interfaceSearchDocumentsRequestOrBuilder
-
addHistogramQueriesBuilder
public HistogramQuery.Builder addHistogramQueriesBuilder()
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
addHistogramQueriesBuilder
public HistogramQuery.Builder addHistogramQueriesBuilder(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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
getHistogramQueriesBuilderList
public List<HistogramQuery.Builder> getHistogramQueriesBuilderList()
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 <schema id>.<facet>. Facets will have the format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. 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: <schema id>.<parent facet name>. <child facet name>. 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;
-
getRequireTotalSize
public boolean getRequireTotalSize()
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.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;- Specified by:
getRequireTotalSizein interfaceSearchDocumentsRequestOrBuilder- Returns:
- The requireTotalSize.
-
setRequireTotalSize
public SearchDocumentsRequest.Builder setRequireTotalSize(boolean value)
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.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;- Parameters:
value- The requireTotalSize to set.- Returns:
- This builder for chaining.
-
clearRequireTotalSize
public SearchDocumentsRequest.Builder clearRequireTotalSize()
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.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:
- This builder for chaining.
-
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.SearchDocumentsResponse.total_size].
.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;- Specified by:
getTotalResultSizeValuein interfaceSearchDocumentsRequestOrBuilder- Returns:
- The enum numeric value on the wire for totalResultSize.
-
setTotalResultSizeValue
public SearchDocumentsRequest.Builder setTotalResultSizeValue(int value)
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;- Parameters:
value- The enum numeric value on the wire for totalResultSize to set.- Returns:
- This builder for chaining.
-
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.SearchDocumentsResponse.total_size].
.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;- Specified by:
getTotalResultSizein interfaceSearchDocumentsRequestOrBuilder- Returns:
- The totalResultSize.
-
setTotalResultSize
public SearchDocumentsRequest.Builder setTotalResultSize(SearchDocumentsRequest.TotalResultSize value)
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;- Parameters:
value- The totalResultSize to set.- Returns:
- This builder for chaining.
-
clearTotalResultSize
public SearchDocumentsRequest.Builder clearTotalResultSize()
Controls if the search document request requires the return of a total size of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;- Returns:
- This builder for chaining.
-
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;- Specified by:
getQaSizeLimitin interfaceSearchDocumentsRequestOrBuilder- Returns:
- The qaSizeLimit.
-
setQaSizeLimit
public SearchDocumentsRequest.Builder setQaSizeLimit(int value)
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;- Parameters:
value- The qaSizeLimit to set.- Returns:
- This builder for chaining.
-
clearQaSizeLimit
public SearchDocumentsRequest.Builder clearQaSizeLimit()
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:
- This builder for chaining.
-
setUnknownFields
public final SearchDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
mergeUnknownFields
public final SearchDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder>
-
-