Class DocumentQuery (0.3.0)

public final class DocumentQuery extends GeneratedMessageV3 implements DocumentQueryOrBuilder

Protobuf type google.cloud.contentwarehouse.v1.DocumentQuery

Static Fields

CUSTOM_PROPERTY_FILTER_FIELD_NUMBER

public static final int CUSTOM_PROPERTY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_CREATOR_FILTER_FIELD_NUMBER

public static final int DOCUMENT_CREATOR_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_TYPE_FILTER_FIELD_NUMBER

public static final int FILE_TYPE_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

FOLDER_NAME_FILTER_FIELD_NUMBER

public static final int FOLDER_NAME_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

IS_NL_QUERY_FIELD_NUMBER

public static final int IS_NL_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FILTER_FIELD_NUMBER

public static final int PROPERTY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_CONTEXT_FIELD_NUMBER

public static final int QUERY_CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_FILTERS_FIELD_NUMBER

public static final int TIME_FILTERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentQuery getDefaultInstance()
Returns
TypeDescription
DocumentQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DocumentQuery.Builder newBuilder()
Returns
TypeDescription
DocumentQuery.Builder

newBuilder(DocumentQuery prototype)

public static DocumentQuery.Builder newBuilder(DocumentQuery prototype)
Parameter
NameDescription
prototypeDocumentQuery
Returns
TypeDescription
DocumentQuery.Builder

parseDelimitedFrom(InputStream input)

public static DocumentQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentQuery> parser()
Returns
TypeDescription
Parser<DocumentQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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=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];

Returns
TypeDescription
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=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];

Returns
TypeDescription
ByteString

The bytes for customPropertyFilter.

getDefaultInstanceForType()

public DocumentQuery getDefaultInstanceForType()
Returns
TypeDescription
DocumentQuery

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

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

Returns
TypeDescription
ProtocolStringList

A list containing the documentCreatorFilter.

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

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

Returns
TypeDescription
ProtocolStringList

A list containing the documentSchemaNames.

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;

Returns
TypeDescription
FileTypeFilter

The fileTypeFilter.

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;

Returns
TypeDescription
FileTypeFilterOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The isNlQuery.

getParserForType()

public Parser<DocumentQuery> getParserForType()
Returns
TypeDescription
Parser<DocumentQuery>
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
NameDescription
indexint
Returns
TypeDescription
PropertyFilter

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

Returns
TypeDescription
List<PropertyFilter>

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
NameDescription
indexint
Returns
TypeDescription
PropertyFilterOrBuilder

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
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder>

getQuery()

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

Returns
TypeDescription
String

The query.

getQueryBytes()

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

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

Returns
TypeDescription
ProtocolStringList

A list containing the queryContext.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
TimeFilter

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

Returns
TypeDescription
List<TimeFilter>

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
NameDescription
indexint
Returns
TypeDescription
TimeFilterOrBuilder

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
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.TimeFilterOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the fileTypeFilter field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentQuery.Builder newBuilderForType()
Returns
TypeDescription
DocumentQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentQuery.Builder toBuilder()
Returns
TypeDescription
DocumentQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException