1// Copyright 2019 Google LLC. 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14// 15 16// Code generated by protoc-gen-go. DO NOT EDIT. 17// versions: 18// protoc-gen-go v1.26.0 19// protoc v3.12.2 20// source: google/firestore/admin/v1beta2/field.proto 21 22package admin 23 24import ( 25 reflect "reflect" 26 sync "sync" 27 28 _ "google.golang.org/genproto/googleapis/api/annotations" 29 protoreflect "google.golang.org/protobuf/reflect/protoreflect" 30 protoimpl "google.golang.org/protobuf/runtime/protoimpl" 31) 32 33const ( 34 // Verify that this generated code is sufficiently up-to-date. 35 _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) 36 // Verify that runtime/protoimpl is sufficiently up-to-date. 37 _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) 38) 39 40// Represents a single field in the database. 41// 42// Fields are grouped by their "Collection Group", which represent all 43// collections in the database with the same id. 44type Field struct { 45 state protoimpl.MessageState 46 sizeCache protoimpl.SizeCache 47 unknownFields protoimpl.UnknownFields 48 49 // A field name of the form 50 // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` 51 // 52 // A field path may be a simple field name, e.g. `address` or a path to fields 53 // within map_value , e.g. `address.city`, 54 // or a special field path. The only valid special field is `*`, which 55 // represents any field. 56 // 57 // Field paths may be quoted using ` (backtick). The only character that needs 58 // to be escaped within a quoted field path is the backtick character itself, 59 // escaped using a backslash. Special characters in field paths that 60 // must be quoted include: `*`, `.`, 61 // ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. 62 // 63 // Examples: 64 // (Note: Comments here are written in markdown syntax, so there is an 65 // additional layer of backticks to represent a code block) 66 // `\`address.city\`` represents a field named `address.city`, not the map key 67 // `city` in the field `address`. 68 // `\`*\`` represents a field named `*`, not any field. 69 // 70 // A special `Field` contains the default indexing settings for all fields. 71 // This field's resource name is: 72 // `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` 73 // Indexes defined on this `Field` will be applied to all fields which do not 74 // have their own `Field` index configuration. 75 Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` 76 // The index configuration for this field. If unset, field indexing will 77 // revert to the configuration defined by the `ancestor_field`. To 78 // explicitly remove all indexes for this field, specify an index config 79 // with an empty list of indexes. 80 IndexConfig *Field_IndexConfig `protobuf:"bytes,2,opt,name=index_config,json=indexConfig,proto3" json:"index_config,omitempty"` 81} 82 83func (x *Field) Reset() { 84 *x = Field{} 85 if protoimpl.UnsafeEnabled { 86 mi := &file_google_firestore_admin_v1beta2_field_proto_msgTypes[0] 87 ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) 88 ms.StoreMessageInfo(mi) 89 } 90} 91 92func (x *Field) String() string { 93 return protoimpl.X.MessageStringOf(x) 94} 95 96func (*Field) ProtoMessage() {} 97 98func (x *Field) ProtoReflect() protoreflect.Message { 99 mi := &file_google_firestore_admin_v1beta2_field_proto_msgTypes[0] 100 if protoimpl.UnsafeEnabled && x != nil { 101 ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) 102 if ms.LoadMessageInfo() == nil { 103 ms.StoreMessageInfo(mi) 104 } 105 return ms 106 } 107 return mi.MessageOf(x) 108} 109 110// Deprecated: Use Field.ProtoReflect.Descriptor instead. 111func (*Field) Descriptor() ([]byte, []int) { 112 return file_google_firestore_admin_v1beta2_field_proto_rawDescGZIP(), []int{0} 113} 114 115func (x *Field) GetName() string { 116 if x != nil { 117 return x.Name 118 } 119 return "" 120} 121 122func (x *Field) GetIndexConfig() *Field_IndexConfig { 123 if x != nil { 124 return x.IndexConfig 125 } 126 return nil 127} 128 129// The index configuration for this field. 130type Field_IndexConfig struct { 131 state protoimpl.MessageState 132 sizeCache protoimpl.SizeCache 133 unknownFields protoimpl.UnknownFields 134 135 // The indexes supported for this field. 136 Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"` 137 // Output only. When true, the `Field`'s index configuration is set from the 138 // configuration specified by the `ancestor_field`. 139 // When false, the `Field`'s index configuration is defined explicitly. 140 UsesAncestorConfig bool `protobuf:"varint,2,opt,name=uses_ancestor_config,json=usesAncestorConfig,proto3" json:"uses_ancestor_config,omitempty"` 141 // Output only. Specifies the resource name of the `Field` from which this field's 142 // index configuration is set (when `uses_ancestor_config` is true), 143 // or from which it *would* be set if this field had no index configuration 144 // (when `uses_ancestor_config` is false). 145 AncestorField string `protobuf:"bytes,3,opt,name=ancestor_field,json=ancestorField,proto3" json:"ancestor_field,omitempty"` 146 // Output only 147 // When true, the `Field`'s index configuration is in the process of being 148 // reverted. Once complete, the index config will transition to the same 149 // state as the field specified by `ancestor_field`, at which point 150 // `uses_ancestor_config` will be `true` and `reverting` will be `false`. 151 Reverting bool `protobuf:"varint,4,opt,name=reverting,proto3" json:"reverting,omitempty"` 152} 153 154func (x *Field_IndexConfig) Reset() { 155 *x = Field_IndexConfig{} 156 if protoimpl.UnsafeEnabled { 157 mi := &file_google_firestore_admin_v1beta2_field_proto_msgTypes[1] 158 ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) 159 ms.StoreMessageInfo(mi) 160 } 161} 162 163func (x *Field_IndexConfig) String() string { 164 return protoimpl.X.MessageStringOf(x) 165} 166 167func (*Field_IndexConfig) ProtoMessage() {} 168 169func (x *Field_IndexConfig) ProtoReflect() protoreflect.Message { 170 mi := &file_google_firestore_admin_v1beta2_field_proto_msgTypes[1] 171 if protoimpl.UnsafeEnabled && x != nil { 172 ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) 173 if ms.LoadMessageInfo() == nil { 174 ms.StoreMessageInfo(mi) 175 } 176 return ms 177 } 178 return mi.MessageOf(x) 179} 180 181// Deprecated: Use Field_IndexConfig.ProtoReflect.Descriptor instead. 182func (*Field_IndexConfig) Descriptor() ([]byte, []int) { 183 return file_google_firestore_admin_v1beta2_field_proto_rawDescGZIP(), []int{0, 0} 184} 185 186func (x *Field_IndexConfig) GetIndexes() []*Index { 187 if x != nil { 188 return x.Indexes 189 } 190 return nil 191} 192 193func (x *Field_IndexConfig) GetUsesAncestorConfig() bool { 194 if x != nil { 195 return x.UsesAncestorConfig 196 } 197 return false 198} 199 200func (x *Field_IndexConfig) GetAncestorField() string { 201 if x != nil { 202 return x.AncestorField 203 } 204 return "" 205} 206 207func (x *Field_IndexConfig) GetReverting() bool { 208 if x != nil { 209 return x.Reverting 210 } 211 return false 212} 213 214var File_google_firestore_admin_v1beta2_field_proto protoreflect.FileDescriptor 215 216var file_google_firestore_admin_v1beta2_field_proto_rawDesc = []byte{ 217 0x0a, 0x2a, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 218 0x72, 0x65, 0x2f, 0x61, 0x64, 0x6d, 0x69, 0x6e, 0x2f, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 219 0x2f, 0x66, 0x69, 0x65, 0x6c, 0x64, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x1e, 0x67, 0x6f, 220 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2e, 0x61, 221 0x64, 0x6d, 0x69, 0x6e, 0x2e, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x1a, 0x2a, 0x67, 0x6f, 222 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2f, 0x61, 223 0x64, 0x6d, 0x69, 0x6e, 0x2f, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x2f, 0x69, 0x6e, 0x64, 224 0x65, 0x78, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x1a, 0x1c, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 225 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x61, 0x6e, 0x6e, 0x6f, 0x74, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73, 226 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0xb9, 0x02, 0x0a, 0x05, 0x46, 0x69, 0x65, 0x6c, 0x64, 227 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 228 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x54, 0x0a, 0x0c, 0x69, 0x6e, 0x64, 0x65, 0x78, 0x5f, 0x63, 0x6f, 229 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x31, 0x2e, 0x67, 0x6f, 0x6f, 230 0x67, 0x6c, 0x65, 0x2e, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2e, 0x61, 0x64, 231 0x6d, 0x69, 0x6e, 0x2e, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x2e, 0x46, 0x69, 0x65, 0x6c, 232 0x64, 0x2e, 0x49, 0x6e, 0x64, 0x65, 0x78, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x52, 0x0b, 0x69, 233 0x6e, 0x64, 0x65, 0x78, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0xc5, 0x01, 0x0a, 0x0b, 0x49, 234 0x6e, 0x64, 0x65, 0x78, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x3f, 0x0a, 0x07, 0x69, 0x6e, 235 0x64, 0x65, 0x78, 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x25, 0x2e, 0x67, 0x6f, 236 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2e, 0x61, 237 0x64, 0x6d, 0x69, 0x6e, 0x2e, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x2e, 0x49, 0x6e, 0x64, 238 0x65, 0x78, 0x52, 0x07, 0x69, 0x6e, 0x64, 0x65, 0x78, 0x65, 0x73, 0x12, 0x30, 0x0a, 0x14, 0x75, 239 0x73, 0x65, 0x73, 0x5f, 0x61, 0x6e, 0x63, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x5f, 0x63, 0x6f, 0x6e, 240 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x08, 0x52, 0x12, 0x75, 0x73, 0x65, 0x73, 0x41, 241 0x6e, 0x63, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x25, 0x0a, 242 0x0e, 0x61, 0x6e, 0x63, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x5f, 0x66, 0x69, 0x65, 0x6c, 0x64, 0x18, 243 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0d, 0x61, 0x6e, 0x63, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x46, 244 0x69, 0x65, 0x6c, 0x64, 0x12, 0x1c, 0x0a, 0x09, 0x72, 0x65, 0x76, 0x65, 0x72, 0x74, 0x69, 0x6e, 245 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, 0x72, 0x65, 0x76, 0x65, 0x72, 0x74, 0x69, 246 0x6e, 0x67, 0x42, 0xa5, 0x01, 0x0a, 0x22, 0x63, 0x6f, 0x6d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 247 0x65, 0x2e, 0x66, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2e, 0x61, 0x64, 0x6d, 0x69, 248 0x6e, 0x2e, 0x76, 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x42, 0x0a, 0x46, 0x69, 0x65, 0x6c, 0x64, 249 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x43, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 250 0x67, 0x6f, 0x6c, 0x61, 0x6e, 0x67, 0x2e, 0x6f, 0x72, 0x67, 0x2f, 0x67, 0x65, 0x6e, 0x70, 0x72, 251 0x6f, 0x74, 0x6f, 0x2f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x61, 0x70, 0x69, 0x73, 0x2f, 0x66, 252 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2f, 0x61, 0x64, 0x6d, 0x69, 0x6e, 0x2f, 0x76, 253 0x31, 0x62, 0x65, 0x74, 0x61, 0x32, 0x3b, 0x61, 0x64, 0x6d, 0x69, 0x6e, 0xa2, 0x02, 0x04, 0x47, 254 0x43, 0x46, 0x53, 0xaa, 0x02, 0x24, 0x47, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x43, 0x6c, 0x6f, 255 0x75, 0x64, 0x2e, 0x46, 0x69, 0x72, 0x65, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2e, 0x41, 0x64, 0x6d, 256 0x69, 0x6e, 0x2e, 0x56, 0x31, 0x42, 0x65, 0x74, 0x61, 0x32, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 257 0x6f, 0x33, 258} 259 260var ( 261 file_google_firestore_admin_v1beta2_field_proto_rawDescOnce sync.Once 262 file_google_firestore_admin_v1beta2_field_proto_rawDescData = file_google_firestore_admin_v1beta2_field_proto_rawDesc 263) 264 265func file_google_firestore_admin_v1beta2_field_proto_rawDescGZIP() []byte { 266 file_google_firestore_admin_v1beta2_field_proto_rawDescOnce.Do(func() { 267 file_google_firestore_admin_v1beta2_field_proto_rawDescData = protoimpl.X.CompressGZIP(file_google_firestore_admin_v1beta2_field_proto_rawDescData) 268 }) 269 return file_google_firestore_admin_v1beta2_field_proto_rawDescData 270} 271 272var file_google_firestore_admin_v1beta2_field_proto_msgTypes = make([]protoimpl.MessageInfo, 2) 273var file_google_firestore_admin_v1beta2_field_proto_goTypes = []interface{}{ 274 (*Field)(nil), // 0: google.firestore.admin.v1beta2.Field 275 (*Field_IndexConfig)(nil), // 1: google.firestore.admin.v1beta2.Field.IndexConfig 276 (*Index)(nil), // 2: google.firestore.admin.v1beta2.Index 277} 278var file_google_firestore_admin_v1beta2_field_proto_depIdxs = []int32{ 279 1, // 0: google.firestore.admin.v1beta2.Field.index_config:type_name -> google.firestore.admin.v1beta2.Field.IndexConfig 280 2, // 1: google.firestore.admin.v1beta2.Field.IndexConfig.indexes:type_name -> google.firestore.admin.v1beta2.Index 281 2, // [2:2] is the sub-list for method output_type 282 2, // [2:2] is the sub-list for method input_type 283 2, // [2:2] is the sub-list for extension type_name 284 2, // [2:2] is the sub-list for extension extendee 285 0, // [0:2] is the sub-list for field type_name 286} 287 288func init() { file_google_firestore_admin_v1beta2_field_proto_init() } 289func file_google_firestore_admin_v1beta2_field_proto_init() { 290 if File_google_firestore_admin_v1beta2_field_proto != nil { 291 return 292 } 293 file_google_firestore_admin_v1beta2_index_proto_init() 294 if !protoimpl.UnsafeEnabled { 295 file_google_firestore_admin_v1beta2_field_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { 296 switch v := v.(*Field); i { 297 case 0: 298 return &v.state 299 case 1: 300 return &v.sizeCache 301 case 2: 302 return &v.unknownFields 303 default: 304 return nil 305 } 306 } 307 file_google_firestore_admin_v1beta2_field_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { 308 switch v := v.(*Field_IndexConfig); i { 309 case 0: 310 return &v.state 311 case 1: 312 return &v.sizeCache 313 case 2: 314 return &v.unknownFields 315 default: 316 return nil 317 } 318 } 319 } 320 type x struct{} 321 out := protoimpl.TypeBuilder{ 322 File: protoimpl.DescBuilder{ 323 GoPackagePath: reflect.TypeOf(x{}).PkgPath(), 324 RawDescriptor: file_google_firestore_admin_v1beta2_field_proto_rawDesc, 325 NumEnums: 0, 326 NumMessages: 2, 327 NumExtensions: 0, 328 NumServices: 0, 329 }, 330 GoTypes: file_google_firestore_admin_v1beta2_field_proto_goTypes, 331 DependencyIndexes: file_google_firestore_admin_v1beta2_field_proto_depIdxs, 332 MessageInfos: file_google_firestore_admin_v1beta2_field_proto_msgTypes, 333 }.Build() 334 File_google_firestore_admin_v1beta2_field_proto = out.File 335 file_google_firestore_admin_v1beta2_field_proto_rawDesc = nil 336 file_google_firestore_admin_v1beta2_field_proto_goTypes = nil 337 file_google_firestore_admin_v1beta2_field_proto_depIdxs = nil 338} 339