Class DocumentQuery.Builder (0.29.0)

public static final class DocumentQuery.Builder extends GeneratedMessageV3.Builder<DocumentQuery.Builder> implements DocumentQueryOrBuilder

Protobuf type google.cloud.contentwarehouse.v1.DocumentQuery

Inheritance

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

Implements

DocumentQueryOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllDocumentCreatorFilter(Iterable<String> values)

public DocumentQuery.Builder addAllDocumentCreatorFilter(Iterable<String> values)

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
`values`	`Iterable<String>` The documentCreatorFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addAllDocumentNameFilter(Iterable<String> values)

public DocumentQuery.Builder addAllDocumentNameFilter(Iterable<String> values)

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Parameter
Name	Description
`values`	`Iterable<String>` The documentNameFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addAllDocumentSchemaNames(Iterable<String> values)

public DocumentQuery.Builder addAllDocumentSchemaNames(Iterable<String> values)

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
`values`	`Iterable<String>` The documentSchemaNames to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addAllPropertyFilter(Iterable<? extends PropertyFilter> values)

public DocumentQuery.Builder addAllPropertyFilter(Iterable<? extends PropertyFilter> values)

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
`values`	`Iterable<? extends com.google.cloud.contentwarehouse.v1.PropertyFilter>`

Returns
Type	Description
`DocumentQuery.Builder`

addAllQueryContext(Iterable<String> values)

public DocumentQuery.Builder addAllQueryContext(Iterable<String> values)

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
`values`	`Iterable<String>` The queryContext to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addAllTimeFilters(Iterable<? extends TimeFilter> values)

public DocumentQuery.Builder addAllTimeFilters(Iterable<? extends TimeFilter> values)

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
`values`	`Iterable<? extends com.google.cloud.contentwarehouse.v1.TimeFilter>`

Returns
Type	Description
`DocumentQuery.Builder`

addDocumentCreatorFilter(String value)

public DocumentQuery.Builder addDocumentCreatorFilter(String value)

The exact creator(s) of the documents to search against.

repeated string document_creator_filter = 11;

Parameter
Name	Description
`value`	`String` The documentCreatorFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addDocumentCreatorFilterBytes(ByteString value)

public DocumentQuery.Builder addDocumentCreatorFilterBytes(ByteString value)

The exact creator(s) of the documents to search against.

repeated string document_creator_filter = 11;

Parameter
Name	Description
`value`	`ByteString` The bytes of the documentCreatorFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addDocumentNameFilter(String value)

public DocumentQuery.Builder addDocumentNameFilter(String value)

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Parameter
Name	Description
`value`	`String` The documentNameFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addDocumentNameFilterBytes(ByteString value)

public DocumentQuery.Builder addDocumentNameFilterBytes(ByteString value)

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Parameter
Name	Description
`value`	`ByteString` The bytes of the documentNameFilter to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addDocumentSchemaNames(String value)

public DocumentQuery.Builder addDocumentSchemaNames(String value)

This filter specifies the exact document schema Document.document_schema_name of the documents to search against.

At most 20 document schema names are allowed.

repeated string document_schema_names = 6;

Parameter
Name	Description
`value`	`String` The documentSchemaNames to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addDocumentSchemaNamesBytes(ByteString value)

public DocumentQuery.Builder addDocumentSchemaNamesBytes(ByteString value)

This filter specifies the exact document schema Document.document_schema_name of the documents to search against.

At most 20 document schema names are allowed.

repeated string document_schema_names = 6;

Parameter
Name	Description
`value`	`ByteString` The bytes of the documentSchemaNames to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addPropertyFilter(PropertyFilter value)

public DocumentQuery.Builder addPropertyFilter(PropertyFilter value)

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
`value`	`PropertyFilter`

Returns
Type	Description
`DocumentQuery.Builder`

addPropertyFilter(PropertyFilter.Builder builderForValue)

public DocumentQuery.Builder addPropertyFilter(PropertyFilter.Builder builderForValue)

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
`builderForValue`	`PropertyFilter.Builder`

Returns
Type	Description
`DocumentQuery.Builder`

addPropertyFilter(int index, PropertyFilter value)

public DocumentQuery.Builder addPropertyFilter(int index, PropertyFilter value)

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;

Parameters
Name	Description
`index`	`int`
`value`	`PropertyFilter`

Returns
Type	Description
`DocumentQuery.Builder`

addPropertyFilter(int index, PropertyFilter.Builder builderForValue)

public DocumentQuery.Builder addPropertyFilter(int index, PropertyFilter.Builder builderForValue)

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;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`PropertyFilter.Builder`

Returns
Type	Description
`DocumentQuery.Builder`

addPropertyFilterBuilder()

public PropertyFilter.Builder addPropertyFilterBuilder()

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
`PropertyFilter.Builder`

addPropertyFilterBuilder(int index)

public PropertyFilter.Builder addPropertyFilterBuilder(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`

Returns
Type	Description
`PropertyFilter.Builder`

addQueryContext(String value)

public DocumentQuery.Builder addQueryContext(String value)

repeated string query_context = 10;

Parameter
Name	Description
`value`	`String` The queryContext to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addQueryContextBytes(ByteString value)

public DocumentQuery.Builder addQueryContextBytes(ByteString value)

repeated string query_context = 10;

Parameter
Name	Description
`value`	`ByteString` The bytes of the queryContext to add.

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DocumentQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTimeFilters(TimeFilter value)

public DocumentQuery.Builder addTimeFilters(TimeFilter value)

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
`value`	`TimeFilter`

Returns
Type	Description
`DocumentQuery.Builder`

addTimeFilters(TimeFilter.Builder builderForValue)

public DocumentQuery.Builder addTimeFilters(TimeFilter.Builder builderForValue)

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
`builderForValue`	`TimeFilter.Builder`

Returns
Type	Description
`DocumentQuery.Builder`

addTimeFilters(int index, TimeFilter value)

public DocumentQuery.Builder addTimeFilters(int index, TimeFilter value)

Documents created/updated within a range specified by this filter are searched against.

repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

Parameters
Name	Description
`index`	`int`
`value`	`TimeFilter`

Returns
Type	Description
`DocumentQuery.Builder`

addTimeFilters(int index, TimeFilter.Builder builderForValue)

public DocumentQuery.Builder addTimeFilters(int index, TimeFilter.Builder builderForValue)

Documents created/updated within a range specified by this filter are searched against.

repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`TimeFilter.Builder`

Returns
Type	Description
`DocumentQuery.Builder`

addTimeFiltersBuilder()

public TimeFilter.Builder addTimeFiltersBuilder()

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
`TimeFilter.Builder`

addTimeFiltersBuilder(int index)

public TimeFilter.Builder addTimeFiltersBuilder(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`

Returns
Type	Description
`TimeFilter.Builder`

build()

public DocumentQuery build()

Returns
Type	Description
`DocumentQuery`

buildPartial()

public DocumentQuery buildPartial()

Returns
Type	Description
`DocumentQuery`

clear()

public DocumentQuery.Builder clear()

Returns
Type	Description
`DocumentQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCustomPropertyFilter() (deprecated)

public DocumentQuery.Builder clearCustomPropertyFilter()

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
`DocumentQuery.Builder`	This builder for chaining.

clearCustomWeightsMetadata()

public DocumentQuery.Builder clearCustomWeightsMetadata()

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
`DocumentQuery.Builder`

clearDocumentCreatorFilter()

public DocumentQuery.Builder clearDocumentCreatorFilter()

The exact creator(s) of the documents to search against.

repeated string document_creator_filter = 11;

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

clearDocumentNameFilter()

public DocumentQuery.Builder clearDocumentNameFilter()

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

clearDocumentSchemaNames()

public DocumentQuery.Builder clearDocumentSchemaNames()

This filter specifies the exact document schema Document.document_schema_name of the documents to search against.

At most 20 document schema names are allowed.

repeated string document_schema_names = 6;

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentQuery.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DocumentQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFileTypeFilter()

public DocumentQuery.Builder clearFileTypeFilter()

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
`DocumentQuery.Builder`

clearFolderNameFilter()

public DocumentQuery.Builder clearFolderNameFilter()

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
`DocumentQuery.Builder`	This builder for chaining.

clearIsNlQuery()

public DocumentQuery.Builder clearIsNlQuery()

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
`DocumentQuery.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DocumentQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPropertyFilter()

public DocumentQuery.Builder clearPropertyFilter()

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
`DocumentQuery.Builder`

clearQuery()

public DocumentQuery.Builder clearQuery()

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
`DocumentQuery.Builder`	This builder for chaining.

clearQueryContext()

public DocumentQuery.Builder clearQueryContext()

repeated string query_context = 10;

Returns
Type	Description
`DocumentQuery.Builder`	This builder for chaining.

clearTimeFilters()

public DocumentQuery.Builder clearTimeFilters()

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
`DocumentQuery.Builder`

clone()

public DocumentQuery.Builder clone()

Returns
Type	Description
`DocumentQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

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.

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()

.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;

Returns
Type	Description
`CustomWeightsMetadata`	The customWeightsMetadata.

getCustomWeightsMetadataBuilder()

public CustomWeightsMetadata.Builder getCustomWeightsMetadataBuilder()

.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;

Returns
Type	Description
`CustomWeightsMetadata.Builder`

getCustomWeightsMetadataOrBuilder()

public CustomWeightsMetadataOrBuilder getCustomWeightsMetadataOrBuilder()

.google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;

Returns
Type	Description
`CustomWeightsMetadataOrBuilder`

getDefaultInstanceForType()

public DocumentQuery getDefaultInstanceForType()

Returns
Type	Description
`DocumentQuery`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocumentCreatorFilter(int index)

public String getDocumentCreatorFilter(int index)

The exact creator(s) of the documents to search against.

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.

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.

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.

repeated string document_creator_filter = 11;

Returns
Type	Description
`ProtocolStringList`	A list containing the documentCreatorFilter.

getDocumentNameFilter(int index)

public String getDocumentNameFilter(int index)

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The documentNameFilter at the given index.

getDocumentNameFilterBytes(int index)

public ByteString getDocumentNameFilterBytes(int index)

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the documentNameFilter at the given index.

getDocumentNameFilterCount()

public int getDocumentNameFilterCount()

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Returns
Type	Description
`int`	The count of documentNameFilter.

getDocumentNameFilterList()

public ProtocolStringList getDocumentNameFilterList()

Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string document_name_filter = 14;

Returns
Type	Description
`ProtocolStringList`	A list containing the documentNameFilter.

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.

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.

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.

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.

At most 20 document schema names are allowed.

repeated string document_schema_names = 6;

Returns
Type	Description
`ProtocolStringList`	A list containing the documentSchemaNames.

getFileTypeFilter()

public FileTypeFilter getFileTypeFilter()

If no value is specified, ALL files will be returned.

.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;

Returns
Type	Description
`FileTypeFilter`	The fileTypeFilter.

getFileTypeFilterBuilder()

public FileTypeFilter.Builder getFileTypeFilterBuilder()

If no value is specified, ALL files will be returned.

.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;

Returns
Type	Description
`FileTypeFilter.Builder`

getFileTypeFilterOrBuilder()

public FileTypeFilterOrBuilder getFileTypeFilterOrBuilder()

If no value is specified, ALL files will be returned.

.google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;

Returns
Type	Description
`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
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()

bool is_nl_query = 12;

Returns
Type	Description
`boolean`	The isNlQuery.

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`

Returns
Type	Description
`PropertyFilter`

getPropertyFilterBuilder(int index)

public PropertyFilter.Builder getPropertyFilterBuilder(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`

Returns
Type	Description
`PropertyFilter.Builder`

getPropertyFilterBuilderList()

public List<PropertyFilter.Builder> getPropertyFilterBuilderList()

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

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;

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`List<? extends com.google.cloud.contentwarehouse.v1.PropertyFilterOrBuilder>`

getQuery()

public String getQuery()