@google-cloud/firestore-api 0.1.0

package/build/protos/google/firestore/admin/v1/operation.proto

@@ -0,0 +1,330 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.admin.v1;
+
+import "google/api/resource.proto";
+import "google/firestore/admin/v1/index.proto";
+import "google/firestore/admin/v1/snapshot.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.Firestore.Admin.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "OperationProto";
+option java_package = "com.google.firestore.admin.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Firestore::Admin::V1";
+
+// Metadata for [google.longrunning.Operation][google.longrunning.Operation]
+// results from
+// [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
+message IndexOperationMetadata {
+  // The time this operation started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time this operation completed. Will be unset if operation still in
+  // progress.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The index resource that this operation is acting on. For example:
+  // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+  string index = 3;
+
+  // The state of the operation.
+  OperationState state = 4;
+
+  // The progress, in documents, of this operation.
+  Progress progress_documents = 5;
+
+  // The progress, in bytes, of this operation.
+  Progress progress_bytes = 6;
+}
+
+// Metadata for [google.longrunning.Operation][google.longrunning.Operation]
+// results from
+// [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
+message FieldOperationMetadata {
+  // Information about an index configuration change.
+  message IndexConfigDelta {
+    // Specifies how the index is changing.
+    enum ChangeType {
+      // The type of change is not specified or known.
+      CHANGE_TYPE_UNSPECIFIED = 0;
+
+      // The single field index is being added.
+      ADD = 1;
+
+      // The single field index is being removed.
+      REMOVE = 2;
+    }
+
+    // Specifies how the index is changing.
+    ChangeType change_type = 1;
+
+    // The index being changed.
+    Index index = 2;
+  }
+
+  // Information about a TTL configuration change.
+  message TtlConfigDelta {
+    // Specifies how the TTL config is changing.
+    enum ChangeType {
+      // The type of change is not specified or known.
+      CHANGE_TYPE_UNSPECIFIED = 0;
+
+      // The TTL config is being added.
+      ADD = 1;
+
+      // The TTL config is being removed.
+      REMOVE = 2;
+    }
+
+    // Specifies how the TTL configuration is changing.
+    ChangeType change_type = 1;
+
+    // The offset, relative to the timestamp value in the TTL-enabled field,
+    // used determine the document's expiration time.
+    google.protobuf.Duration expiration_offset = 3;
+  }
+
+  // The time this operation started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time this operation completed. Will be unset if operation still in
+  // progress.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The field resource that this operation is acting on. For example:
+  // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
+  string field = 3;
+
+  // A list of
+  // [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta],
+  // which describe the intent of this operation.
+  repeated IndexConfigDelta index_config_deltas = 4;
+
+  // The state of the operation.
+  OperationState state = 5;
+
+  // The progress, in documents, of this operation.
+  Progress progress_documents = 6;
+
+  // The progress, in bytes, of this operation.
+  Progress progress_bytes = 7;
+
+  // Describes the deltas of TTL configuration.
+  TtlConfigDelta ttl_config_delta = 8;
+}
+
+// Metadata for [google.longrunning.Operation][google.longrunning.Operation]
+// results from
+// [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
+message ExportDocumentsMetadata {
+  // The time this operation started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time this operation completed. Will be unset if operation still in
+  // progress.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The state of the export operation.
+  OperationState operation_state = 3;
+
+  // The progress, in documents, of this operation.
+  Progress progress_documents = 4;
+
+  // The progress, in bytes, of this operation.
+  Progress progress_bytes = 5;
+
+  // Which collection IDs are being exported.
+  repeated string collection_ids = 6;
+
+  // Where the documents are being exported to.
+  string output_uri_prefix = 7;
+
+  // Which namespace IDs are being exported.
+  repeated string namespace_ids = 8;
+
+  // The timestamp that corresponds to the version of the database that is being
+  // exported. If unspecified, there are no guarantees about the consistency of
+  // the documents being exported.
+  google.protobuf.Timestamp snapshot_time = 9;
+}
+
+// Metadata for [google.longrunning.Operation][google.longrunning.Operation]
+// results from
+// [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
+message ImportDocumentsMetadata {
+  // The time this operation started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time this operation completed. Will be unset if operation still in
+  // progress.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The state of the import operation.
+  OperationState operation_state = 3;
+
+  // The progress, in documents, of this operation.
+  Progress progress_documents = 4;
+
+  // The progress, in bytes, of this operation.
+  Progress progress_bytes = 5;
+
+  // Which collection IDs are being imported.
+  repeated string collection_ids = 6;
+
+  // The location of the documents being imported.
+  string input_uri_prefix = 7;
+
+  // Which namespace IDs are being imported.
+  repeated string namespace_ids = 8;
+}
+
+// Metadata for [google.longrunning.Operation][google.longrunning.Operation]
+// results from
+// [FirestoreAdmin.BulkDeleteDocuments][google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments].
+message BulkDeleteDocumentsMetadata {
+  // The time this operation started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time this operation completed. Will be unset if operation still in
+  // progress.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The state of the operation.
+  OperationState operation_state = 3;
+
+  // The progress, in documents, of this operation.
+  Progress progress_documents = 4;
+
+  // The progress, in bytes, of this operation.
+  Progress progress_bytes = 5;
+
+  // The IDs of the collection groups that are being deleted.
+  repeated string collection_ids = 6;
+
+  // Which namespace IDs are being deleted.
+  repeated string namespace_ids = 7;
+
+  // The timestamp that corresponds to the version of the database that is being
+  // read to get the list of documents to delete. This time can also be used as
+  // the timestamp of PITR in case of disaster recovery (subject to PITR window
+  // limit).
+  google.protobuf.Timestamp snapshot_time = 8;
+}
+
+// Returned in the [google.longrunning.Operation][google.longrunning.Operation]
+// response field.
+message ExportDocumentsResponse {
+  // Location of the output files. This can be used to begin an import
+  // into Cloud Firestore (this project or another project) after the operation
+  // completes successfully.
+  string output_uri_prefix = 1;
+}
+
+// Metadata for the [long-running operation][google.longrunning.Operation] from
+// the [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] request.
+message RestoreDatabaseMetadata {
+  // The time the restore was started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time the restore finished, unset for ongoing restores.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The operation state of the restore.
+  OperationState operation_state = 3;
+
+  // The name of the database being restored to.
+  string database = 4 [(google.api.resource_reference) = {
+    type: "firestore.googleapis.com/Database"
+  }];
+
+  // The name of the backup restoring from.
+  string backup = 5 [(google.api.resource_reference) = {
+    type: "firestore.googleapis.com/Backup"
+  }];
+
+  // How far along the restore is as an estimated percentage of remaining time.
+  Progress progress_percentage = 8;
+}
+
+// Metadata for the [long-running operation][google.longrunning.Operation] from
+// the [CloneDatabase][google.firestore.admin.v1.CloneDatabase] request.
+message CloneDatabaseMetadata {
+  // The time the clone was started.
+  google.protobuf.Timestamp start_time = 1;
+
+  // The time the clone finished, unset for ongoing clones.
+  google.protobuf.Timestamp end_time = 2;
+
+  // The operation state of the clone.
+  OperationState operation_state = 3;
+
+  // The name of the database being cloned to.
+  string database = 4 [(google.api.resource_reference) = {
+    type: "firestore.googleapis.com/Database"
+  }];
+
+  // The snapshot from which this database was cloned.
+  PitrSnapshot pitr_snapshot = 7;
+
+  // How far along the clone is as an estimated percentage of remaining time.
+  Progress progress_percentage = 6;
+}
+
+// Describes the progress of the operation.
+// Unit of work is generic and must be interpreted based on where
+// [Progress][google.firestore.admin.v1.Progress] is used.
+message Progress {
+  // The amount of work estimated.
+  int64 estimated_work = 1;
+
+  // The amount of work completed.
+  int64 completed_work = 2;
+}
+
+// Describes the state of the operation.
+enum OperationState {
+  // Unspecified.
+  OPERATION_STATE_UNSPECIFIED = 0;
+
+  // Request is being prepared for processing.
+  INITIALIZING = 1;
+
+  // Request is actively being processed.
+  PROCESSING = 2;
+
+  // Request is in the process of being cancelled after user called
+  // google.longrunning.Operations.CancelOperation on the operation.
+  CANCELLING = 3;
+
+  // Request has been processed and is in its finalization stage.
+  FINALIZING = 4;
+
+  // Request has completed successfully.
+  SUCCESSFUL = 5;
+
+  // Request has finished being processed, but encountered an error.
+  FAILED = 6;
+
+  // Request has finished being cancelled after user called
+  // google.longrunning.Operations.CancelOperation.
+  CANCELLED = 7;
+}

package/build/protos/google/firestore/admin/v1/realtime_updates.proto

@@ -0,0 +1,40 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.admin.v1;
+
+option csharp_namespace = "Google.Cloud.Firestore.Admin.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "RealtimeUpdatesProto";
+option java_package = "com.google.firestore.admin.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Firestore::Admin::V1";
+
+// The Realtime Updates mode.
+enum RealtimeUpdatesMode {
+  // The Realtime Updates feature is not specified.
+  REALTIME_UPDATES_MODE_UNSPECIFIED = 0;
+
+  // The Realtime Updates feature is enabled by default.
+  //
+  // This could potentially degrade write performance for the database.
+  REALTIME_UPDATES_MODE_ENABLED = 1;
+
+  // The Realtime Updates feature is disabled by default.
+  REALTIME_UPDATES_MODE_DISABLED = 2;
+}

package/build/protos/google/firestore/admin/v1/schedule.proto

@@ -0,0 +1,95 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.admin.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/type/dayofweek.proto";
+
+option csharp_namespace = "Google.Cloud.Firestore.Admin.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "ScheduleProto";
+option java_package = "com.google.firestore.admin.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Firestore::Admin::V1";
+
+// A backup schedule for a Cloud Firestore Database.
+//
+// This resource is owned by the database it is backing up, and is deleted along
+// with the database. The actual backups are not though.
+message BackupSchedule {
+  option (google.api.resource) = {
+    type: "firestore.googleapis.com/BackupSchedule"
+    pattern: "projects/{project}/databases/{database}/backupSchedules/{backup_schedule}"
+  };
+
+  // Output only. The unique backup schedule identifier across all locations and
+  // databases for the given project.
+  //
+  // This will be auto-assigned.
+  //
+  // Format is
+  // `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The timestamp at which this backup schedule was created and
+  // effective since.
+  //
+  // No backups will be created for this schedule before this time.
+  google.protobuf.Timestamp create_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The timestamp at which this backup schedule was most recently
+  // updated. When a backup schedule is first created, this is the same as
+  // create_time.
+  google.protobuf.Timestamp update_time = 10
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // At what relative time in the future, compared to its creation time,
+  // the backup should be deleted, e.g. keep backups for 7 days.
+  //
+  // The maximum supported retention period is 14 weeks.
+  google.protobuf.Duration retention = 6;
+
+  // A oneof field to represent when backups will be taken.
+  oneof recurrence {
+    // For a schedule that runs daily.
+    DailyRecurrence daily_recurrence = 7;
+
+    // For a schedule that runs weekly on a specific day.
+    WeeklyRecurrence weekly_recurrence = 8;
+  }
+}
+
+// Represents a recurring schedule that runs every day.
+//
+// The time zone is UTC.
+message DailyRecurrence {}
+
+// Represents a recurring schedule that runs on a specified day of the week.
+//
+// The time zone is UTC.
+message WeeklyRecurrence {
+  // The day of week to run.
+  //
+  // DAY_OF_WEEK_UNSPECIFIED is not allowed.
+  google.type.DayOfWeek day = 2;
+}

package/build/protos/google/firestore/admin/v1/snapshot.proto

@@ -0,0 +1,53 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.admin.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.Firestore.Admin.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "PitrSnapshotProto";
+option java_package = "com.google.firestore.admin.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Firestore::Admin::V1";
+
+// A consistent snapshot of a database at a specific point in time.
+// A PITR (Point-in-time recovery) snapshot with previous versions of a
+// database's data is available for every minute up to the associated database's
+// data retention period. If the PITR feature is enabled, the retention period
+// is 7 days; otherwise, it is one hour.
+message PitrSnapshot {
+  // Required. The name of the database that this was a snapshot of. Format:
+  // `projects/{project}/databases/{database}`.
+  string database = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "firestore.googleapis.com/Database"
+    }
+  ];
+
+  // Output only. Public UUID of the database the snapshot was associated with.
+  bytes database_uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Snapshot time of the database.
+  google.protobuf.Timestamp snapshot_time = 3
+      [(google.api.field_behavior) = REQUIRED];
+}

package/build/protos/google/firestore/admin/v1/user_creds.proto

@@ -0,0 +1,86 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.admin.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.Firestore.Admin.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "UserCredsProto";
+option java_package = "com.google.firestore.admin.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Firestore::Admin::V1";
+
+// A Cloud Firestore User Creds.
+message UserCreds {
+  option (google.api.resource) = {
+    type: "firestore.googleapis.com/UserCreds"
+    pattern: "projects/{project}/databases/{database}/userCreds/{user_creds}"
+    plural: "userCreds"
+    singular: "userCreds"
+  };
+
+  // The state of the user creds (ENABLED or DISABLED).
+  enum State {
+    // The default value. Should not be used.
+    STATE_UNSPECIFIED = 0;
+
+    // The user creds are enabled.
+    ENABLED = 1;
+
+    // The user creds are disabled.
+    DISABLED = 2;
+  }
+
+  // Describes a Resource Identity principal.
+  message ResourceIdentity {
+    // Output only. Principal identifier string.
+    // See: https://cloud.google.com/iam/docs/principal-identifiers
+    string principal = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Identifier. The resource name of the UserCreds.
+  // Format:
+  // `projects/{project}/databases/{database}/userCreds/{user_creds}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The time the user creds were created.
+  google.protobuf.Timestamp create_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time the user creds were last updated.
+  google.protobuf.Timestamp update_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Whether the user creds are enabled or disabled. Defaults to
+  // ENABLED on creation.
+  State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The plaintext server-generated password for the user creds.
+  // Only populated in responses for CreateUserCreds and ResetUserPassword.
+  string secure_password = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Identity associated with this User Creds.
+  oneof UserCredsIdentity {
+    // Resource Identity descriptor.
+    ResourceIdentity resource_identity = 6;
+  }
+}

package/build/protos/google/firestore/v1/aggregation_result.proto

@@ -0,0 +1,43 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.firestore.v1;
+
+import "google/firestore/v1/document.proto";
+
+option csharp_namespace = "Google.Cloud.Firestore.V1";
+option go_package = "cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb";
+option java_multiple_files = true;
+option java_outer_classname = "AggregationResultProto";
+option java_package = "com.google.firestore.v1";
+option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\V1";
+option ruby_package = "Google::Cloud::Firestore::V1";
+
+// The result of a single bucket from a Firestore aggregation query.
+//
+// The keys of `aggregate_fields` are the same for all results in an aggregation
+// query, unlike document queries which can have different fields present for
+// each result.
+message AggregationResult {
+  // The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
+  //
+  // The key is the
+  // [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+  // assigned to the aggregation function on input and the size of this map
+  // equals the number of aggregation functions in the query.
+  map<string, Value> aggregate_fields = 2;
+}