- 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 DocumentQueryOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCustomPropertyFilter() (deprecated)
public abstract String getCustomPropertyFilter()Deprecated. google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=59
This filter specifies a structured syntax to match against the
[PropertyDefinition].[is_filterable][] marked as true. The syntax for
this expression is a subset of SQL syntax.
Supported operators are: =, !=, <, <=, >, and >= where the left
of the operator is a property name and the right of the operator is a
number or a quoted string. You must escape backslash (\\) and quote (\")
characters. Supported functions are LOWER([property_name]) to perform a
case insensitive match and EMPTY([property_name]) to filter on the
existence of a key.
Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
(for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
comparisons or functions are allowed in the expression. The expression must
be < 6000 bytes in length.
Sample Query:
(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
driving_years > 10
string custom_property_filter = 4 [deprecated = true];
| Type | Description |
| String | The customPropertyFilter. |
getCustomPropertyFilterBytes() (deprecated)
public abstract ByteString getCustomPropertyFilterBytes()Deprecated. google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=59
This filter specifies a structured syntax to match against the
[PropertyDefinition].[is_filterable][] marked as true. The syntax for
this expression is a subset of SQL syntax.
Supported operators are: =, !=, <, <=, >, and >= where the left
of the operator is a property name and the right of the operator is a
number or a quoted string. You must escape backslash (\\) and quote (\")
characters. Supported functions are LOWER([property_name]) to perform a
case insensitive match and EMPTY([property_name]) to filter on the
existence of a key.
Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
(for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
comparisons or functions are allowed in the expression. The expression must
be < 6000 bytes in length.
Sample Query:
(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
driving_years > 10
string custom_property_filter = 4 [deprecated = true];
| Type | Description |
| ByteString | The bytes for customPropertyFilter. |
getDocumentCreatorFilter(int index)
public abstract String getDocumentCreatorFilter(int index)The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.
repeated string document_creator_filter = 11;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The documentCreatorFilter at the given index. |
getDocumentCreatorFilterBytes(int index)
public abstract ByteString getDocumentCreatorFilterBytes(int index)The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.
repeated string document_creator_filter = 11;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the documentCreatorFilter at the given index. |
getDocumentCreatorFilterCount()
public abstract int getDocumentCreatorFilterCount()The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.
repeated string document_creator_filter = 11;
| Type | Description |
| int | The count of documentCreatorFilter. |
getDocumentCreatorFilterList()
public abstract List<String> getDocumentCreatorFilterList()The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.
repeated string document_creator_filter = 11;
| Type | Description |
| List<String> | A list containing the documentCreatorFilter. |
getDocumentSchemaNames(int index)
public abstract String getDocumentSchemaNames(int index)This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.
repeated string document_schema_names = 6;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The documentSchemaNames at the given index. |
getDocumentSchemaNamesBytes(int index)
public abstract ByteString getDocumentSchemaNamesBytes(int index)This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.
repeated string document_schema_names = 6;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the documentSchemaNames at the given index. |
getDocumentSchemaNamesCount()
public abstract int getDocumentSchemaNamesCount()This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.
repeated string document_schema_names = 6;
| Type | Description |
| int | The count of documentSchemaNames. |
getDocumentSchemaNamesList()
public abstract List<String> getDocumentSchemaNamesList()This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.
repeated string document_schema_names = 6;
| Type | Description |
| List<String> | A list containing the documentSchemaNames. |
getFileTypeFilter()
public abstract FileTypeFilter getFileTypeFilter()This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned.
.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;
| Type | Description |
| FileTypeFilter | The fileTypeFilter. |
getFileTypeFilterOrBuilder()
public abstract FileTypeFilterOrBuilder getFileTypeFilterOrBuilder()This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned.
.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;
| Type | Description |
| FileTypeFilterOrBuilder |
getFolderNameFilter()
public abstract String getFolderNameFilter()Search all the documents under this specified folder. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
string folder_name_filter = 9;
| Type | Description |
| String | The folderNameFilter. |
getFolderNameFilterBytes()
public abstract ByteString getFolderNameFilterBytes()Search all the documents under this specified folder. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
string folder_name_filter = 9;
| Type | Description |
| ByteString | The bytes for folderNameFilter. |
getIsNlQuery()
public abstract boolean getIsNlQuery() Experimental, do not use.
If the query is a natural language question. False by default. If true,
then the question-answering feature will be used instead of search, and
result_count in SearchDocumentsRequest must be set. In addition, all
other input fields related to search (pagination, histograms, etc.) will be
ignored.
bool is_nl_query = 12;
| Type | Description |
| boolean | The isNlQuery. |
getPropertyFilter(int index)
public abstract PropertyFilter getPropertyFilter(int index) This filter specifies a structured syntax to match against the
PropertyDefinition.is_filterable marked as true. The relationship
between the PropertyFilters is OR.
repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;
| Name | Description |
| index | int |
| Type | Description |
| PropertyFilter |
getPropertyFilterCount()
public abstract int getPropertyFilterCount() This filter specifies a structured syntax to match against the
PropertyDefinition.is_filterable marked as true. The relationship
between the PropertyFilters is OR.
repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;
| Type | Description |
| int |
getPropertyFilterList()
public abstract List<PropertyFilter> getPropertyFilterList() This filter specifies a structured syntax to match against the
PropertyDefinition.is_filterable marked as true. The relationship
between the PropertyFilters is OR.
repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;
| Type | Description |
| List<PropertyFilter> |
getPropertyFilterOrBuilder(int index)
public abstract PropertyFilterOrBuilder getPropertyFilterOrBuilder(int index) This filter specifies a structured syntax to match against the
PropertyDefinition.is_filterable marked as true. The relationship
between the PropertyFilters is OR.
repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;
| Name | Description |
| index | int |
| Type | Description |
| PropertyFilterOrBuilder |
getPropertyFilterOrBuilderList()
public abstract List<? extends PropertyFilterOrBuilder> getPropertyFilterOrBuilderList() This filter specifies a structured syntax to match against the
PropertyDefinition.is_filterable marked as true. The relationship
between the PropertyFilters is OR.
repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;
| Type | Description |
| List<? extends com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder> |
getQuery()
public abstract String getQuery()The query string that matches against the full text of the document and the searchable properties. The maximum number of allowed characters is 255.
string query = 1;
| Type | Description |
| String | The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()The query string that matches against the full text of the document and the searchable properties. The maximum number of allowed characters is 255.
string query = 1;
| Type | Description |
| ByteString | The bytes for query. |
getQueryContext(int index)
public abstract String getQueryContext(int index)For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.
repeated string query_context = 10;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The queryContext at the given index. |
getQueryContextBytes(int index)
public abstract ByteString getQueryContextBytes(int index)For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.
repeated string query_context = 10;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the queryContext at the given index. |
getQueryContextCount()
public abstract int getQueryContextCount()For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.
repeated string query_context = 10;
| Type | Description |
| int | The count of queryContext. |
getQueryContextList()
public abstract List<String> getQueryContextList()For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.
repeated string query_context = 10;
| Type | Description |
| List<String> | A list containing the queryContext. |
getTimeFilters(int index)
public abstract TimeFilter getTimeFilters(int index)Documents created/updated within a range specified by this filter are searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Name | Description |
| index | int |
| Type | Description |
| TimeFilter |
getTimeFiltersCount()
public abstract int getTimeFiltersCount()Documents created/updated within a range specified by this filter are searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Type | Description |
| int |
getTimeFiltersList()
public abstract List<TimeFilter> getTimeFiltersList()Documents created/updated within a range specified by this filter are searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Type | Description |
| List<TimeFilter> |
getTimeFiltersOrBuilder(int index)
public abstract TimeFilterOrBuilder getTimeFiltersOrBuilder(int index)Documents created/updated within a range specified by this filter are searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Name | Description |
| index | int |
| Type | Description |
| TimeFilterOrBuilder |
getTimeFiltersOrBuilderList()
public abstract List<? extends TimeFilterOrBuilder> getTimeFiltersOrBuilderList()Documents created/updated within a range specified by this filter are searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Type | Description |
| List<? extends com.google.cloud.contentwarehouse.v1.TimeFilterOrBuilder> |
hasFileTypeFilter()
public abstract boolean hasFileTypeFilter()This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned.
.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;
| Type | Description |
| boolean | Whether the fileTypeFilter field is set. |