public final class DocumentQuery extends GeneratedMessageV3 implements DocumentQueryOrBuilder
Protobuf type google.cloud.contentwarehouse.v1.DocumentQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CUSTOM_PROPERTY_FILTER_FIELD_NUMBER
public static final int CUSTOM_PROPERTY_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CUSTOM_WEIGHTS_METADATA_FIELD_NUMBER
public static final int CUSTOM_WEIGHTS_METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DOCUMENT_CREATOR_FILTER_FIELD_NUMBER
public static final int DOCUMENT_CREATOR_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER
public static final int DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILE_TYPE_FILTER_FIELD_NUMBER
public static final int FILE_TYPE_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FOLDER_NAME_FILTER_FIELD_NUMBER
public static final int FOLDER_NAME_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IS_NL_QUERY_FIELD_NUMBER
public static final int IS_NL_QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROPERTY_FILTER_FIELD_NUMBER
public static final int PROPERTY_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_CONTEXT_FIELD_NUMBER
public static final int QUERY_CONTEXT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIME_FILTERS_FIELD_NUMBER
public static final int TIME_FILTERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static DocumentQuery getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DocumentQuery.Builder newBuilder()
newBuilder(DocumentQuery prototype)
public static DocumentQuery.Builder newBuilder(DocumentQuery prototype)
parseDelimitedFrom(InputStream input)
public static DocumentQuery parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DocumentQuery parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DocumentQuery parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static DocumentQuery parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static DocumentQuery parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DocumentQuery parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DocumentQuery> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCustomPropertyFilter() (deprecated)
public String getCustomPropertyFilter()
Deprecated. google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is
deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104
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];
| Returns |
|---|
| Type | Description |
String | The customPropertyFilter.
|
getCustomPropertyFilterBytes() (deprecated)
public ByteString getCustomPropertyFilterBytes()
Deprecated. google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is
deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for customPropertyFilter.
|
getCustomWeightsMetadata()
public CustomWeightsMetadata getCustomWeightsMetadata()
To support the custom weighting across document schemas, customers need to
provide the properties to be used to boost the ranking in the search
request. For a search query with CustomWeightsMetadata specified, only the
RetrievalImportance for the properties in the CustomWeightsMetadata will
be honored.
.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;
getCustomWeightsMetadataOrBuilder()
public CustomWeightsMetadataOrBuilder getCustomWeightsMetadataOrBuilder()
To support the custom weighting across document schemas, customers need to
provide the properties to be used to boost the ranking in the search
request. For a search query with CustomWeightsMetadata specified, only the
RetrievalImportance for the properties in the CustomWeightsMetadata will
be honored.
.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;
getDefaultInstanceForType()
public DocumentQuery getDefaultInstanceForType()
getDocumentCreatorFilter(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The documentCreatorFilter at the given index.
|
getDocumentCreatorFilterBytes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the documentCreatorFilter at the given index.
|
getDocumentCreatorFilterCount()
public 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;
| Returns |
|---|
| Type | Description |
int | The count of documentCreatorFilter.
|
getDocumentCreatorFilterList()
public ProtocolStringList 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;
getDocumentSchemaNames(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The documentSchemaNames at the given index.
|
getDocumentSchemaNamesBytes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the documentSchemaNames at the given index.
|
getDocumentSchemaNamesCount()
public 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;
| Returns |
|---|
| Type | Description |
int | The count of documentSchemaNames.
|
getDocumentSchemaNamesList()
public ProtocolStringList 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;
getFileTypeFilter()
public 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;
getFileTypeFilterOrBuilder()
public 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;
getFolderNameFilter()
public String getFolderNameFilter()
Search all the documents under this specified folder.
Format:
projects/{project_number}/locations/{location}/documents/{document_id}.
string folder_name_filter = 9;
| Returns |
|---|
| Type | Description |
String | The folderNameFilter.
|
getFolderNameFilterBytes()
public ByteString getFolderNameFilterBytes()
Search all the documents under this specified folder.
Format:
projects/{project_number}/locations/{location}/documents/{document_id}.
string folder_name_filter = 9;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for folderNameFilter.
|
getIsNlQuery()
public 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;
| Returns |
|---|
| Type | Description |
boolean | The isNlQuery.
|
getParserForType()
public Parser<DocumentQuery> getParserForType()
Overrides
getPropertyFilter(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
|
getPropertyFilterCount()
public 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;
| Returns |
|---|
| Type | Description |
int | |
getPropertyFilterList()
public 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;
getPropertyFilterOrBuilder(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
|
getPropertyFilterOrBuilderList()
public 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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder> | |
getQuery()
The query string that matches against the full text of the document and
the searchable properties.
The query partially supports Google AIP style
syntax. Specifically, the query supports
literals, logical operators, negation operators, comparison operators, and
functions.
Literals: A bare literal value (examples: "42", "Hugo") is a value to be
matched against. It searches over the full text of the document and the
searchable properties.
Logical operators: "AND", "and", "OR", and "or" are binary logical
operators (example: "engineer OR developer").
Negation operators: "NOT" and "!" are negation operators (example: "NOT
software").
Comparison operators: support the binary comparison operators =, !=, <, >,
<= and >= for string, numeric, enum, boolean. Also support like operator
~~ for string. It provides semantic search functionality by parsing,
stemming and doing synonyms expansion against the input query.
To specify a property in the query, the left hand side expression in the
comparison must be the property ID including the parent. The right hand
side must be literals. For example:
"\"projects/123/locations/us\".property_a < 1" matches results whose
"property_a" is less than 1 in project 123 and us location.
The literals and comparison expression can be connected in a single query
(example: "software engineer \"projects/123/locations/us\".salary > 100").
Functions: supported functions are LOWER([property_name]) to perform a
case insensitive match and EMPTY([property_name]) to filter on the
existence of a key.
Support nested expressions connected using parenthesis and logical
operators. The default logical operators is AND if there is no operators
between expressions.
The query can be used with other filters e.g. time_filters and
folder_name_filter. They are connected with AND operator under the
hood.
The maximum number of allowed characters is 255.
string query = 1;
| Returns |
|---|
| Type | Description |
String | The query.
|
getQueryBytes()
public ByteString getQueryBytes()
The query string that matches against the full text of the document and
the searchable properties.
The query partially supports Google AIP style
syntax. Specifically, the query supports
literals, logical operators, negation operators, comparison operators, and
functions.
Literals: A bare literal value (examples: "42", "Hugo") is a value to be
matched against. It searches over the full text of the document and the
searchable properties.
Logical operators: "AND", "and", "OR", and "or" are binary logical
operators (example: "engineer OR developer").
Negation operators: "NOT" and "!" are negation operators (example: "NOT
software").
Comparison operators: support the binary comparison operators =, !=, <, >,
<= and >= for string, numeric, enum, boolean. Also support like operator
~~ for string. It provides semantic search functionality by parsing,
stemming and doing synonyms expansion against the input query.
To specify a property in the query, the left hand side expression in the
comparison must be the property ID including the parent. The right hand
side must be literals. For example:
"\"projects/123/locations/us\".property_a < 1" matches results whose
"property_a" is less than 1 in project 123 and us location.
The literals and comparison expression can be connected in a single query
(example: "software engineer \"projects/123/locations/us\".salary > 100").
Functions: supported functions are LOWER([property_name]) to perform a
case insensitive match and EMPTY([property_name]) to filter on the
existence of a key.
Support nested expressions connected using parenthesis and logical
operators. The default logical operators is AND if there is no operators
between expressions.
The query can be used with other filters e.g. time_filters and
folder_name_filter. They are connected with AND operator under the
hood.
The maximum number of allowed characters is 255.
string query = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for query.
|
getQueryContext(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The queryContext at the given index.
|
getQueryContextBytes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the queryContext at the given index.
|
getQueryContextCount()
public 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;
| Returns |
|---|
| Type | Description |
int | The count of queryContext.
|
getQueryContextList()
public ProtocolStringList 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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getTimeFilters(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
|
getTimeFiltersCount()
public int getTimeFiltersCount()
Documents created/updated within a range specified by this filter are
searched against.
repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;
| Returns |
|---|
| Type | Description |
int | |
getTimeFiltersList()
public 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;
getTimeFiltersOrBuilder(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
|
getTimeFiltersOrBuilderList()
public 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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.contentwarehouse.v1.TimeFilterOrBuilder> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasCustomWeightsMetadata()
public boolean hasCustomWeightsMetadata()
To support the custom weighting across document schemas, customers need to
provide the properties to be used to boost the ranking in the search
request. For a search query with CustomWeightsMetadata specified, only the
RetrievalImportance for the properties in the CustomWeightsMetadata will
be honored.
.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;
| Returns |
|---|
| Type | Description |
boolean | Whether the customWeightsMetadata field is set.
|
hasFileTypeFilter()
public 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;
| Returns |
|---|
| Type | Description |
boolean | Whether the fileTypeFilter field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DocumentQuery.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public DocumentQuery.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
