1- // Copyright 2022 Google LLC
1+ // Copyright 2023 Google LLC
22//
33// Licensed under the Apache License, Version 2.0 (the "License");
44// you may not use this file except in compliance with the License.
@@ -34,65 +34,51 @@ option ruby_package = "Google::Cloud::Datastore::Admin::V1";
3434
3535// Google Cloud Datastore Admin API
3636//
37- //
3837// The Datastore Admin API provides several admin services for Cloud Datastore.
3938//
40- // -----------------------------------------------------------------------------
41- // ## Concepts
42- //
43- // Project, namespace, kind, and entity as defined in the Google Cloud Datastore
44- // API.
39+ // Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
40+ // Datastore API.
4541//
4642// Operation: An Operation represents work being performed in the background.
4743//
4844// EntityFilter: Allows specifying a subset of entities in a project. This is
4945// specified as a combination of kinds and namespaces (either or both of which
5046// may be all).
5147//
52- // -----------------------------------------------------------------------------
53- // ## Services
54- //
55- // # Export/Import
48+ // Export/Import Service:
5649//
57- // The Export/Import service provides the ability to copy all or a subset of
50+ // - The Export/Import service provides the ability to copy all or a subset of
5851// entities to/from Google Cloud Storage.
59- //
60- // Exported data may be imported into Cloud Datastore for any Google Cloud
52+ // - Exported data may be imported into Cloud Datastore for any Google Cloud
6153// Platform project. It is not restricted to the export source project. It is
6254// possible to export from one project and then import into another.
63- //
64- // Exported data can also be loaded into Google BigQuery for analysis.
65- //
66- // Exports and imports are performed asynchronously. An Operation resource is
55+ // - Exported data can also be loaded into Google BigQuery for analysis.
56+ // - Exports and imports are performed asynchronously. An Operation resource is
6757// created for each export/import. The state (including any errors encountered)
6858// of the export/import may be queried via the Operation resource.
6959//
70- // # Index
60+ // Index Service:
7161//
72- // The index service manages Cloud Datastore composite indexes.
73- //
74- // Index creation and deletion are performed asynchronously.
62+ // - The index service manages Cloud Datastore composite indexes.
63+ // - Index creation and deletion are performed asynchronously.
7564// An Operation resource is created for each such asynchronous operation.
7665// The state of the operation (including any errors encountered)
7766// may be queried via the Operation resource.
7867//
79- // # Operation
68+ // Operation Service:
8069//
81- // The Operations collection provides a record of actions performed for the
70+ // - The Operations collection provides a record of actions performed for the
8271// specified project (including any operations in progress). Operations are not
8372// created directly but through calls on other collections or resources.
84- //
85- // An operation that is not yet done may be cancelled. The request to cancel is
86- // asynchronous and the operation may continue to run for some time after the
73+ // - An operation that is not yet done may be cancelled. The request to cancel
74+ // is asynchronous and the operation may continue to run for some time after the
8775// request to cancel is made.
88- //
89- // An operation that is done may be deleted so that it is no longer listed as
76+ // - An operation that is done may be deleted so that it is no longer listed as
9077// part of the Operation collection.
91- //
92- // ListOperations returns all pending operations, but not completed operations.
93- //
94- // Operations are created by service DatastoreAdmin,
95- // but are accessed via service google.longrunning.Operations.
78+ // - ListOperations returns all pending operations, but not completed
79+ // operations.
80+ // - Operations are created by service DatastoreAdmin, but are accessed via
81+ // service google.longrunning.Operations.
9682service DatastoreAdmin {
9783 option (google.api.default_host ) = "datastore.googleapis.com" ;
9884 option (google.api.oauth_scopes ) =
@@ -107,12 +93,14 @@ service DatastoreAdmin {
10793 // used once the associated operation is done. If an export operation is
10894 // cancelled before completion it may leave partial data behind in Google
10995 // Cloud Storage.
110- rpc ExportEntities (ExportEntitiesRequest ) returns (google .longrunning .Operation ) {
96+ rpc ExportEntities (ExportEntitiesRequest )
97+ returns (google .longrunning .Operation ) {
11198 option (google.api.http ) = {
11299 post : "/v1/projects/{project_id}:export"
113100 body : "*"
114101 };
115- option (google.api.method_signature ) = "project_id,labels,entity_filter,output_url_prefix" ;
102+ option (google.api.method_signature ) =
103+ "project_id,labels,entity_filter,output_url_prefix" ;
116104 option (google.longrunning.operation_info ) = {
117105 response_type : "ExportEntitiesResponse"
118106 metadata_type : "ExportEntitiesMetadata"
@@ -124,12 +112,14 @@ service DatastoreAdmin {
124112 // progress can be monitored and managed via the Operation resource that is
125113 // created. If an ImportEntities operation is cancelled, it is possible
126114 // that a subset of the data has already been imported to Cloud Datastore.
127- rpc ImportEntities (ImportEntitiesRequest ) returns (google .longrunning .Operation ) {
115+ rpc ImportEntities (ImportEntitiesRequest )
116+ returns (google .longrunning .Operation ) {
128117 option (google.api.http ) = {
129118 post : "/v1/projects/{project_id}:import"
130119 body : "*"
131120 };
132- option (google.api.method_signature ) = "project_id,labels,input_url,entity_filter" ;
121+ option (google.api.method_signature ) =
122+ "project_id,labels,input_url,entity_filter" ;
133123 option (google.longrunning.operation_info ) = {
134124 response_type : "google.protobuf.Empty"
135125 metadata_type : "ImportEntitiesMetadata"
@@ -138,9 +128,9 @@ service DatastoreAdmin {
138128
139129 // Creates the specified index.
140130 // A newly created index's initial state is `CREATING`. On completion of the
141- // returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
142- // If the index already exists, the call will return an `ALREADY_EXISTS`
143- // status.
131+ // returned [google.longrunning.Operation][google.longrunning.Operation], the
132+ // state will be `READY`. If the index already exists, the call will return an
133+ // `ALREADY_EXISTS` status.
144134 //
145135 // During index creation, the process could result in an error, in which
146136 // case the index will move to the `ERROR` state. The process can be recovered
@@ -165,7 +155,8 @@ service DatastoreAdmin {
165155 // An index can only be deleted if it is in a `READY` or `ERROR` state. On
166156 // successful execution of the request, the index will be in a `DELETING`
167157 // [state][google.datastore.admin.v1.Index.State]. And on completion of the
168- // returned [google.longrunning.Operation][google.longrunning.Operation], the index will be removed.
158+ // returned [google.longrunning.Operation][google.longrunning.Operation], the
159+ // index will be removed.
169160 //
170161 // During index deletion, the process could result in an error, in which
171162 // case the index will move to the `ERROR` state. The process can be recovered
@@ -283,8 +274,8 @@ message ExportEntitiesRequest {
283274 //
284275 // The resulting files will be nested deeper than the specified URL prefix.
285276 // The final output URL will be provided in the
286- // [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url] field. That
287- // value should be used for subsequent ImportEntities operations.
277+ // [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
278+ // field. That value should be used for subsequent ImportEntities operations.
288279 //
289280 // By nesting the data files deeper, the same Cloud Storage bucket can be used
290281 // in multiple ExportEntities operations without conflict.
@@ -300,8 +291,9 @@ message ImportEntitiesRequest {
300291 // Client-assigned labels.
301292 map <string , string > labels = 2 ;
302293
303- // Required. The full resource URL of the external storage location. Currently, only
304- // Google Cloud Storage is supported. So input_url should be of the form:
294+ // Required. The full resource URL of the external storage location.
295+ // Currently, only Google Cloud Storage is supported. So input_url should be
296+ // of the form:
305297 // `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
306298 // `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
307299 // an optional Cloud Storage namespace path (this is not a Cloud Datastore
@@ -369,7 +361,9 @@ message ImportEntitiesMetadata {
369361 EntityFilter entity_filter = 4 ;
370362
371363 // The location of the import metadata file. This will be the same value as
372- // the [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url] field.
364+ // the
365+ // [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
366+ // field.
373367 string input_url = 5 ;
374368}
375369
@@ -427,7 +421,8 @@ message DeleteIndexRequest {
427421 string index_id = 3 ;
428422}
429423
430- // The request for [google.datastore.admin.v1.DatastoreAdmin.GetIndex][google.datastore.admin.v1.DatastoreAdmin.GetIndex].
424+ // The request for
425+ // [google.datastore.admin.v1.DatastoreAdmin.GetIndex][google.datastore.admin.v1.DatastoreAdmin.GetIndex].
431426message GetIndexRequest {
432427 // Project ID against which to make the request.
433428 string project_id = 1 ;
0 commit comments