diff --git a/google/firestore/admin/v1/field.proto b/google/firestore/admin/v1/field.proto index 1ba98294..9c768fd9 100644 --- a/google/firestore/admin/v1/field.proto +++ b/google/firestore/admin/v1/field.proto @@ -28,7 +28,6 @@ option java_package = "com.google.firestore.admin.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; - // Represents a single field in the database. // // Fields are grouped by their "Collection Group", which represent all diff --git a/google/firestore/admin/v1/firestore_admin.proto b/google/firestore/admin/v1/firestore_admin.proto index e05c34c0..19bc4970 100644 --- a/google/firestore/admin/v1/firestore_admin.proto +++ b/google/firestore/admin/v1/firestore_admin.proto @@ -32,13 +32,14 @@ option java_package = "com.google.firestore.admin.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; - // Operations are created by service `FirestoreAdmin`, but are accessed via // service `google.longrunning.Operations`. service FirestoreAdmin { - // Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] - // which may be used to track the status of the creation. The metadata for - // the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata]. + // Creates a composite index. This returns a + // [google.longrunning.Operation][google.longrunning.Operation] which may be + // used to track the status of the creation. The metadata for the operation + // will be the type + // [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata]. rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes" @@ -76,13 +77,16 @@ service FirestoreAdmin { // Updates a field configuration. Currently, field updates apply only to // single field index configuration. However, calls to - // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid - // changing any configuration that the caller isn't aware of. The field mask - // should be specified as: `{ paths: "index_config" }`. + // [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] + // should provide a field mask to avoid changing any configuration that the + // caller isn't aware of. The field mask should be specified as: `{ paths: + // "index_config" }`. // - // This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to - // track the status of the field update. The metadata for - // the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata]. + // This call returns a + // [google.longrunning.Operation][google.longrunning.Operation] which may be + // used to track the status of the field update. The metadata for the + // operation will be the type + // [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata]. // // To configure the default field settings for the database, use // the special `Field` with resource name: @@ -96,10 +100,12 @@ service FirestoreAdmin { // Lists the field configuration and metadata for this database. // - // Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields - // that have been explicitly overridden. To issue this query, call - // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to - // `indexConfig.usesAncestorConfig:false`. + // Currently, + // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] + // only supports listing fields that have been explicitly overridden. To issue + // this query, call + // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] + // with the filter set to `indexConfig.usesAncestorConfig:false`. rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields" @@ -114,7 +120,8 @@ service FirestoreAdmin { // used once the associated operation is done. If an export operation is // cancelled before completion it may leave partial data behind in Google // Cloud Storage. - rpc ExportDocuments(ExportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ExportDocuments(ExportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/databases/*}:exportDocuments" body: "*" @@ -126,7 +133,8 @@ service FirestoreAdmin { // progress can be monitored and managed via the Operation resource that is // created. If an ImportDocuments operation is cancelled, it is possible // that a subset of the data has already been imported to Cloud Firestore. - rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ImportDocuments(ImportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/databases/*}:importDocuments" body: "*" @@ -134,7 +142,8 @@ service FirestoreAdmin { } } -// The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex]. +// The request for +// [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex]. message CreateIndexRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` @@ -144,7 +153,8 @@ message CreateIndexRequest { Index index = 2; } -// The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. +// The request for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. message ListIndexesRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` @@ -157,12 +167,13 @@ message ListIndexesRequest { int32 page_size = 3; // A page token, returned from a previous call to - // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes], that may be used to get the next - // page of results. + // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes], + // that may be used to get the next page of results. string page_token = 4; } -// The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. +// The response for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]. message ListIndexesResponse { // The requested indexes. repeated Index indexes = 1; @@ -172,21 +183,24 @@ message ListIndexesResponse { string next_page_token = 2; } -// The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex]. +// The request for +// [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex]. message GetIndexRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` string name = 1; } -// The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex]. +// The request for +// [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex]. message DeleteIndexRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` string name = 1; } -// The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]. +// The request for +// [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]. message UpdateFieldRequest { // The field to be updated. Field field = 1; @@ -196,36 +210,40 @@ message UpdateFieldRequest { google.protobuf.FieldMask update_mask = 2; } -// The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField]. +// The request for +// [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField]. message GetFieldRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` string name = 1; } -// The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. +// The request for +// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. message ListFieldsRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` string parent = 1; // The filter to apply to list results. Currently, - // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields - // that have been explicitly overridden. To issue this query, call - // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to - // `indexConfig.usesAncestorConfig:false`. + // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] + // only supports listing fields that have been explicitly overridden. To issue + // this query, call + // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] + // with the filter set to `indexConfig.usesAncestorConfig:false`. string filter = 2; // The number of results to return. int32 page_size = 3; // A page token, returned from a previous call to - // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next - // page of results. + // [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], + // that may be used to get the next page of results. string page_token = 4; } -// The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. +// The response for +// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]. message ListFieldsResponse { // The requested fields. repeated Field fields = 1; @@ -235,7 +253,8 @@ message ListFieldsResponse { string next_page_token = 2; } -// The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments]. +// The request for +// [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments]. message ExportDocumentsRequest { // Database to export. Should be of the form: // `projects/{project_id}/databases/{database_id}`. @@ -255,7 +274,8 @@ message ExportDocumentsRequest { string output_uri_prefix = 3; } -// The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments]. +// The request for +// [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments]. message ImportDocumentsRequest { // Database to import into. Should be of the form: // `projects/{project_id}/databases/{database_id}`. diff --git a/google/firestore/admin/v1/index.proto b/google/firestore/admin/v1/index.proto index 75bdcaeb..60087a54 100644 --- a/google/firestore/admin/v1/index.proto +++ b/google/firestore/admin/v1/index.proto @@ -27,7 +27,6 @@ option java_package = "com.google.firestore.admin.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; - // Cloud Firestore indexes enable simple and complex queries against // documents in a database. message Index { diff --git a/google/firestore/admin/v1/location.proto b/google/firestore/admin/v1/location.proto index e8ec222d..3594a0cd 100644 --- a/google/firestore/admin/v1/location.proto +++ b/google/firestore/admin/v1/location.proto @@ -28,8 +28,6 @@ option java_package = "com.google.firestore.admin.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; - -// The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata]. -message LocationMetadata { - -} +// The metadata message for +// [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata]. +message LocationMetadata {} diff --git a/google/firestore/admin/v1/operation.proto b/google/firestore/admin/v1/operation.proto index a6fee6e5..50706e3b 100644 --- a/google/firestore/admin/v1/operation.proto +++ b/google/firestore/admin/v1/operation.proto @@ -29,8 +29,8 @@ option java_package = "com.google.firestore.admin.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\Admin\\V1"; - -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// 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. @@ -54,7 +54,8 @@ message IndexOperationMetadata { Progress progress_bytes = 6; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// 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. @@ -89,8 +90,9 @@ message FieldOperationMetadata { // `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. + // 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. @@ -103,7 +105,8 @@ message FieldOperationMetadata { Progress progress_bytes = 7; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// 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. @@ -129,7 +132,8 @@ message ExportDocumentsMetadata { string output_uri_prefix = 7; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// 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. @@ -155,7 +159,8 @@ message ImportDocumentsMetadata { string input_uri_prefix = 7; } -// Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field. +// 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 @@ -164,8 +169,8 @@ message ExportDocumentsResponse { } // 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. +// 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; diff --git a/google/firestore/admin/v1beta1/firestore_admin.proto b/google/firestore/admin/v1beta1/firestore_admin.proto index 15ce94da..5e1cae15 100644 --- a/google/firestore/admin/v1beta1/firestore_admin.proto +++ b/google/firestore/admin/v1beta1/firestore_admin.proto @@ -30,7 +30,6 @@ option java_outer_classname = "FirestoreAdminProto"; option java_package = "com.google.firestore.admin.v1beta1"; option objc_class_prefix = "GCFS"; - // The Cloud Firestore Admin API. // // This API provides several administrative services for Cloud Firestore. @@ -77,14 +76,15 @@ option objc_class_prefix = "GCFS"; service FirestoreAdmin { // Creates the specified index. // A newly created index's initial state is `CREATING`. On completion of the - // returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`. - // If the index already exists, the call will return an `ALREADY_EXISTS` - // status. + // returned [google.longrunning.Operation][google.longrunning.Operation], the + // state will be `READY`. If the index already exists, the call will return an + // `ALREADY_EXISTS` status. // // During creation, the process could result in an error, in which case the // index will move to the `ERROR` state. The process can be recovered by // fixing the data that caused the error, removing the index with - // [delete][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex], then re-creating the index with + // [delete][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex], then + // re-creating the index with // [create][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex]. // // Indexes with a single field cannot be created. @@ -124,7 +124,8 @@ service FirestoreAdmin { // used once the associated operation is done. If an export operation is // cancelled before completion it may leave partial data behind in Google // Cloud Storage. - rpc ExportDocuments(ExportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ExportDocuments(ExportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/databases/*}:exportDocuments" body: "*" @@ -136,7 +137,8 @@ service FirestoreAdmin { // progress can be monitored and managed via the Operation resource that is // created. If an ImportDocuments operation is cancelled, it is possible // that a subset of the data has already been imported to Cloud Firestore. - rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ImportDocuments(ImportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/databases/*}:importDocuments" body: "*" @@ -145,7 +147,8 @@ service FirestoreAdmin { } // Metadata for index operations. This metadata populates -// the metadata field of [google.longrunning.Operation][google.longrunning.Operation]. +// the metadata field of +// [google.longrunning.Operation][google.longrunning.Operation]. message IndexOperationMetadata { // The type of index operation. enum OperationType { @@ -172,7 +175,8 @@ message IndexOperationMetadata { // True if the [google.longrunning.Operation] was cancelled. If the // cancellation is in progress, cancelled will be true but - // [google.longrunning.Operation.done][google.longrunning.Operation.done] will be false. + // [google.longrunning.Operation.done][google.longrunning.Operation.done] will + // be false. bool cancelled = 5; // Progress of the existing operation, measured in number of documents. @@ -190,7 +194,8 @@ message Progress { int64 work_estimated = 2; } -// The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex]. +// The request for +// [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex]. message CreateIndexRequest { // The name of the database this index will apply to. For example: // `projects/{project_id}/databases/{database_id}` @@ -201,14 +206,16 @@ message CreateIndexRequest { Index index = 2; } -// The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex]. +// The request for +// [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex]. message GetIndexRequest { // The name of the index. For example: // `projects/{project_id}/databases/{database_id}/indexes/{index_id}` string name = 1; } -// The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes]. +// The request for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes]. message ListIndexesRequest { // The database name. For example: // `projects/{project_id}/databases/{database_id}` @@ -223,14 +230,16 @@ message ListIndexesRequest { string page_token = 4; } -// The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex]. +// The request for +// [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex]. message DeleteIndexRequest { // The index name. For example: // `projects/{project_id}/databases/{database_id}/indexes/{index_id}` string name = 1; } -// The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes]. +// The response for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes]. message ListIndexesResponse { // The indexes. repeated Index indexes = 1; @@ -239,7 +248,8 @@ message ListIndexesResponse { string next_page_token = 2; } -// The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments]. +// The request for +// [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments]. message ExportDocumentsRequest { // Database to export. Should be of the form: // `projects/{project_id}/databases/{database_id}`. @@ -259,7 +269,8 @@ message ExportDocumentsRequest { string output_uri_prefix = 4; } -// The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments]. +// The request for +// [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments]. message ImportDocumentsRequest { // Database to import into. Should be of the form: // `projects/{project_id}/databases/{database_id}`. @@ -277,7 +288,8 @@ message ImportDocumentsRequest { string input_uri_prefix = 4; } -// Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field. +// 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 diff --git a/google/firestore/admin/v1beta1/index.proto b/google/firestore/admin/v1beta1/index.proto index c5784e0e..4034047f 100644 --- a/google/firestore/admin/v1beta1/index.proto +++ b/google/firestore/admin/v1beta1/index.proto @@ -26,7 +26,6 @@ option java_outer_classname = "IndexProto"; option java_package = "com.google.firestore.admin.v1beta1"; option objc_class_prefix = "GCFS"; - // A field of an index. message IndexField { // The mode determines how a field is indexed. diff --git a/google/firestore/admin/v1beta1/location.proto b/google/firestore/admin/v1beta1/location.proto index db7e8544..518939b8 100644 --- a/google/firestore/admin/v1beta1/location.proto +++ b/google/firestore/admin/v1beta1/location.proto @@ -27,8 +27,6 @@ option java_outer_classname = "LocationProto"; option java_package = "com.google.firestore.admin.v1beta1"; option objc_class_prefix = "GCFS"; - -// The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata]. -message LocationMetadata { - -} +// The metadata message for +// [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata]. +message LocationMetadata {} diff --git a/google/firestore/admin/v1beta2/field.proto b/google/firestore/admin/v1beta2/field.proto index 9d1534eb..fd9409f2 100644 --- a/google/firestore/admin/v1beta2/field.proto +++ b/google/firestore/admin/v1beta2/field.proto @@ -27,7 +27,6 @@ option java_outer_classname = "FieldProto"; option java_package = "com.google.firestore.admin.v1beta2"; option objc_class_prefix = "GCFS"; - // Represents a single field in the database. // // Fields are grouped by their "Collection Group", which represent all diff --git a/google/firestore/admin/v1beta2/firestore_admin.proto b/google/firestore/admin/v1beta2/firestore_admin.proto index 28769db2..c45bd845 100644 --- a/google/firestore/admin/v1beta2/firestore_admin.proto +++ b/google/firestore/admin/v1beta2/firestore_admin.proto @@ -31,13 +31,14 @@ option java_outer_classname = "FirestoreAdminProto"; option java_package = "com.google.firestore.admin.v1beta2"; option objc_class_prefix = "GCFS"; - // Operations are created by service `FirestoreAdmin`, but are accessed via // service `google.longrunning.Operations`. service FirestoreAdmin { - // Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] - // which may be used to track the status of the creation. The metadata for - // the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1beta2.IndexOperationMetadata]. + // Creates a composite index. This returns a + // [google.longrunning.Operation][google.longrunning.Operation] which may be + // used to track the status of the creation. The metadata for the operation + // will be the type + // [IndexOperationMetadata][google.firestore.admin.v1beta2.IndexOperationMetadata]. rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes" @@ -75,13 +76,16 @@ service FirestoreAdmin { // Updates a field configuration. Currently, field updates apply only to // single field index configuration. However, calls to - // [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField] should provide a field mask to avoid - // changing any configuration that the caller isn't aware of. The field mask - // should be specified as: `{ paths: "index_config" }`. + // [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField] + // should provide a field mask to avoid changing any configuration that the + // caller isn't aware of. The field mask should be specified as: `{ paths: + // "index_config" }`. // - // This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to - // track the status of the field update. The metadata for - // the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1beta2.FieldOperationMetadata]. + // This call returns a + // [google.longrunning.Operation][google.longrunning.Operation] which may be + // used to track the status of the field update. The metadata for the + // operation will be the type + // [FieldOperationMetadata][google.firestore.admin.v1beta2.FieldOperationMetadata]. // // To configure the default field settings for the database, use // the special `Field` with resource name: @@ -95,10 +99,12 @@ service FirestoreAdmin { // Lists the field configuration and metadata for this database. // - // Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] only supports listing fields - // that have been explicitly overridden. To issue this query, call - // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] with the filter set to - // `indexConfig.usesAncestorConfig:false`. + // Currently, + // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] + // only supports listing fields that have been explicitly overridden. To issue + // this query, call + // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] + // with the filter set to `indexConfig.usesAncestorConfig:false`. rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse) { option (google.api.http) = { get: "/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields" @@ -113,7 +119,8 @@ service FirestoreAdmin { // used once the associated operation is done. If an export operation is // cancelled before completion it may leave partial data behind in Google // Cloud Storage. - rpc ExportDocuments(ExportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ExportDocuments(ExportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/{name=projects/*/databases/*}:exportDocuments" body: "*" @@ -125,7 +132,8 @@ service FirestoreAdmin { // progress can be monitored and managed via the Operation resource that is // created. If an ImportDocuments operation is cancelled, it is possible // that a subset of the data has already been imported to Cloud Firestore. - rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) { + rpc ImportDocuments(ImportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/{name=projects/*/databases/*}:importDocuments" body: "*" @@ -133,7 +141,8 @@ service FirestoreAdmin { } } -// The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex]. +// The request for +// [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex]. message CreateIndexRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` @@ -143,7 +152,8 @@ message CreateIndexRequest { Index index = 2; } -// The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes]. +// The request for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes]. message ListIndexesRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` @@ -156,12 +166,13 @@ message ListIndexesRequest { int32 page_size = 3; // A page token, returned from a previous call to - // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes], that may be used to get the next - // page of results. + // [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes], + // that may be used to get the next page of results. string page_token = 4; } -// The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes]. +// The response for +// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes]. message ListIndexesResponse { // The requested indexes. repeated Index indexes = 1; @@ -171,21 +182,24 @@ message ListIndexesResponse { string next_page_token = 2; } -// The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex]. +// The request for +// [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex]. message GetIndexRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` string name = 1; } -// The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex]. +// The request for +// [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex]. message DeleteIndexRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` string name = 1; } -// The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField]. +// The request for +// [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField]. message UpdateFieldRequest { // The field to be updated. Field field = 1; @@ -195,36 +209,40 @@ message UpdateFieldRequest { google.protobuf.FieldMask update_mask = 2; } -// The request for [FirestoreAdmin.GetField][google.firestore.admin.v1beta2.FirestoreAdmin.GetField]. +// The request for +// [FirestoreAdmin.GetField][google.firestore.admin.v1beta2.FirestoreAdmin.GetField]. message GetFieldRequest { // A name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` string name = 1; } -// The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields]. +// The request for +// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields]. message ListFieldsRequest { // A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` string parent = 1; // The filter to apply to list results. Currently, - // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] only supports listing fields - // that have been explicitly overridden. To issue this query, call - // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] with the filter set to - // `indexConfig.usesAncestorConfig:false`. + // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] + // only supports listing fields that have been explicitly overridden. To issue + // this query, call + // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] + // with the filter set to `indexConfig.usesAncestorConfig:false`. string filter = 2; // The number of results to return. int32 page_size = 3; // A page token, returned from a previous call to - // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields], that may be used to get the next - // page of results. + // [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields], + // that may be used to get the next page of results. string page_token = 4; } -// The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields]. +// The response for +// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields]. message ListFieldsResponse { // The requested fields. repeated Field fields = 1; @@ -234,7 +252,8 @@ message ListFieldsResponse { string next_page_token = 2; } -// The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments]. +// The request for +// [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments]. message ExportDocumentsRequest { // Database to export. Should be of the form: // `projects/{project_id}/databases/{database_id}`. @@ -254,7 +273,8 @@ message ExportDocumentsRequest { string output_uri_prefix = 3; } -// The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments]. +// The request for +// [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments]. message ImportDocumentsRequest { // Database to import into. Should be of the form: // `projects/{project_id}/databases/{database_id}`. diff --git a/google/firestore/admin/v1beta2/index.proto b/google/firestore/admin/v1beta2/index.proto index 2df9d779..2c25371b 100644 --- a/google/firestore/admin/v1beta2/index.proto +++ b/google/firestore/admin/v1beta2/index.proto @@ -26,7 +26,6 @@ option java_outer_classname = "IndexProto"; option java_package = "com.google.firestore.admin.v1beta2"; option objc_class_prefix = "GCFS"; - // Cloud Firestore indexes enable simple and complex queries against // documents in a database. message Index { diff --git a/google/firestore/admin/v1beta2/operation.proto b/google/firestore/admin/v1beta2/operation.proto index c2a1b001..24d73aeb 100644 --- a/google/firestore/admin/v1beta2/operation.proto +++ b/google/firestore/admin/v1beta2/operation.proto @@ -28,8 +28,8 @@ option java_outer_classname = "OperationProto"; option java_package = "com.google.firestore.admin.v1beta2"; option objc_class_prefix = "GCFS"; - -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// Metadata for [google.longrunning.Operation][google.longrunning.Operation] +// results from // [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex]. message IndexOperationMetadata { // The time this operation started. @@ -53,7 +53,8 @@ message IndexOperationMetadata { Progress progress_bytes = 6; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// Metadata for [google.longrunning.Operation][google.longrunning.Operation] +// results from // [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField]. message FieldOperationMetadata { // Information about an index configuration change. @@ -88,8 +89,9 @@ message FieldOperationMetadata { // `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` string field = 3; - // A list of [IndexConfigDelta][google.firestore.admin.v1beta2.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this - // operation. + // A list of + // [IndexConfigDelta][google.firestore.admin.v1beta2.FieldOperationMetadata.IndexConfigDelta], + // which describe the intent of this operation. repeated IndexConfigDelta index_config_deltas = 4; // The state of the operation. @@ -102,7 +104,8 @@ message FieldOperationMetadata { Progress bytes_progress = 7; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// Metadata for [google.longrunning.Operation][google.longrunning.Operation] +// results from // [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments]. message ExportDocumentsMetadata { // The time this operation started. @@ -128,7 +131,8 @@ message ExportDocumentsMetadata { string output_uri_prefix = 7; } -// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from +// Metadata for [google.longrunning.Operation][google.longrunning.Operation] +// results from // [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments]. message ImportDocumentsMetadata { // The time this operation started. @@ -154,7 +158,8 @@ message ImportDocumentsMetadata { string input_uri_prefix = 7; } -// Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field. +// 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 @@ -163,8 +168,8 @@ message ExportDocumentsResponse { } // Describes the progress of the operation. -// Unit of work is generic and must be interpreted based on where [Progress][google.firestore.admin.v1beta2.Progress] -// is used. +// Unit of work is generic and must be interpreted based on where +// [Progress][google.firestore.admin.v1beta2.Progress] is used. message Progress { // The amount of work estimated. int64 estimated_work = 1; diff --git a/google/firestore/v1/common.proto b/google/firestore/v1/common.proto index 670cb417..9a0ae7de 100644 --- a/google/firestore/v1/common.proto +++ b/google/firestore/v1/common.proto @@ -28,15 +28,16 @@ option java_package = "com.google.firestore.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1"; - // A set of field paths on a document. // Used to restrict a get or update operation on a document to a subset of its // fields. // This is different from standard field masks, as this is always scoped to a -// [Document][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value]. +// [Document][google.firestore.v1.Document], and takes in account the dynamic +// nature of [Value][google.firestore.v1.Value]. message DocumentMask { - // The list of field paths in the mask. See [Document.fields][google.firestore.v1.Document.fields] for a field - // path syntax reference. + // The list of field paths in the mask. See + // [Document.fields][google.firestore.v1.Document.fields] for a field path + // syntax reference. repeated string field_paths = 1; } diff --git a/google/firestore/v1/document.proto b/google/firestore/v1/document.proto index 26894785..20e30651 100644 --- a/google/firestore/v1/document.proto +++ b/google/firestore/v1/document.proto @@ -30,7 +30,6 @@ option java_package = "com.google.firestore.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1"; - // A Firestore document. // // Must not exceed 1 MiB - 4 bytes. diff --git a/google/firestore/v1/firestore.proto b/google/firestore/v1/firestore.proto index d425edf9..49d22a44 100644 --- a/google/firestore/v1/firestore.proto +++ b/google/firestore/v1/firestore.proto @@ -33,6 +33,7 @@ option java_outer_classname = "FirestoreProto"; option java_package = "com.google.firestore.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1"; + // Specification of the Firestore API. // The Cloud Firestore service. @@ -93,7 +94,8 @@ service Firestore { // // Documents returned by this method are not guaranteed to be returned in the // same order that they were requested. - rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (stream BatchGetDocumentsResponse) { + rpc BatchGetDocuments(BatchGetDocumentsRequest) + returns (stream BatchGetDocumentsResponse) { option (google.api.http) = { post: "/v1/{database=projects/*/databases/*}/documents:batchGet" body: "*" @@ -101,7 +103,8 @@ service Firestore { } // Starts a new transaction. - rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse) { + rpc BeginTransaction(BeginTransactionRequest) + returns (BeginTransactionResponse) { option (google.api.http) = { post: "/v1/{database=projects/*/databases/*}/documents:beginTransaction" body: "*" @@ -153,7 +156,8 @@ service Firestore { } // Lists all the collection IDs underneath a document. - rpc ListCollectionIds(ListCollectionIdsRequest) returns (ListCollectionIdsResponse) { + rpc ListCollectionIds(ListCollectionIdsRequest) + returns (ListCollectionIdsResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/databases/*/documents}:listCollectionIds" body: "*" @@ -165,7 +169,8 @@ service Firestore { } } -// The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument]. +// The request for +// [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument]. message GetDocumentRequest { // The resource name of the Document to get. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -189,7 +194,8 @@ message GetDocumentRequest { } } -// The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments]. +// The request for +// [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments]. message ListDocumentsRequest { // The parent resource name. In the format: // `projects/{project_id}/databases/{database_id}/documents` or @@ -231,15 +237,17 @@ message ListDocumentsRequest { // If the list should show missing documents. A missing document is a // document that does not exist but has sub-documents. These documents will - // be returned with a key but will not have fields, [Document.create_time][google.firestore.v1.Document.create_time], - // or [Document.update_time][google.firestore.v1.Document.update_time] set. + // be returned with a key but will not have fields, + // [Document.create_time][google.firestore.v1.Document.create_time], or + // [Document.update_time][google.firestore.v1.Document.update_time] set. // // Requests with `show_missing` may not specify `where` or // `order_by`. bool show_missing = 12; } -// The response for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments]. +// The response for +// [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments]. message ListDocumentsResponse { // The Documents found. repeated Document documents = 1; @@ -248,7 +256,8 @@ message ListDocumentsResponse { string next_page_token = 2; } -// The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument]. +// The request for +// [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument]. message CreateDocumentRequest { // The parent resource. For example: // `projects/{project_id}/databases/{database_id}/documents` or @@ -273,7 +282,8 @@ message CreateDocumentRequest { DocumentMask mask = 5; } -// The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument]. +// The request for +// [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument]. message UpdateDocumentRequest { // The updated document. // Creates the document if it does not already exist. @@ -299,7 +309,8 @@ message UpdateDocumentRequest { Precondition current_document = 4; } -// The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument]. +// The request for +// [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument]. message DeleteDocumentRequest { // The resource name of the Document to delete. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -310,7 +321,8 @@ message DeleteDocumentRequest { Precondition current_document = 2; } -// The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments]. +// The request for +// [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments]. message BatchGetDocumentsRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -346,7 +358,8 @@ message BatchGetDocumentsRequest { } } -// The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments]. +// The streamed response for +// [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments]. message BatchGetDocumentsResponse { // A single result. // This can be empty if the server is just returning a transaction. @@ -361,7 +374,8 @@ message BatchGetDocumentsResponse { // The transaction that was started as part of this request. // Will only be set in the first response, and only if - // [BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction] was set in the request. + // [BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction] + // was set in the request. bytes transaction = 3; // The time at which the document was read. @@ -371,7 +385,8 @@ message BatchGetDocumentsResponse { google.protobuf.Timestamp read_time = 4; } -// The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction]. +// The request for +// [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction]. message BeginTransactionRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -382,7 +397,8 @@ message BeginTransactionRequest { TransactionOptions options = 2; } -// The response for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction]. +// The response for +// [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction]. message BeginTransactionResponse { // The transaction that was started. bytes transaction = 1; @@ -459,12 +475,14 @@ message RunQueryRequest { } } -// The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery]. +// The response for +// [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery]. message RunQueryResponse { // The transaction that was started as part of this request. // Can only be set in the first response, and only if - // [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction] was set in the request. - // If set, no other fields will be set in this response. + // [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction] + // was set in the request. If set, no other fields will be set in this + // response. bytes transaction = 2; // A query result. @@ -517,9 +535,9 @@ message WriteRequest { // A stream token that was previously sent by the server. // // The client should set this field to the token from the most recent - // [WriteResponse][google.firestore.v1.WriteResponse] it has received. This acknowledges that the client has - // received responses up to this token. After sending this token, earlier - // tokens may not be used anymore. + // [WriteResponse][google.firestore.v1.WriteResponse] it has received. This + // acknowledges that the client has received responses up to this token. After + // sending this token, earlier tokens may not be used anymore. // // The server may close the stream if there are too many unacknowledged // responses. @@ -588,8 +606,8 @@ message ListenResponse { // A [Document][google.firestore.v1.Document] has been deleted. DocumentDelete document_delete = 4; - // A [Document][google.firestore.v1.Document] has been removed from a target (because it is no longer - // relevant to that target). + // A [Document][google.firestore.v1.Document] has been removed from a target + // (because it is no longer relevant to that target). DocumentRemove document_remove = 6; // A filter to apply to the set of documents previously returned for the @@ -643,7 +661,8 @@ message Target { // If not specified, all matching Documents are returned before any // subsequent changes. oneof resume_type { - // A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target. + // A resume token from a prior + // [TargetChange][google.firestore.v1.TargetChange] for an identical target. // // Using a resume token with a different target is unsupported and may fail. bytes resume_token = 4; @@ -735,7 +754,8 @@ message TargetChange { google.protobuf.Timestamp read_time = 6; } -// The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds]. +// The request for +// [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds]. message ListCollectionIdsRequest { // The parent document. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -751,7 +771,8 @@ message ListCollectionIdsRequest { string page_token = 3; } -// The response from [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds]. +// The response from +// [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds]. message ListCollectionIdsResponse { // The collection ids. repeated string collection_ids = 1; diff --git a/google/firestore/v1/query.proto b/google/firestore/v1/query.proto index dd89ef51..a2b4c10f 100644 --- a/google/firestore/v1/query.proto +++ b/google/firestore/v1/query.proto @@ -29,7 +29,6 @@ option java_package = "com.google.firestore.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1"; - // A Firestore query. message StructuredQuery { // A selection of a collection, such as `messages as m1`. diff --git a/google/firestore/v1/write.proto b/google/firestore/v1/write.proto index bffd0790..70bb74d2 100644 --- a/google/firestore/v1/write.proto +++ b/google/firestore/v1/write.proto @@ -30,7 +30,6 @@ option java_package = "com.google.firestore.v1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1"; - // A write on a document. message Write { // The operation to execute. @@ -81,8 +80,9 @@ message DocumentTransform { REQUEST_TIME = 1; } - // The path of the field. See [Document.fields][google.firestore.v1.Document.fields] for the field path syntax - // reference. + // The path of the field. See + // [Document.fields][google.firestore.v1.Document.fields] for the field path + // syntax reference. string field_path = 1; // The transformation to apply on the field. @@ -176,18 +176,20 @@ message WriteResult { // previous update_time. google.protobuf.Timestamp update_time = 1; - // The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1.DocumentTransform.FieldTransform], in the - // same order. + // The results of applying each + // [DocumentTransform.FieldTransform][google.firestore.v1.DocumentTransform.FieldTransform], + // in the same order. repeated Value transform_results = 2; } // A [Document][google.firestore.v1.Document] has changed. // -// May be the result of multiple [writes][google.firestore.v1.Write], including deletes, that -// ultimately resulted in a new value for the [Document][google.firestore.v1.Document]. +// May be the result of multiple [writes][google.firestore.v1.Write], including +// deletes, that ultimately resulted in a new value for the +// [Document][google.firestore.v1.Document]. // -// Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical -// change, if multiple targets are affected. +// Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be +// returned for the same logical change, if multiple targets are affected. message DocumentChange { // The new state of the [Document][google.firestore.v1.Document]. // @@ -203,13 +205,15 @@ message DocumentChange { // A [Document][google.firestore.v1.Document] has been deleted. // -// May be the result of multiple [writes][google.firestore.v1.Write], including updates, the -// last of which deleted the [Document][google.firestore.v1.Document]. +// May be the result of multiple [writes][google.firestore.v1.Write], including +// updates, the last of which deleted the +// [Document][google.firestore.v1.Document]. // -// Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical -// delete, if multiple targets are affected. +// Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be +// returned for the same logical delete, if multiple targets are affected. message DocumentDelete { - // The resource name of the [Document][google.firestore.v1.Document] that was deleted. + // The resource name of the [Document][google.firestore.v1.Document] that was + // deleted. string document = 1; // A set of target IDs for targets that previously matched this entity. @@ -221,16 +225,19 @@ message DocumentDelete { google.protobuf.Timestamp read_time = 4; } -// A [Document][google.firestore.v1.Document] has been removed from the view of the targets. +// A [Document][google.firestore.v1.Document] has been removed from the view of +// the targets. // // Sent if the document is no longer relevant to a target and is out of view. // Can be sent instead of a DocumentDelete or a DocumentChange if the server // can not send the new value of the document. // -// Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical -// write or delete, if multiple targets are affected. +// Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be +// returned for the same logical write or delete, if multiple targets are +// affected. message DocumentRemove { - // The resource name of the [Document][google.firestore.v1.Document] that has gone out of view. + // The resource name of the [Document][google.firestore.v1.Document] that has + // gone out of view. string document = 1; // A set of target IDs for targets that previously matched this document. @@ -247,7 +254,8 @@ message ExistenceFilter { // The target ID to which this filter applies. int32 target_id = 1; - // The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id]. + // The total count of documents that match + // [target_id][google.firestore.v1.ExistenceFilter.target_id]. // // If different from the count of documents in the client that match, the // client must manually determine which documents no longer match the target. diff --git a/google/firestore/v1beta1/common.proto b/google/firestore/v1beta1/common.proto index 4046a0d6..027b1a09 100644 --- a/google/firestore/v1beta1/common.proto +++ b/google/firestore/v1beta1/common.proto @@ -28,14 +28,15 @@ option java_package = "com.google.firestore.v1beta1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1beta1"; - // A set of field paths on a document. // Used to restrict a get or update operation on a document to a subset of its // fields. // This is different from standard field masks, as this is always scoped to a -// [Document][google.firestore.v1beta1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1beta1.Value]. +// [Document][google.firestore.v1beta1.Document], and takes in account the +// dynamic nature of [Value][google.firestore.v1beta1.Value]. message DocumentMask { - // The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field + // The list of field paths in the mask. See + // [Document.fields][google.firestore.v1beta1.Document.fields] for a field // path syntax reference. repeated string field_paths = 1; } diff --git a/google/firestore/v1beta1/document.proto b/google/firestore/v1beta1/document.proto index beb525a4..0e11eff0 100644 --- a/google/firestore/v1beta1/document.proto +++ b/google/firestore/v1beta1/document.proto @@ -30,7 +30,6 @@ option java_package = "com.google.firestore.v1beta1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1beta1"; - // A Firestore document. // // Must not exceed 1 MiB - 4 bytes. diff --git a/google/firestore/v1beta1/firestore.proto b/google/firestore/v1beta1/firestore.proto index 39ea90e2..dc310d70 100644 --- a/google/firestore/v1beta1/firestore.proto +++ b/google/firestore/v1beta1/firestore.proto @@ -33,6 +33,7 @@ option java_outer_classname = "FirestoreProto"; option java_package = "com.google.firestore.v1beta1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1beta1"; + // Specification of the Firestore API. // The Cloud Firestore service. @@ -93,7 +94,8 @@ service Firestore { // // Documents returned by this method are not guaranteed to be returned in the // same order that they were requested. - rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (stream BatchGetDocumentsResponse) { + rpc BatchGetDocuments(BatchGetDocumentsRequest) + returns (stream BatchGetDocumentsResponse) { option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:batchGet" body: "*" @@ -101,7 +103,8 @@ service Firestore { } // Starts a new transaction. - rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse) { + rpc BeginTransaction(BeginTransactionRequest) + returns (BeginTransactionResponse) { option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:beginTransaction" body: "*" @@ -153,7 +156,8 @@ service Firestore { } // Lists all the collection IDs underneath a document. - rpc ListCollectionIds(ListCollectionIdsRequest) returns (ListCollectionIdsResponse) { + rpc ListCollectionIds(ListCollectionIdsRequest) + returns (ListCollectionIdsResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds" body: "*" @@ -165,7 +169,8 @@ service Firestore { } } -// The request for [Firestore.GetDocument][google.firestore.v1beta1.Firestore.GetDocument]. +// The request for +// [Firestore.GetDocument][google.firestore.v1beta1.Firestore.GetDocument]. message GetDocumentRequest { // The resource name of the Document to get. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -189,7 +194,8 @@ message GetDocumentRequest { } } -// The request for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments]. +// The request for +// [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments]. message ListDocumentsRequest { // The parent resource name. In the format: // `projects/{project_id}/databases/{database_id}/documents` or @@ -231,15 +237,17 @@ message ListDocumentsRequest { // If the list should show missing documents. A missing document is a // document that does not exist but has sub-documents. These documents will - // be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time], - // or [Document.update_time][google.firestore.v1beta1.Document.update_time] set. + // be returned with a key but will not have fields, + // [Document.create_time][google.firestore.v1beta1.Document.create_time], or + // [Document.update_time][google.firestore.v1beta1.Document.update_time] set. // // Requests with `show_missing` may not specify `where` or // `order_by`. bool show_missing = 12; } -// The response for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments]. +// The response for +// [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments]. message ListDocumentsResponse { // The Documents found. repeated Document documents = 1; @@ -248,7 +256,8 @@ message ListDocumentsResponse { string next_page_token = 2; } -// The request for [Firestore.CreateDocument][google.firestore.v1beta1.Firestore.CreateDocument]. +// The request for +// [Firestore.CreateDocument][google.firestore.v1beta1.Firestore.CreateDocument]. message CreateDocumentRequest { // The parent resource. For example: // `projects/{project_id}/databases/{database_id}/documents` or @@ -273,7 +282,8 @@ message CreateDocumentRequest { DocumentMask mask = 5; } -// The request for [Firestore.UpdateDocument][google.firestore.v1beta1.Firestore.UpdateDocument]. +// The request for +// [Firestore.UpdateDocument][google.firestore.v1beta1.Firestore.UpdateDocument]. message UpdateDocumentRequest { // The updated document. // Creates the document if it does not already exist. @@ -299,7 +309,8 @@ message UpdateDocumentRequest { Precondition current_document = 4; } -// The request for [Firestore.DeleteDocument][google.firestore.v1beta1.Firestore.DeleteDocument]. +// The request for +// [Firestore.DeleteDocument][google.firestore.v1beta1.Firestore.DeleteDocument]. message DeleteDocumentRequest { // The resource name of the Document to delete. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -310,7 +321,8 @@ message DeleteDocumentRequest { Precondition current_document = 2; } -// The request for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments]. +// The request for +// [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments]. message BatchGetDocumentsRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -346,7 +358,8 @@ message BatchGetDocumentsRequest { } } -// The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments]. +// The streamed response for +// [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments]. message BatchGetDocumentsResponse { // A single result. // This can be empty if the server is just returning a transaction. @@ -361,7 +374,8 @@ message BatchGetDocumentsResponse { // The transaction that was started as part of this request. // Will only be set in the first response, and only if - // [BatchGetDocumentsRequest.new_transaction][google.firestore.v1beta1.BatchGetDocumentsRequest.new_transaction] was set in the request. + // [BatchGetDocumentsRequest.new_transaction][google.firestore.v1beta1.BatchGetDocumentsRequest.new_transaction] + // was set in the request. bytes transaction = 3; // The time at which the document was read. @@ -371,7 +385,8 @@ message BatchGetDocumentsResponse { google.protobuf.Timestamp read_time = 4; } -// The request for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction]. +// The request for +// [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction]. message BeginTransactionRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -382,13 +397,15 @@ message BeginTransactionRequest { TransactionOptions options = 2; } -// The response for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction]. +// The response for +// [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction]. message BeginTransactionResponse { // The transaction that was started. bytes transaction = 1; } -// The request for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit]. +// The request for +// [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit]. message CommitRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -403,7 +420,8 @@ message CommitRequest { bytes transaction = 3; } -// The response for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit]. +// The response for +// [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit]. message CommitResponse { // The result of applying the writes. // @@ -415,7 +433,8 @@ message CommitResponse { google.protobuf.Timestamp commit_time = 2; } -// The request for [Firestore.Rollback][google.firestore.v1beta1.Firestore.Rollback]. +// The request for +// [Firestore.Rollback][google.firestore.v1beta1.Firestore.Rollback]. message RollbackRequest { // The database name. In the format: // `projects/{project_id}/databases/{database_id}`. @@ -425,7 +444,8 @@ message RollbackRequest { bytes transaction = 2; } -// The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery]. +// The request for +// [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery]. message RunQueryRequest { // The parent resource name. In the format: // `projects/{project_id}/databases/{database_id}/documents` or @@ -459,12 +479,14 @@ message RunQueryRequest { } } -// The response for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery]. +// The response for +// [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery]. message RunQueryResponse { // The transaction that was started as part of this request. // Can only be set in the first response, and only if - // [RunQueryRequest.new_transaction][google.firestore.v1beta1.RunQueryRequest.new_transaction] was set in the request. - // If set, no other fields will be set in this response. + // [RunQueryRequest.new_transaction][google.firestore.v1beta1.RunQueryRequest.new_transaction] + // was set in the request. If set, no other fields will be set in this + // response. bytes transaction = 2; // A query result. @@ -517,9 +539,9 @@ message WriteRequest { // A stream token that was previously sent by the server. // // The client should set this field to the token from the most recent - // [WriteResponse][google.firestore.v1beta1.WriteResponse] it has received. This acknowledges that the client has - // received responses up to this token. After sending this token, earlier - // tokens may not be used anymore. + // [WriteResponse][google.firestore.v1beta1.WriteResponse] it has received. + // This acknowledges that the client has received responses up to this token. + // After sending this token, earlier tokens may not be used anymore. // // The server may close the stream if there are too many unacknowledged // responses. @@ -575,7 +597,8 @@ message ListenRequest { map labels = 4; } -// The response for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen]. +// The response for +// [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen]. message ListenResponse { // The supported responses. oneof response_type { @@ -588,8 +611,8 @@ message ListenResponse { // A [Document][google.firestore.v1beta1.Document] has been deleted. DocumentDelete document_delete = 4; - // A [Document][google.firestore.v1beta1.Document] has been removed from a target (because it is no longer - // relevant to that target). + // A [Document][google.firestore.v1beta1.Document] has been removed from a + // target (because it is no longer relevant to that target). DocumentRemove document_remove = 6; // A filter to apply to the set of documents previously returned for the @@ -643,7 +666,9 @@ message Target { // If not specified, all matching Documents are returned before any // subsequent changes. oneof resume_type { - // A resume token from a prior [TargetChange][google.firestore.v1beta1.TargetChange] for an identical target. + // A resume token from a prior + // [TargetChange][google.firestore.v1beta1.TargetChange] for an identical + // target. // // Using a resume token with a different target is unsupported and may fail. bytes resume_token = 4; @@ -735,7 +760,8 @@ message TargetChange { google.protobuf.Timestamp read_time = 6; } -// The request for [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds]. +// The request for +// [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds]. message ListCollectionIdsRequest { // The parent document. In the format: // `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -751,7 +777,8 @@ message ListCollectionIdsRequest { string page_token = 3; } -// The response from [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds]. +// The response from +// [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds]. message ListCollectionIdsResponse { // The collection ids. repeated string collection_ids = 1; diff --git a/google/firestore/v1beta1/query.proto b/google/firestore/v1beta1/query.proto index 17e93021..9bd0ad50 100644 --- a/google/firestore/v1beta1/query.proto +++ b/google/firestore/v1beta1/query.proto @@ -29,7 +29,6 @@ option java_package = "com.google.firestore.v1beta1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1beta1"; - // A Firestore query. message StructuredQuery { // A selection of a collection, such as `messages as m1`. diff --git a/google/firestore/v1beta1/write.proto b/google/firestore/v1beta1/write.proto index 98cd6cbb..ff7d3f25 100644 --- a/google/firestore/v1beta1/write.proto +++ b/google/firestore/v1beta1/write.proto @@ -30,7 +30,6 @@ option java_package = "com.google.firestore.v1beta1"; option objc_class_prefix = "GCFS"; option php_namespace = "Google\\Cloud\\Firestore\\V1beta1"; - // A write on a document. message Write { // The operation to execute. @@ -81,8 +80,9 @@ message DocumentTransform { REQUEST_TIME = 1; } - // The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax - // reference. + // The path of the field. See + // [Document.fields][google.firestore.v1beta1.Document.fields] for the field + // path syntax reference. string field_path = 1; // The transformation to apply on the field. @@ -176,18 +176,21 @@ message WriteResult { // previous update_time. google.protobuf.Timestamp update_time = 1; - // The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the - // same order. + // The results of applying each + // [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], + // in the same order. repeated Value transform_results = 2; } // A [Document][google.firestore.v1beta1.Document] has changed. // -// May be the result of multiple [writes][google.firestore.v1beta1.Write], including deletes, that -// ultimately resulted in a new value for the [Document][google.firestore.v1beta1.Document]. +// May be the result of multiple [writes][google.firestore.v1beta1.Write], +// including deletes, that ultimately resulted in a new value for the +// [Document][google.firestore.v1beta1.Document]. // -// Multiple [DocumentChange][google.firestore.v1beta1.DocumentChange] messages may be returned for the same logical -// change, if multiple targets are affected. +// Multiple [DocumentChange][google.firestore.v1beta1.DocumentChange] messages +// may be returned for the same logical change, if multiple targets are +// affected. message DocumentChange { // The new state of the [Document][google.firestore.v1beta1.Document]. // @@ -203,13 +206,16 @@ message DocumentChange { // A [Document][google.firestore.v1beta1.Document] has been deleted. // -// May be the result of multiple [writes][google.firestore.v1beta1.Write], including updates, the -// last of which deleted the [Document][google.firestore.v1beta1.Document]. +// May be the result of multiple [writes][google.firestore.v1beta1.Write], +// including updates, the last of which deleted the +// [Document][google.firestore.v1beta1.Document]. // -// Multiple [DocumentDelete][google.firestore.v1beta1.DocumentDelete] messages may be returned for the same logical -// delete, if multiple targets are affected. +// Multiple [DocumentDelete][google.firestore.v1beta1.DocumentDelete] messages +// may be returned for the same logical delete, if multiple targets are +// affected. message DocumentDelete { - // The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted. + // The resource name of the [Document][google.firestore.v1beta1.Document] that + // was deleted. string document = 1; // A set of target IDs for targets that previously matched this entity. @@ -221,16 +227,19 @@ message DocumentDelete { google.protobuf.Timestamp read_time = 4; } -// A [Document][google.firestore.v1beta1.Document] has been removed from the view of the targets. +// A [Document][google.firestore.v1beta1.Document] has been removed from the +// view of the targets. // // Sent if the document is no longer relevant to a target and is out of view. // Can be sent instead of a DocumentDelete or a DocumentChange if the server // can not send the new value of the document. // -// Multiple [DocumentRemove][google.firestore.v1beta1.DocumentRemove] messages may be returned for the same logical -// write or delete, if multiple targets are affected. +// Multiple [DocumentRemove][google.firestore.v1beta1.DocumentRemove] messages +// may be returned for the same logical write or delete, if multiple targets are +// affected. message DocumentRemove { - // The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view. + // The resource name of the [Document][google.firestore.v1beta1.Document] that + // has gone out of view. string document = 1; // A set of target IDs for targets that previously matched this document. @@ -247,7 +256,8 @@ message ExistenceFilter { // The target ID to which this filter applies. int32 target_id = 1; - // The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id]. + // The total count of documents that match + // [target_id][google.firestore.v1beta1.ExistenceFilter.target_id]. // // If different from the count of documents in the client that match, the // client must manually determine which documents no longer match the target.