1 // Copyright 2022 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 // Code generated by aliasgen. DO NOT EDIT. 16 17 // Package admin aliases all exported identifiers in package 18 // "cloud.google.com/go/firestore/apiv1/admin/adminpb". 19 // 20 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb. 21 // Please read https://github.com/googleapis/google-cloud-go/blob/main/migration.md 22 // for more details. 23 package admin 24 25 import ( 26 src "cloud.google.com/go/firestore/apiv1/admin/adminpb" 27 grpc "google.golang.org/grpc" 28 ) 29 30 // Deprecated: Please use consts in: cloud.google.com/go/firestore/apiv1/admin/adminpb 31 const ( 32 Database_APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED = src.Database_APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED 33 Database_CONCURRENCY_MODE_UNSPECIFIED = src.Database_CONCURRENCY_MODE_UNSPECIFIED 34 Database_DATABASE_TYPE_UNSPECIFIED = src.Database_DATABASE_TYPE_UNSPECIFIED 35 Database_DATASTORE_MODE = src.Database_DATASTORE_MODE 36 Database_DISABLED = src.Database_DISABLED 37 Database_ENABLED = src.Database_ENABLED 38 Database_FIRESTORE_NATIVE = src.Database_FIRESTORE_NATIVE 39 Database_OPTIMISTIC = src.Database_OPTIMISTIC 40 Database_OPTIMISTIC_WITH_ENTITY_GROUPS = src.Database_OPTIMISTIC_WITH_ENTITY_GROUPS 41 Database_PESSIMISTIC = src.Database_PESSIMISTIC 42 FieldOperationMetadata_IndexConfigDelta_ADD = src.FieldOperationMetadata_IndexConfigDelta_ADD 43 FieldOperationMetadata_IndexConfigDelta_CHANGE_TYPE_UNSPECIFIED = src.FieldOperationMetadata_IndexConfigDelta_CHANGE_TYPE_UNSPECIFIED 44 FieldOperationMetadata_IndexConfigDelta_REMOVE = src.FieldOperationMetadata_IndexConfigDelta_REMOVE 45 FieldOperationMetadata_TtlConfigDelta_ADD = src.FieldOperationMetadata_TtlConfigDelta_ADD 46 FieldOperationMetadata_TtlConfigDelta_CHANGE_TYPE_UNSPECIFIED = src.FieldOperationMetadata_TtlConfigDelta_CHANGE_TYPE_UNSPECIFIED 47 FieldOperationMetadata_TtlConfigDelta_REMOVE = src.FieldOperationMetadata_TtlConfigDelta_REMOVE 48 Field_TtlConfig_ACTIVE = src.Field_TtlConfig_ACTIVE 49 Field_TtlConfig_CREATING = src.Field_TtlConfig_CREATING 50 Field_TtlConfig_NEEDS_REPAIR = src.Field_TtlConfig_NEEDS_REPAIR 51 Field_TtlConfig_STATE_UNSPECIFIED = src.Field_TtlConfig_STATE_UNSPECIFIED 52 Index_COLLECTION = src.Index_COLLECTION 53 Index_COLLECTION_GROUP = src.Index_COLLECTION_GROUP 54 Index_CREATING = src.Index_CREATING 55 Index_IndexField_ARRAY_CONFIG_UNSPECIFIED = src.Index_IndexField_ARRAY_CONFIG_UNSPECIFIED 56 Index_IndexField_ASCENDING = src.Index_IndexField_ASCENDING 57 Index_IndexField_CONTAINS = src.Index_IndexField_CONTAINS 58 Index_IndexField_DESCENDING = src.Index_IndexField_DESCENDING 59 Index_IndexField_ORDER_UNSPECIFIED = src.Index_IndexField_ORDER_UNSPECIFIED 60 Index_NEEDS_REPAIR = src.Index_NEEDS_REPAIR 61 Index_QUERY_SCOPE_UNSPECIFIED = src.Index_QUERY_SCOPE_UNSPECIFIED 62 Index_READY = src.Index_READY 63 Index_STATE_UNSPECIFIED = src.Index_STATE_UNSPECIFIED 64 OperationState_CANCELLED = src.OperationState_CANCELLED 65 OperationState_CANCELLING = src.OperationState_CANCELLING 66 OperationState_FAILED = src.OperationState_FAILED 67 OperationState_FINALIZING = src.OperationState_FINALIZING 68 OperationState_INITIALIZING = src.OperationState_INITIALIZING 69 OperationState_OPERATION_STATE_UNSPECIFIED = src.OperationState_OPERATION_STATE_UNSPECIFIED 70 OperationState_PROCESSING = src.OperationState_PROCESSING 71 OperationState_SUCCESSFUL = src.OperationState_SUCCESSFUL 72 ) 73 74 // Deprecated: Please use vars in: cloud.google.com/go/firestore/apiv1/admin/adminpb 75 var ( 76 Database_AppEngineIntegrationMode_name = src.Database_AppEngineIntegrationMode_name 77 Database_AppEngineIntegrationMode_value = src.Database_AppEngineIntegrationMode_value 78 Database_ConcurrencyMode_name = src.Database_ConcurrencyMode_name 79 Database_ConcurrencyMode_value = src.Database_ConcurrencyMode_value 80 Database_DatabaseType_name = src.Database_DatabaseType_name 81 Database_DatabaseType_value = src.Database_DatabaseType_value 82 FieldOperationMetadata_IndexConfigDelta_ChangeType_name = src.FieldOperationMetadata_IndexConfigDelta_ChangeType_name 83 FieldOperationMetadata_IndexConfigDelta_ChangeType_value = src.FieldOperationMetadata_IndexConfigDelta_ChangeType_value 84 FieldOperationMetadata_TtlConfigDelta_ChangeType_name = src.FieldOperationMetadata_TtlConfigDelta_ChangeType_name 85 FieldOperationMetadata_TtlConfigDelta_ChangeType_value = src.FieldOperationMetadata_TtlConfigDelta_ChangeType_value 86 Field_TtlConfig_State_name = src.Field_TtlConfig_State_name 87 Field_TtlConfig_State_value = src.Field_TtlConfig_State_value 88 File_google_firestore_admin_v1_database_proto = src.File_google_firestore_admin_v1_database_proto 89 File_google_firestore_admin_v1_field_proto = src.File_google_firestore_admin_v1_field_proto 90 File_google_firestore_admin_v1_firestore_admin_proto = src.File_google_firestore_admin_v1_firestore_admin_proto 91 File_google_firestore_admin_v1_index_proto = src.File_google_firestore_admin_v1_index_proto 92 File_google_firestore_admin_v1_location_proto = src.File_google_firestore_admin_v1_location_proto 93 File_google_firestore_admin_v1_operation_proto = src.File_google_firestore_admin_v1_operation_proto 94 Index_IndexField_ArrayConfig_name = src.Index_IndexField_ArrayConfig_name 95 Index_IndexField_ArrayConfig_value = src.Index_IndexField_ArrayConfig_value 96 Index_IndexField_Order_name = src.Index_IndexField_Order_name 97 Index_IndexField_Order_value = src.Index_IndexField_Order_value 98 Index_QueryScope_name = src.Index_QueryScope_name 99 Index_QueryScope_value = src.Index_QueryScope_value 100 Index_State_name = src.Index_State_name 101 Index_State_value = src.Index_State_value 102 OperationState_name = src.OperationState_name 103 OperationState_value = src.OperationState_value 104 ) 105 106 // The request for 107 // [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex]. 108 // 109 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 110 type CreateIndexRequest = src.CreateIndexRequest 111 112 // A Cloud Firestore Database. Currently only one database is allowed per 113 // cloud project; this database must have a `database_id` of '(default)'. 114 // 115 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 116 type Database = src.Database 117 118 // The type of App Engine integration mode. 119 // 120 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 121 type Database_AppEngineIntegrationMode = src.Database_AppEngineIntegrationMode 122 123 // The type of concurrency control mode for transactions. 124 // 125 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 126 type Database_ConcurrencyMode = src.Database_ConcurrencyMode 127 128 // The type of the database. See 129 // https://cloud.google.com/datastore/docs/firestore-or-datastore for 130 // information about how to choose. Mode changes are only allowed if the 131 // database is empty. 132 // 133 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 134 type Database_DatabaseType = src.Database_DatabaseType 135 136 // The request for 137 // [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex]. 138 // 139 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 140 type DeleteIndexRequest = src.DeleteIndexRequest 141 142 // Metadata for [google.longrunning.Operation][google.longrunning.Operation] 143 // results from 144 // [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments]. 145 // 146 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 147 type ExportDocumentsMetadata = src.ExportDocumentsMetadata 148 149 // The request for 150 // [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments]. 151 // 152 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 153 type ExportDocumentsRequest = src.ExportDocumentsRequest 154 155 // Returned in the 156 // [google.longrunning.Operation][google.longrunning.Operation] response field. 157 // 158 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 159 type ExportDocumentsResponse = src.ExportDocumentsResponse 160 161 // Represents a single field in the database. Fields are grouped by their 162 // "Collection Group", which represent all collections in the database with the 163 // same id. 164 // 165 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 166 type Field = src.Field 167 168 // Metadata for [google.longrunning.Operation][google.longrunning.Operation] 169 // results from 170 // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]. 171 // 172 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 173 type FieldOperationMetadata = src.FieldOperationMetadata 174 175 // Information about an index configuration change. 176 // 177 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 178 type FieldOperationMetadata_IndexConfigDelta = src.FieldOperationMetadata_IndexConfigDelta 179 180 // Specifies how the index is changing. 181 // 182 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 183 type FieldOperationMetadata_IndexConfigDelta_ChangeType = src.FieldOperationMetadata_IndexConfigDelta_ChangeType 184 185 // Information about an TTL configuration change. 186 // 187 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 188 type FieldOperationMetadata_TtlConfigDelta = src.FieldOperationMetadata_TtlConfigDelta 189 190 // Specifies how the TTL config is changing. 191 // 192 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 193 type FieldOperationMetadata_TtlConfigDelta_ChangeType = src.FieldOperationMetadata_TtlConfigDelta_ChangeType 194 195 // The index configuration for this field. 196 // 197 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 198 type Field_IndexConfig = src.Field_IndexConfig 199 200 // The TTL (time-to-live) configuration for documents that have this `Field` 201 // set. Storing a timestamp value into a TTL-enabled field will be treated as 202 // the document's absolute expiration time. Using any other data type or 203 // leaving the field absent will disable the TTL for the individual document. 204 // 205 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 206 type Field_TtlConfig = src.Field_TtlConfig 207 208 // The state of applying the TTL configuration to all documents. 209 // 210 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 211 type Field_TtlConfig_State = src.Field_TtlConfig_State 212 213 // FirestoreAdminClient is the client API for FirestoreAdmin service. For 214 // semantics around ctx use and closing/ending streaming RPCs, please refer to 215 // https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. 216 // 217 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 218 type FirestoreAdminClient = src.FirestoreAdminClient 219 220 // FirestoreAdminServer is the server API for FirestoreAdmin service. 221 // 222 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 223 type FirestoreAdminServer = src.FirestoreAdminServer 224 225 // The request for 226 // [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase]. 227 // 228 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 229 type GetDatabaseRequest = src.GetDatabaseRequest 230 231 // The request for 232 // [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField]. 233 // 234 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 235 type GetFieldRequest = src.GetFieldRequest 236 237 // The request for 238 // [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex]. 239 // 240 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 241 type GetIndexRequest = src.GetIndexRequest 242 243 // Metadata for [google.longrunning.Operation][google.longrunning.Operation] 244 // results from 245 // [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments]. 246 // 247 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 248 type ImportDocumentsMetadata = src.ImportDocumentsMetadata 249 250 // The request for 251 // [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments]. 252 // 253 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 254 type ImportDocumentsRequest = src.ImportDocumentsRequest 255 256 // Cloud Firestore indexes enable simple and complex queries against documents 257 // in a database. 258 // 259 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 260 type Index = src.Index 261 262 // Metadata for [google.longrunning.Operation][google.longrunning.Operation] 263 // results from 264 // [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex]. 265 // 266 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 267 type IndexOperationMetadata = src.IndexOperationMetadata 268 269 // A field in an index. The field_path describes which field is indexed, the 270 // value_mode describes how the field value is indexed. 271 // 272 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 273 type Index_IndexField = src.Index_IndexField 274 275 // The supported array value configurations. 276 // 277 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 278 type Index_IndexField_ArrayConfig = src.Index_IndexField_ArrayConfig 279 type Index_IndexField_ArrayConfig_ = src.Index_IndexField_ArrayConfig_ 280 281 // The supported orderings. 282 // 283 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 284 type Index_IndexField_Order = src.Index_IndexField_Order 285 type Index_IndexField_Order_ = src.Index_IndexField_Order_ 286 287 // Query Scope defines the scope at which a query is run. This is specified on 288 // a StructuredQuery's `from` field. 289 // 290 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 291 type Index_QueryScope = src.Index_QueryScope 292 293 // The state of an index. During index creation, an index will be in the 294 // `CREATING` state. If the index is created successfully, it will transition 295 // to the `READY` state. If the index creation encounters a problem, the index 296 // will transition to the `NEEDS_REPAIR` state. 297 // 298 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 299 type Index_State = src.Index_State 300 301 // A request to list the Firestore Databases in all locations for a project. 302 // 303 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 304 type ListDatabasesRequest = src.ListDatabasesRequest 305 306 // The list of databases for a project. 307 // 308 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 309 type ListDatabasesResponse = src.ListDatabasesResponse 310 311 // The request for 312 // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. 313 // 314 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 315 type ListFieldsRequest = src.ListFieldsRequest 316 317 // The response for 318 // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. 319 // 320 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 321 type ListFieldsResponse = src.ListFieldsResponse 322 323 // The request for 324 // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. 325 // 326 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 327 type ListIndexesRequest = src.ListIndexesRequest 328 329 // The response for 330 // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. 331 // 332 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 333 type ListIndexesResponse = src.ListIndexesResponse 334 335 // The metadata message for 336 // [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata]. 337 // 338 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 339 type LocationMetadata = src.LocationMetadata 340 341 // Describes the state of the operation. 342 // 343 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 344 type OperationState = src.OperationState 345 346 // Describes the progress of the operation. Unit of work is generic and must 347 // be interpreted based on where [Progress][google.firestore.admin.v1.Progress] 348 // is used. 349 // 350 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 351 type Progress = src.Progress 352 353 // UnimplementedFirestoreAdminServer can be embedded to have forward 354 // compatible implementations. 355 // 356 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 357 type UnimplementedFirestoreAdminServer = src.UnimplementedFirestoreAdminServer 358 359 // Metadata related to the update database operation. 360 // 361 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 362 type UpdateDatabaseMetadata = src.UpdateDatabaseMetadata 363 364 // The request for 365 // [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase]. 366 // 367 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 368 type UpdateDatabaseRequest = src.UpdateDatabaseRequest 369 370 // The request for 371 // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]. 372 // 373 // Deprecated: Please use types in: cloud.google.com/go/firestore/apiv1/admin/adminpb 374 type UpdateFieldRequest = src.UpdateFieldRequest 375 376 // Deprecated: Please use funcs in: cloud.google.com/go/firestore/apiv1/admin/adminpb 377 func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient { 378 return src.NewFirestoreAdminClient(cc) 379 } 380 381 // Deprecated: Please use funcs in: cloud.google.com/go/firestore/apiv1/admin/adminpb 382 func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer) { 383 src.RegisterFirestoreAdminServer(s, srv) 384 } 385