Class SearchDocumentsRequest.Builder (0.48.0) 

public static final class SearchDocumentsRequest.Builder extends GeneratedMessageV3.Builder<SearchDocumentsRequest.Builder> implements SearchDocumentsRequestOrBuilder

Request message for DocumentService.SearchDocuments.

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllHistogramQueries(Iterable<? extends HistogramQuery> values)

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 &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
values Iterable<? extends com.google.cloud.contentwarehouse.v1.HistogramQuery>
Returns
Type Description
SearchDocumentsRequest.Builder

addHistogramQueries(HistogramQuery value)

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 &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
value HistogramQuery
Returns
Type Description
SearchDocumentsRequest.Builder

addHistogramQueries(HistogramQuery.Builder builderForValue)

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 &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
builderForValue HistogramQuery.Builder
Returns
Type Description
SearchDocumentsRequest.Builder

addHistogramQueries(int index, HistogramQuery value)

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 &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;

Parameters
Name Description
index int
value HistogramQuery
Returns
Type Description
SearchDocumentsRequest.Builder

addHistogramQueries(int index, HistogramQuery.Builder builderForValue)

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 &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;

Parameters
Name Description
index int
builderForValue HistogramQuery.Builder
Returns
Type Description
SearchDocumentsRequest.Builder

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 &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
HistogramQuery.Builder

addHistogramQueriesBuilder(int index)

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 &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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

build()

public SearchDocumentsRequest build()
Returns
Type Description
SearchDocumentsRequest

buildPartial()

public SearchDocumentsRequest buildPartial()
Returns
Type Description
SearchDocumentsRequest

clear()

public SearchDocumentsRequest.Builder clear()
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

clearDocumentQuery()

public SearchDocumentsRequest.Builder clearDocumentQuery()

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

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

Returns
Type Description
SearchDocumentsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

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 &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
SearchDocumentsRequest.Builder

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 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
SearchDocumentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

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
Type Description
SearchDocumentsRequest.Builder

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
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchDocumentsRequest.Builder clearPageToken()

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
SearchDocumentsRequest.Builder

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
Type Description
SearchDocumentsRequest.Builder

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
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

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;

Returns
Type Description
SearchDocumentsRequest.Builder

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.

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
SearchDocumentsRequest.Builder

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.SearchDocumentsRequest.TotalResultSize total_result_size = 12;

Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

clone()

public SearchDocumentsRequest.Builder clone()
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
SearchDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDocumentQueryBuilder()

public DocumentQuery.Builder getDocumentQueryBuilder()

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

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

Returns
Type Description
DocumentQuery.Builder

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

getHistogramQueriesBuilder(int index)

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 &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.Builder

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 &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<Builder>

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.

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.

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;

Returns
Type Description
RequestMetadata.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocumentQuery(DocumentQuery value)

public SearchDocumentsRequest.Builder mergeDocumentQuery(DocumentQuery value)

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

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

Parameter
Name Description
value DocumentQuery
Returns
Type Description
SearchDocumentsRequest.Builder

mergeFrom(SearchDocumentsRequest other)

public SearchDocumentsRequest.Builder mergeFrom(SearchDocumentsRequest other)
Parameter
Name Description
other SearchDocumentsRequest
Returns
Type Description
SearchDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchDocumentsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

mergeRequestMetadata(RequestMetadata value)

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;

Parameter
Name Description
value RequestMetadata
Returns
Type Description
SearchDocumentsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

removeHistogramQueries(int index)

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 &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
SearchDocumentsRequest.Builder

setDocumentQuery(DocumentQuery value)

public SearchDocumentsRequest.Builder setDocumentQuery(DocumentQuery value)

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

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

Parameter
Name Description
value DocumentQuery
Returns
Type Description
SearchDocumentsRequest.Builder

setDocumentQuery(DocumentQuery.Builder builderForValue)

public SearchDocumentsRequest.Builder setDocumentQuery(DocumentQuery.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue DocumentQuery.Builder
Returns
Type Description
SearchDocumentsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

setHistogramQueries(int index, HistogramQuery value)

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 &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;

Parameters
Name Description
index int
value HistogramQuery
Returns
Type Description
SearchDocumentsRequest.Builder

setHistogramQueries(int index, HistogramQuery.Builder builderForValue)

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 &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;

Parameters
Name Description
index int
builderForValue HistogramQuery.Builder
Returns
Type Description
SearchDocumentsRequest.Builder

setOffset(int value)

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 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;

Parameter
Name Description
value int

The offset to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setOrderBy(String value)

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;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchDocumentsRequest.Builder setOrderByBytes(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;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchDocumentsRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchDocumentsRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchDocumentsRequest.Builder setParentBytes(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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setQaSizeLimit(int value)

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;

Parameter
Name Description
value int

The qaSizeLimit to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides

setRequestMetadata(RequestMetadata value)

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;

Parameter
Name Description
value RequestMetadata
Returns
Type Description
SearchDocumentsRequest.Builder

setRequestMetadata(RequestMetadata.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RequestMetadata.Builder
Returns
Type Description
SearchDocumentsRequest.Builder

setRequireTotalSize(boolean value)

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.

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;

Parameter
Name Description
value boolean

The requireTotalSize to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setTotalResultSize(SearchDocumentsRequest.TotalResultSize value)

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.SearchDocumentsRequest.TotalResultSize total_result_size = 12;

Parameter
Name Description
value SearchDocumentsRequest.TotalResultSize

The totalResultSize to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setTotalResultSizeValue(int value)

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.SearchDocumentsRequest.TotalResultSize total_result_size = 12;

Parameter
Name Description
value int

The enum numeric value on the wire for totalResultSize to set.
Returns
Type Description
SearchDocumentsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchDocumentsRequest.Builder
Overrides