- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface SearchDocumentsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDocumentQuery()
public abstract DocumentQuery getDocumentQuery()Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
| Returns | |
|---|---|
| Type | Description |
DocumentQuery | The documentQuery. |
getDocumentQueryOrBuilder()
public abstract 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 abstract 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. 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;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HistogramQuery | |
getHistogramQueriesCount()
public abstract 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. 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;
| Returns | |
|---|---|
| Type | Description |
int | |
getHistogramQueriesList()
public abstract 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. 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;
| Returns | |
|---|---|
| Type | Description |
List<HistogramQuery> | |
getHistogramQueriesOrBuilder(int index)
public abstract 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. 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;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryOrBuilder | |
getHistogramQueriesOrBuilderList()
public abstract 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. 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> | |
getOffset()
public abstract 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 abstract 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.
string order_by = 8;
| Returns | |
|---|---|
| Type | Description |
String | The orderBy. |
getOrderByBytes()
public abstract 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.
string order_by = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for orderBy. |
getPageSize()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract RequestMetadata getRequestMetadata()The meta information collected about the end user, used to enforce access control and improve the search quality of the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
| Returns | |
|---|---|
| Type | Description |
RequestMetadata | The requestMetadata. |
getRequestMetadataOrBuilder()
public abstract 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 abstract boolean getRequireTotalSize()Optional. 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. |
hasDocumentQuery()
public abstract 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 abstract 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. |