1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/contentwarehouse/v1/filters.proto 18 19 package com.google.cloud.contentwarehouse.v1; 20 21 public interface PropertyFilterOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.PropertyFilter) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The Document schema name 31 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]. 32 * Format: 33 * projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. 34 * </pre> 35 * 36 * <code>string document_schema_name = 1 [(.google.api.resource_reference) = { ... }</code> 37 * 38 * @return The documentSchemaName. 39 */ getDocumentSchemaName()40 java.lang.String getDocumentSchemaName(); 41 /** 42 * 43 * 44 * <pre> 45 * The Document schema name 46 * [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]. 47 * Format: 48 * projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. 49 * </pre> 50 * 51 * <code>string document_schema_name = 1 [(.google.api.resource_reference) = { ... }</code> 52 * 53 * @return The bytes for documentSchemaName. 54 */ getDocumentSchemaNameBytes()55 com.google.protobuf.ByteString getDocumentSchemaNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * The filter condition. 62 * The syntax for this expression is a subset of SQL syntax. 63 * Supported operators are: `=`, `!=`, `<`, `<=`, `>`, `>=`, and `~~` where 64 * the left of the operator is a property name and the right of the operator 65 * is a number or a quoted string. You must escape backslash (\\) and quote 66 * (\") characters. 67 * `~~` is the LIKE operator. The right of the operator must be a string. The 68 * only supported property data type for LIKE is text_values. It provides 69 * semantic search functionality by parsing, stemming and doing synonyms 70 * expansion against the input query. It matches if the property contains 71 * semantic similar content to the query. It is not regex matching or wildcard 72 * matching. For example, "property.company ~~ \"google\"" will match records 73 * whose property `property.compnay` have values like "Google Inc.", "Google 74 * LLC" or "Google Company". 75 * Supported functions are `LOWER([property_name])` to perform a 76 * case insensitive match and `EMPTY([property_name])` to filter on the 77 * existence of a key. 78 * Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting 79 * (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 80 * comparisons or functions are allowed in the expression. The expression must 81 * be < 6000 bytes in length. 82 * Only properties that are marked filterable are allowed 83 * ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]). 84 * Property names do not need to be prefixed by the document schema id (as is 85 * the case with histograms), however property names will need to be prefixed 86 * by its parent hierarchy, if any. For example: 87 * top_property_name.sub_property_name. 88 * Sample Query: 89 * `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND 90 * driving_years > 10` 91 * CMEK compliant deployment only supports: 92 * * Operators: `=`, `<`, `<=`, `>`, and `>=`. 93 * * Boolean expressions: AND and OR. 94 * </pre> 95 * 96 * <code>string condition = 2;</code> 97 * 98 * @return The condition. 99 */ getCondition()100 java.lang.String getCondition(); 101 /** 102 * 103 * 104 * <pre> 105 * The filter condition. 106 * The syntax for this expression is a subset of SQL syntax. 107 * Supported operators are: `=`, `!=`, `<`, `<=`, `>`, `>=`, and `~~` where 108 * the left of the operator is a property name and the right of the operator 109 * is a number or a quoted string. You must escape backslash (\\) and quote 110 * (\") characters. 111 * `~~` is the LIKE operator. The right of the operator must be a string. The 112 * only supported property data type for LIKE is text_values. It provides 113 * semantic search functionality by parsing, stemming and doing synonyms 114 * expansion against the input query. It matches if the property contains 115 * semantic similar content to the query. It is not regex matching or wildcard 116 * matching. For example, "property.company ~~ \"google\"" will match records 117 * whose property `property.compnay` have values like "Google Inc.", "Google 118 * LLC" or "Google Company". 119 * Supported functions are `LOWER([property_name])` to perform a 120 * case insensitive match and `EMPTY([property_name])` to filter on the 121 * existence of a key. 122 * Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting 123 * (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 124 * comparisons or functions are allowed in the expression. The expression must 125 * be < 6000 bytes in length. 126 * Only properties that are marked filterable are allowed 127 * ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]). 128 * Property names do not need to be prefixed by the document schema id (as is 129 * the case with histograms), however property names will need to be prefixed 130 * by its parent hierarchy, if any. For example: 131 * top_property_name.sub_property_name. 132 * Sample Query: 133 * `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND 134 * driving_years > 10` 135 * CMEK compliant deployment only supports: 136 * * Operators: `=`, `<`, `<=`, `>`, and `>=`. 137 * * Boolean expressions: AND and OR. 138 * </pre> 139 * 140 * <code>string condition = 2;</code> 141 * 142 * @return The bytes for condition. 143 */ getConditionBytes()144 com.google.protobuf.ByteString getConditionBytes(); 145 } 146