google-cloud-datastore-admin-v1 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66fb6d8c2be8c1f60d5b584bc5cada3619b1767f85f94147700ab05b72a2289d
4
- data.tar.gz: 4b15bc47177070078eed82c88f31f4e051e63a8971982bdc5da417c103cc2b23
3
+ metadata.gz: 01d444ab7da6e96d26e14d0a84e23138482b5b1394776bb8becd916b64fc740c
4
+ data.tar.gz: ba98bcf3c45c9ba6ad78a5d6a666120d19ee276c16a4d24df8663f6553b154ad
5
5
  SHA512:
6
- metadata.gz: 6982ddea912ac8f7985fb1021d002b39c3a60fd5fc9ebaa28e3beab3d6b8136b24a1accbd79775b6ba80a103e484f9c1c04b04f13de03aee72f3401603dfa9e7
7
- data.tar.gz: 335094af429801b0a71310a762ede2b6fcaabc8a7fc78764bf65b786dcb44a5f404b11f0288bc1d5a14863783f32fcee0280d7a524928b1e487d03bc9988de5c
6
+ metadata.gz: ccd3302671a971abcbd23a64a5c2e4aff2334e3c5e530c3df137d9d5f65a1ad8c8d9a7240272fbd8150891df4609c402696d4773ac2e5cfa23dc5a2c049744e3
7
+ data.tar.gz: fde243633af62f8564cadf188f7f1030e6356773f43741a393313775e9928f43babe3a3e91c418e9d90d37a84c5e0295006d9b8303560992eb9ce4da9e7e5892
@@ -30,14 +30,10 @@ module Google
30
30
  #
31
31
  # Google Cloud Datastore Admin API
32
32
  #
33
- #
34
33
  # The Datastore Admin API provides several admin services for Cloud Datastore.
35
34
  #
36
- # -----------------------------------------------------------------------------
37
- # ## Concepts
38
- #
39
- # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
40
- # API.
35
+ # Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
36
+ # Datastore API.
41
37
  #
42
38
  # Operation: An Operation represents work being performed in the background.
43
39
  #
@@ -45,50 +41,40 @@ module Google
45
41
  # specified as a combination of kinds and namespaces (either or both of which
46
42
  # may be all).
47
43
  #
48
- # -----------------------------------------------------------------------------
49
- # ## Services
44
+ # Export/Import Service:
50
45
  #
51
- # # Export/Import
52
- #
53
- # The Export/Import service provides the ability to copy all or a subset of
46
+ # - The Export/Import service provides the ability to copy all or a subset of
54
47
  # entities to/from Google Cloud Storage.
55
- #
56
- # Exported data may be imported into Cloud Datastore for any Google Cloud
48
+ # - Exported data may be imported into Cloud Datastore for any Google Cloud
57
49
  # Platform project. It is not restricted to the export source project. It is
58
50
  # possible to export from one project and then import into another.
59
- #
60
- # Exported data can also be loaded into Google BigQuery for analysis.
61
- #
62
- # Exports and imports are performed asynchronously. An Operation resource is
51
+ # - Exported data can also be loaded into Google BigQuery for analysis.
52
+ # - Exports and imports are performed asynchronously. An Operation resource is
63
53
  # created for each export/import. The state (including any errors encountered)
64
54
  # of the export/import may be queried via the Operation resource.
65
55
  #
66
- # # Index
56
+ # Index Service:
67
57
  #
68
- # The index service manages Cloud Datastore composite indexes.
69
- #
70
- # Index creation and deletion are performed asynchronously.
58
+ # - The index service manages Cloud Datastore composite indexes.
59
+ # - Index creation and deletion are performed asynchronously.
71
60
  # An Operation resource is created for each such asynchronous operation.
72
61
  # The state of the operation (including any errors encountered)
73
62
  # may be queried via the Operation resource.
74
63
  #
75
- # # Operation
64
+ # Operation Service:
76
65
  #
77
- # The Operations collection provides a record of actions performed for the
66
+ # - The Operations collection provides a record of actions performed for the
78
67
  # specified project (including any operations in progress). Operations are not
79
68
  # created directly but through calls on other collections or resources.
80
- #
81
- # An operation that is not yet done may be cancelled. The request to cancel is
82
- # asynchronous and the operation may continue to run for some time after the
69
+ # - An operation that is not yet done may be cancelled. The request to cancel
70
+ # is asynchronous and the operation may continue to run for some time after the
83
71
  # request to cancel is made.
84
- #
85
- # An operation that is done may be deleted so that it is no longer listed as
72
+ # - An operation that is done may be deleted so that it is no longer listed as
86
73
  # part of the Operation collection.
87
- #
88
- # ListOperations returns all pending operations, but not completed operations.
89
- #
90
- # Operations are created by service DatastoreAdmin,
91
- # but are accessed via service google.longrunning.Operations.
74
+ # - ListOperations returns all pending operations, but not completed
75
+ # operations.
76
+ # - Operations are created by service DatastoreAdmin, but are accessed via
77
+ # service google.longrunning.Operations.
92
78
  #
93
79
  class Client
94
80
  # @private
@@ -221,7 +207,8 @@ module Google
221
207
  credentials: credentials,
222
208
  endpoint: @config.endpoint,
223
209
  channel_args: @config.channel_args,
224
- interceptors: @config.interceptors
210
+ interceptors: @config.interceptors,
211
+ channel_pool_config: @config.channel_pool
225
212
  )
226
213
  end
227
214
 
@@ -279,8 +266,8 @@ module Google
279
266
  #
280
267
  # The resulting files will be nested deeper than the specified URL prefix.
281
268
  # The final output URL will be provided in the
282
- # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field. That
283
- # value should be used for subsequent ImportEntities operations.
269
+ # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}
270
+ # field. That value should be used for subsequent ImportEntities operations.
284
271
  #
285
272
  # By nesting the data files deeper, the same Cloud Storage bucket can be used
286
273
  # in multiple ExportEntities operations without conflict.
@@ -384,8 +371,9 @@ module Google
384
371
  # @param labels [::Hash{::String => ::String}]
385
372
  # Client-assigned labels.
386
373
  # @param input_url [::String]
387
- # Required. The full resource URL of the external storage location. Currently, only
388
- # Google Cloud Storage is supported. So input_url should be of the form:
374
+ # Required. The full resource URL of the external storage location.
375
+ # Currently, only Google Cloud Storage is supported. So input_url should be
376
+ # of the form:
389
377
  # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
390
378
  # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
391
379
  # an optional Cloud Storage namespace path (this is not a Cloud Datastore
@@ -478,9 +466,9 @@ module Google
478
466
  ##
479
467
  # Creates the specified index.
480
468
  # A newly created index's initial state is `CREATING`. On completion of the
481
- # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the state will be `READY`.
482
- # If the index already exists, the call will return an `ALREADY_EXISTS`
483
- # status.
469
+ # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the
470
+ # state will be `READY`. If the index already exists, the call will return an
471
+ # `ALREADY_EXISTS` status.
484
472
  #
485
473
  # During index creation, the process could result in an error, in which
486
474
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -589,7 +577,8 @@ module Google
589
577
  # An index can only be deleted if it is in a `READY` or `ERROR` state. On
590
578
  # successful execution of the request, the index will be in a `DELETING`
591
579
  # {::Google::Cloud::Datastore::Admin::V1::Index::State state}. And on completion of the
592
- # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the index will be removed.
580
+ # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the
581
+ # index will be removed.
593
582
  #
594
583
  # During index deletion, the process could result in an error, in which
595
584
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -998,6 +987,14 @@ module Google
998
987
  end
999
988
  end
1000
989
 
990
+ ##
991
+ # Configuration for the channel pool
992
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
993
+ #
994
+ def channel_pool
995
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
996
+ end
997
+
1001
998
  ##
1002
999
  # Configuration RPC class for the DatastoreAdmin API.
1003
1000
  #
@@ -94,7 +94,8 @@ module Google
94
94
  credentials: credentials,
95
95
  endpoint: @config.endpoint,
96
96
  channel_args: @config.channel_args,
97
- interceptors: @config.interceptors
97
+ interceptors: @config.interceptors,
98
+ channel_pool_config: @config.channel_pool
98
99
  )
99
100
 
100
101
  # Used by an LRO wrapper for some methods of this service
@@ -702,6 +703,14 @@ module Google
702
703
  end
703
704
  end
704
705
 
706
+ ##
707
+ # Configuration for the channel pool
708
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
709
+ #
710
+ def channel_pool
711
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
712
+ end
713
+
705
714
  ##
706
715
  # Configuration RPC class for the Operations API.
707
716
  #
@@ -32,14 +32,10 @@ module Google
32
32
  #
33
33
  # Google Cloud Datastore Admin API
34
34
  #
35
- #
36
35
  # The Datastore Admin API provides several admin services for Cloud Datastore.
37
36
  #
38
- # -----------------------------------------------------------------------------
39
- # ## Concepts
40
- #
41
- # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
42
- # API.
37
+ # Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
38
+ # Datastore API.
43
39
  #
44
40
  # Operation: An Operation represents work being performed in the background.
45
41
  #
@@ -47,50 +43,40 @@ module Google
47
43
  # specified as a combination of kinds and namespaces (either or both of which
48
44
  # may be all).
49
45
  #
50
- # -----------------------------------------------------------------------------
51
- # ## Services
46
+ # Export/Import Service:
52
47
  #
53
- # # Export/Import
54
- #
55
- # The Export/Import service provides the ability to copy all or a subset of
48
+ # - The Export/Import service provides the ability to copy all or a subset of
56
49
  # entities to/from Google Cloud Storage.
57
- #
58
- # Exported data may be imported into Cloud Datastore for any Google Cloud
50
+ # - Exported data may be imported into Cloud Datastore for any Google Cloud
59
51
  # Platform project. It is not restricted to the export source project. It is
60
52
  # possible to export from one project and then import into another.
61
- #
62
- # Exported data can also be loaded into Google BigQuery for analysis.
63
- #
64
- # Exports and imports are performed asynchronously. An Operation resource is
53
+ # - Exported data can also be loaded into Google BigQuery for analysis.
54
+ # - Exports and imports are performed asynchronously. An Operation resource is
65
55
  # created for each export/import. The state (including any errors encountered)
66
56
  # of the export/import may be queried via the Operation resource.
67
57
  #
68
- # # Index
69
- #
70
- # The index service manages Cloud Datastore composite indexes.
58
+ # Index Service:
71
59
  #
72
- # Index creation and deletion are performed asynchronously.
60
+ # - The index service manages Cloud Datastore composite indexes.
61
+ # - Index creation and deletion are performed asynchronously.
73
62
  # An Operation resource is created for each such asynchronous operation.
74
63
  # The state of the operation (including any errors encountered)
75
64
  # may be queried via the Operation resource.
76
65
  #
77
- # # Operation
66
+ # Operation Service:
78
67
  #
79
- # The Operations collection provides a record of actions performed for the
68
+ # - The Operations collection provides a record of actions performed for the
80
69
  # specified project (including any operations in progress). Operations are not
81
70
  # created directly but through calls on other collections or resources.
82
- #
83
- # An operation that is not yet done may be cancelled. The request to cancel is
84
- # asynchronous and the operation may continue to run for some time after the
71
+ # - An operation that is not yet done may be cancelled. The request to cancel
72
+ # is asynchronous and the operation may continue to run for some time after the
85
73
  # request to cancel is made.
86
- #
87
- # An operation that is done may be deleted so that it is no longer listed as
74
+ # - An operation that is done may be deleted so that it is no longer listed as
88
75
  # part of the Operation collection.
89
- #
90
- # ListOperations returns all pending operations, but not completed operations.
91
- #
92
- # Operations are created by service DatastoreAdmin,
93
- # but are accessed via service google.longrunning.Operations.
76
+ # - ListOperations returns all pending operations, but not completed
77
+ # operations.
78
+ # - Operations are created by service DatastoreAdmin, but are accessed via
79
+ # service google.longrunning.Operations.
94
80
  #
95
81
  class Client
96
82
  # @private
@@ -270,8 +256,8 @@ module Google
270
256
  #
271
257
  # The resulting files will be nested deeper than the specified URL prefix.
272
258
  # The final output URL will be provided in the
273
- # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field. That
274
- # value should be used for subsequent ImportEntities operations.
259
+ # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}
260
+ # field. That value should be used for subsequent ImportEntities operations.
275
261
  #
276
262
  # By nesting the data files deeper, the same Cloud Storage bucket can be used
277
263
  # in multiple ExportEntities operations without conflict.
@@ -282,6 +268,29 @@ module Google
282
268
  # @return [::Gapic::Operation]
283
269
  #
284
270
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
271
+ #
272
+ # @example Basic example
273
+ # require "google/cloud/datastore/admin/v1"
274
+ #
275
+ # # Create a client object. The client can be reused for multiple calls.
276
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
277
+ #
278
+ # # Create a request. To set request fields, pass in keyword arguments.
279
+ # request = Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest.new
280
+ #
281
+ # # Call the export_entities method.
282
+ # result = client.export_entities request
283
+ #
284
+ # # The returned object is of type Gapic::Operation. You can use it to
285
+ # # check the status of an operation, cancel it, or wait for results.
286
+ # # Here is how to wait for a response.
287
+ # result.wait_until_done! timeout: 60
288
+ # if result.response?
289
+ # p result.response
290
+ # else
291
+ # puts "No response received."
292
+ # end
293
+ #
285
294
  def export_entities request, options = nil
286
295
  raise ::ArgumentError, "request must be provided" if request.nil?
287
296
 
@@ -345,8 +354,9 @@ module Google
345
354
  # @param labels [::Hash{::String => ::String}]
346
355
  # Client-assigned labels.
347
356
  # @param input_url [::String]
348
- # Required. The full resource URL of the external storage location. Currently, only
349
- # Google Cloud Storage is supported. So input_url should be of the form:
357
+ # Required. The full resource URL of the external storage location.
358
+ # Currently, only Google Cloud Storage is supported. So input_url should be
359
+ # of the form:
350
360
  # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
351
361
  # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
352
362
  # an optional Cloud Storage namespace path (this is not a Cloud Datastore
@@ -370,6 +380,29 @@ module Google
370
380
  # @return [::Gapic::Operation]
371
381
  #
372
382
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
383
+ #
384
+ # @example Basic example
385
+ # require "google/cloud/datastore/admin/v1"
386
+ #
387
+ # # Create a client object. The client can be reused for multiple calls.
388
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
389
+ #
390
+ # # Create a request. To set request fields, pass in keyword arguments.
391
+ # request = Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest.new
392
+ #
393
+ # # Call the import_entities method.
394
+ # result = client.import_entities request
395
+ #
396
+ # # The returned object is of type Gapic::Operation. You can use it to
397
+ # # check the status of an operation, cancel it, or wait for results.
398
+ # # Here is how to wait for a response.
399
+ # result.wait_until_done! timeout: 60
400
+ # if result.response?
401
+ # p result.response
402
+ # else
403
+ # puts "No response received."
404
+ # end
405
+ #
373
406
  def import_entities request, options = nil
374
407
  raise ::ArgumentError, "request must be provided" if request.nil?
375
408
 
@@ -409,9 +442,9 @@ module Google
409
442
  ##
410
443
  # Creates the specified index.
411
444
  # A newly created index's initial state is `CREATING`. On completion of the
412
- # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the state will be `READY`.
413
- # If the index already exists, the call will return an `ALREADY_EXISTS`
414
- # status.
445
+ # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the
446
+ # state will be `READY`. If the index already exists, the call will return an
447
+ # `ALREADY_EXISTS` status.
415
448
  #
416
449
  # During index creation, the process could result in an error, in which
417
450
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -449,6 +482,29 @@ module Google
449
482
  # @return [::Gapic::Operation]
450
483
  #
451
484
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
485
+ #
486
+ # @example Basic example
487
+ # require "google/cloud/datastore/admin/v1"
488
+ #
489
+ # # Create a client object. The client can be reused for multiple calls.
490
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
491
+ #
492
+ # # Create a request. To set request fields, pass in keyword arguments.
493
+ # request = Google::Cloud::Datastore::Admin::V1::CreateIndexRequest.new
494
+ #
495
+ # # Call the create_index method.
496
+ # result = client.create_index request
497
+ #
498
+ # # The returned object is of type Gapic::Operation. You can use it to
499
+ # # check the status of an operation, cancel it, or wait for results.
500
+ # # Here is how to wait for a response.
501
+ # result.wait_until_done! timeout: 60
502
+ # if result.response?
503
+ # p result.response
504
+ # else
505
+ # puts "No response received."
506
+ # end
507
+ #
452
508
  def create_index request, options = nil
453
509
  raise ::ArgumentError, "request must be provided" if request.nil?
454
510
 
@@ -490,7 +546,8 @@ module Google
490
546
  # An index can only be deleted if it is in a `READY` or `ERROR` state. On
491
547
  # successful execution of the request, the index will be in a `DELETING`
492
548
  # {::Google::Cloud::Datastore::Admin::V1::Index::State state}. And on completion of the
493
- # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the index will be removed.
549
+ # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the
550
+ # index will be removed.
494
551
  #
495
552
  # During index deletion, the process could result in an error, in which
496
553
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -523,6 +580,29 @@ module Google
523
580
  # @return [::Gapic::Operation]
524
581
  #
525
582
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
583
+ #
584
+ # @example Basic example
585
+ # require "google/cloud/datastore/admin/v1"
586
+ #
587
+ # # Create a client object. The client can be reused for multiple calls.
588
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
589
+ #
590
+ # # Create a request. To set request fields, pass in keyword arguments.
591
+ # request = Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest.new
592
+ #
593
+ # # Call the delete_index method.
594
+ # result = client.delete_index request
595
+ #
596
+ # # The returned object is of type Gapic::Operation. You can use it to
597
+ # # check the status of an operation, cancel it, or wait for results.
598
+ # # Here is how to wait for a response.
599
+ # result.wait_until_done! timeout: 60
600
+ # if result.response?
601
+ # p result.response
602
+ # else
603
+ # puts "No response received."
604
+ # end
605
+ #
526
606
  def delete_index request, options = nil
527
607
  raise ::ArgumentError, "request must be provided" if request.nil?
528
608
 
@@ -588,6 +668,22 @@ module Google
588
668
  # @return [::Google::Cloud::Datastore::Admin::V1::Index]
589
669
  #
590
670
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
671
+ #
672
+ # @example Basic example
673
+ # require "google/cloud/datastore/admin/v1"
674
+ #
675
+ # # Create a client object. The client can be reused for multiple calls.
676
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
677
+ #
678
+ # # Create a request. To set request fields, pass in keyword arguments.
679
+ # request = Google::Cloud::Datastore::Admin::V1::GetIndexRequest.new
680
+ #
681
+ # # Call the get_index method.
682
+ # result = client.get_index request
683
+ #
684
+ # # The returned object is of type Google::Cloud::Datastore::Admin::V1::Index.
685
+ # p result
686
+ #
591
687
  def get_index request, options = nil
592
688
  raise ::ArgumentError, "request must be provided" if request.nil?
593
689
 
@@ -658,6 +754,26 @@ module Google
658
754
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastore::Admin::V1::Index>]
659
755
  #
660
756
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
757
+ #
758
+ # @example Basic example
759
+ # require "google/cloud/datastore/admin/v1"
760
+ #
761
+ # # Create a client object. The client can be reused for multiple calls.
762
+ # client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
763
+ #
764
+ # # Create a request. To set request fields, pass in keyword arguments.
765
+ # request = Google::Cloud::Datastore::Admin::V1::ListIndexesRequest.new
766
+ #
767
+ # # Call the list_indexes method.
768
+ # result = client.list_indexes request
769
+ #
770
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
771
+ # # over elements, and API calls will be issued to fetch pages as needed.
772
+ # result.each do |item|
773
+ # # Each element is of type ::Google::Cloud::Datastore::Admin::V1::Index.
774
+ # p item
775
+ # end
776
+ #
661
777
  def list_indexes request, options = nil
662
778
  raise ::ArgumentError, "request must be provided" if request.nil?
663
779
 
@@ -137,6 +137,26 @@ module Google
137
137
  # @return [::Gapic::Operation]
138
138
  #
139
139
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
140
+ #
141
+ # @example Basic example
142
+ # require "google/longrunning"
143
+ #
144
+ # # Create a client object. The client can be reused for multiple calls.
145
+ # client = Google::Longrunning::Operations::Rest::Client.new
146
+ #
147
+ # # Create a request. To set request fields, pass in keyword arguments.
148
+ # request = Google::Longrunning::ListOperationsRequest.new
149
+ #
150
+ # # Call the list_operations method.
151
+ # result = client.list_operations request
152
+ #
153
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
154
+ # # over elements, and API calls will be issued to fetch pages as needed.
155
+ # result.each do |item|
156
+ # # Each element is of type ::Google::Longrunning::Operation.
157
+ # p item
158
+ # end
159
+ #
140
160
  def list_operations request, options = nil
141
161
  raise ::ArgumentError, "request must be provided" if request.nil?
142
162
 
@@ -202,6 +222,29 @@ module Google
202
222
  # @return [::Gapic::Operation]
203
223
  #
204
224
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
225
+ #
226
+ # @example Basic example
227
+ # require "google/longrunning"
228
+ #
229
+ # # Create a client object. The client can be reused for multiple calls.
230
+ # client = Google::Longrunning::Operations::Rest::Client.new
231
+ #
232
+ # # Create a request. To set request fields, pass in keyword arguments.
233
+ # request = Google::Longrunning::GetOperationRequest.new
234
+ #
235
+ # # Call the get_operation method.
236
+ # result = client.get_operation request
237
+ #
238
+ # # The returned object is of type Gapic::Operation. You can use it to
239
+ # # check the status of an operation, cancel it, or wait for results.
240
+ # # Here is how to wait for a response.
241
+ # result.wait_until_done! timeout: 60
242
+ # if result.response?
243
+ # p result.response
244
+ # else
245
+ # puts "No response received."
246
+ # end
247
+ #
205
248
  def get_operation request, options = nil
206
249
  raise ::ArgumentError, "request must be provided" if request.nil?
207
250
 
@@ -268,6 +311,22 @@ module Google
268
311
  # @return [::Google::Protobuf::Empty]
269
312
  #
270
313
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
314
+ #
315
+ # @example Basic example
316
+ # require "google/longrunning"
317
+ #
318
+ # # Create a client object. The client can be reused for multiple calls.
319
+ # client = Google::Longrunning::Operations::Rest::Client.new
320
+ #
321
+ # # Create a request. To set request fields, pass in keyword arguments.
322
+ # request = Google::Longrunning::DeleteOperationRequest.new
323
+ #
324
+ # # Call the delete_operation method.
325
+ # result = client.delete_operation request
326
+ #
327
+ # # The returned object is of type Google::Protobuf::Empty.
328
+ # p result
329
+ #
271
330
  def delete_operation request, options = nil
272
331
  raise ::ArgumentError, "request must be provided" if request.nil?
273
332
 
@@ -339,6 +398,22 @@ module Google
339
398
  # @return [::Google::Protobuf::Empty]
340
399
  #
341
400
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
401
+ #
402
+ # @example Basic example
403
+ # require "google/longrunning"
404
+ #
405
+ # # Create a client object. The client can be reused for multiple calls.
406
+ # client = Google::Longrunning::Operations::Rest::Client.new
407
+ #
408
+ # # Create a request. To set request fields, pass in keyword arguments.
409
+ # request = Google::Longrunning::CancelOperationRequest.new
410
+ #
411
+ # # Call the cancel_operation method.
412
+ # result = client.cancel_operation request
413
+ #
414
+ # # The returned object is of type Google::Protobuf::Empty.
415
+ # p result
416
+ #
342
417
  def cancel_operation request, options = nil
343
418
  raise ::ArgumentError, "request must be provided" if request.nil?
344
419
 
@@ -34,14 +34,10 @@ module Google
34
34
  ##
35
35
  # Google Cloud Datastore Admin API
36
36
  #
37
- #
38
37
  # The Datastore Admin API provides several admin services for Cloud Datastore.
39
38
  #
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.
45
41
  #
46
42
  # Operation: An Operation represents work being performed in the background.
47
43
  #
@@ -49,50 +45,40 @@ module Google
49
45
  # specified as a combination of kinds and namespaces (either or both of which
50
46
  # may be all).
51
47
  #
52
- # -----------------------------------------------------------------------------
53
- # ## Services
54
- #
55
- # # Export/Import
48
+ # Export/Import Service:
56
49
  #
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
58
51
  # 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
61
53
  # Platform project. It is not restricted to the export source project. It is
62
54
  # 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
67
57
  # created for each export/import. The state (including any errors encountered)
68
58
  # of the export/import may be queried via the Operation resource.
69
59
  #
70
- # # Index
60
+ # Index Service:
71
61
  #
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.
75
64
  # An Operation resource is created for each such asynchronous operation.
76
65
  # The state of the operation (including any errors encountered)
77
66
  # may be queried via the Operation resource.
78
67
  #
79
- # # Operation
68
+ # Operation Service:
80
69
  #
81
- # The Operations collection provides a record of actions performed for the
70
+ # - The Operations collection provides a record of actions performed for the
82
71
  # specified project (including any operations in progress). Operations are not
83
72
  # 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
87
75
  # 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
90
77
  # 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.
96
82
  #
97
83
  # To load this service and instantiate a REST client:
98
84
  #
@@ -35,14 +35,10 @@ module Google
35
35
  ##
36
36
  # Google Cloud Datastore Admin API
37
37
  #
38
- #
39
38
  # The Datastore Admin API provides several admin services for Cloud Datastore.
40
39
  #
41
- # -----------------------------------------------------------------------------
42
- # ## Concepts
43
- #
44
- # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
45
- # API.
40
+ # Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
41
+ # Datastore API.
46
42
  #
47
43
  # Operation: An Operation represents work being performed in the background.
48
44
  #
@@ -50,50 +46,40 @@ module Google
50
46
  # specified as a combination of kinds and namespaces (either or both of which
51
47
  # may be all).
52
48
  #
53
- # -----------------------------------------------------------------------------
54
- # ## Services
55
- #
56
- # # Export/Import
49
+ # Export/Import Service:
57
50
  #
58
- # The Export/Import service provides the ability to copy all or a subset of
51
+ # - The Export/Import service provides the ability to copy all or a subset of
59
52
  # entities to/from Google Cloud Storage.
60
- #
61
- # Exported data may be imported into Cloud Datastore for any Google Cloud
53
+ # - Exported data may be imported into Cloud Datastore for any Google Cloud
62
54
  # Platform project. It is not restricted to the export source project. It is
63
55
  # possible to export from one project and then import into another.
64
- #
65
- # Exported data can also be loaded into Google BigQuery for analysis.
66
- #
67
- # Exports and imports are performed asynchronously. An Operation resource is
56
+ # - Exported data can also be loaded into Google BigQuery for analysis.
57
+ # - Exports and imports are performed asynchronously. An Operation resource is
68
58
  # created for each export/import. The state (including any errors encountered)
69
59
  # of the export/import may be queried via the Operation resource.
70
60
  #
71
- # # Index
61
+ # Index Service:
72
62
  #
73
- # The index service manages Cloud Datastore composite indexes.
74
- #
75
- # Index creation and deletion are performed asynchronously.
63
+ # - The index service manages Cloud Datastore composite indexes.
64
+ # - Index creation and deletion are performed asynchronously.
76
65
  # An Operation resource is created for each such asynchronous operation.
77
66
  # The state of the operation (including any errors encountered)
78
67
  # may be queried via the Operation resource.
79
68
  #
80
- # # Operation
69
+ # Operation Service:
81
70
  #
82
- # The Operations collection provides a record of actions performed for the
71
+ # - The Operations collection provides a record of actions performed for the
83
72
  # specified project (including any operations in progress). Operations are not
84
73
  # created directly but through calls on other collections or resources.
85
- #
86
- # An operation that is not yet done may be cancelled. The request to cancel is
87
- # asynchronous and the operation may continue to run for some time after the
74
+ # - An operation that is not yet done may be cancelled. The request to cancel
75
+ # is asynchronous and the operation may continue to run for some time after the
88
76
  # request to cancel is made.
89
- #
90
- # An operation that is done may be deleted so that it is no longer listed as
77
+ # - An operation that is done may be deleted so that it is no longer listed as
91
78
  # part of the Operation collection.
92
- #
93
- # ListOperations returns all pending operations, but not completed operations.
94
- #
95
- # Operations are created by service DatastoreAdmin,
96
- # but are accessed via service google.longrunning.Operations.
79
+ # - ListOperations returns all pending operations, but not completed
80
+ # operations.
81
+ # - Operations are created by service DatastoreAdmin, but are accessed via
82
+ # service google.longrunning.Operations.
97
83
  #
98
84
  # @example Load this service and instantiate a gRPC client
99
85
  #
@@ -22,7 +22,7 @@ module Google
22
22
  module Datastore
23
23
  module Admin
24
24
  module V1
25
- VERSION = "0.9.0"
25
+ VERSION = "0.10.0"
26
26
  end
27
27
  end
28
28
  end
@@ -27,14 +27,10 @@ module Google
27
27
  module DatastoreAdmin
28
28
  # Google Cloud Datastore Admin API
29
29
  #
30
- #
31
30
  # The Datastore Admin API provides several admin services for Cloud Datastore.
32
31
  #
33
- # -----------------------------------------------------------------------------
34
- # ## Concepts
35
- #
36
- # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
37
- # API.
32
+ # Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
33
+ # Datastore API.
38
34
  #
39
35
  # Operation: An Operation represents work being performed in the background.
40
36
  #
@@ -42,50 +38,40 @@ module Google
42
38
  # specified as a combination of kinds and namespaces (either or both of which
43
39
  # may be all).
44
40
  #
45
- # -----------------------------------------------------------------------------
46
- # ## Services
47
- #
48
- # # Export/Import
41
+ # Export/Import Service:
49
42
  #
50
- # The Export/Import service provides the ability to copy all or a subset of
43
+ # - The Export/Import service provides the ability to copy all or a subset of
51
44
  # entities to/from Google Cloud Storage.
52
- #
53
- # Exported data may be imported into Cloud Datastore for any Google Cloud
45
+ # - Exported data may be imported into Cloud Datastore for any Google Cloud
54
46
  # Platform project. It is not restricted to the export source project. It is
55
47
  # possible to export from one project and then import into another.
56
- #
57
- # Exported data can also be loaded into Google BigQuery for analysis.
58
- #
59
- # Exports and imports are performed asynchronously. An Operation resource is
48
+ # - Exported data can also be loaded into Google BigQuery for analysis.
49
+ # - Exports and imports are performed asynchronously. An Operation resource is
60
50
  # created for each export/import. The state (including any errors encountered)
61
51
  # of the export/import may be queried via the Operation resource.
62
52
  #
63
- # # Index
53
+ # Index Service:
64
54
  #
65
- # The index service manages Cloud Datastore composite indexes.
66
- #
67
- # Index creation and deletion are performed asynchronously.
55
+ # - The index service manages Cloud Datastore composite indexes.
56
+ # - Index creation and deletion are performed asynchronously.
68
57
  # An Operation resource is created for each such asynchronous operation.
69
58
  # The state of the operation (including any errors encountered)
70
59
  # may be queried via the Operation resource.
71
60
  #
72
- # # Operation
61
+ # Operation Service:
73
62
  #
74
- # The Operations collection provides a record of actions performed for the
63
+ # - The Operations collection provides a record of actions performed for the
75
64
  # specified project (including any operations in progress). Operations are not
76
65
  # created directly but through calls on other collections or resources.
77
- #
78
- # An operation that is not yet done may be cancelled. The request to cancel is
79
- # asynchronous and the operation may continue to run for some time after the
66
+ # - An operation that is not yet done may be cancelled. The request to cancel
67
+ # is asynchronous and the operation may continue to run for some time after the
80
68
  # request to cancel is made.
81
- #
82
- # An operation that is done may be deleted so that it is no longer listed as
69
+ # - An operation that is done may be deleted so that it is no longer listed as
83
70
  # part of the Operation collection.
84
- #
85
- # ListOperations returns all pending operations, but not completed operations.
86
- #
87
- # Operations are created by service DatastoreAdmin,
88
- # but are accessed via service google.longrunning.Operations.
71
+ # - ListOperations returns all pending operations, but not completed
72
+ # operations.
73
+ # - Operations are created by service DatastoreAdmin, but are accessed via
74
+ # service google.longrunning.Operations.
89
75
  class Service
90
76
 
91
77
  include ::GRPC::GenericService
@@ -111,9 +97,9 @@ module Google
111
97
  rpc :ImportEntities, ::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, ::Google::Longrunning::Operation
112
98
  # Creates the specified index.
113
99
  # A newly created index's initial state is `CREATING`. On completion of the
114
- # returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
115
- # If the index already exists, the call will return an `ALREADY_EXISTS`
116
- # status.
100
+ # returned [google.longrunning.Operation][google.longrunning.Operation], the
101
+ # state will be `READY`. If the index already exists, the call will return an
102
+ # `ALREADY_EXISTS` status.
117
103
  #
118
104
  # During index creation, the process could result in an error, in which
119
105
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -128,7 +114,8 @@ module Google
128
114
  # An index can only be deleted if it is in a `READY` or `ERROR` state. On
129
115
  # successful execution of the request, the index will be in a `DELETING`
130
116
  # [state][google.datastore.admin.v1.Index.State]. And on completion of the
131
- # returned [google.longrunning.Operation][google.longrunning.Operation], the index will be removed.
117
+ # returned [google.longrunning.Operation][google.longrunning.Operation], the
118
+ # index will be removed.
132
119
  #
133
120
  # During index deletion, the process could result in an error, in which
134
121
  # case the index will move to the `ERROR` state. The process can be recovered
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
@@ -123,8 +123,8 @@ module Google
123
123
  #
124
124
  # The resulting files will be nested deeper than the specified URL prefix.
125
125
  # The final output URL will be provided in the
126
- # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field. That
127
- # value should be used for subsequent ImportEntities operations.
126
+ # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}
127
+ # field. That value should be used for subsequent ImportEntities operations.
128
128
  #
129
129
  # By nesting the data files deeper, the same Cloud Storage bucket can be used
130
130
  # in multiple ExportEntities operations without conflict.
@@ -152,8 +152,9 @@ module Google
152
152
  # Client-assigned labels.
153
153
  # @!attribute [rw] input_url
154
154
  # @return [::String]
155
- # Required. The full resource URL of the external storage location. Currently, only
156
- # Google Cloud Storage is supported. So input_url should be of the form:
155
+ # Required. The full resource URL of the external storage location.
156
+ # Currently, only Google Cloud Storage is supported. So input_url should be
157
+ # of the form:
157
158
  # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
158
159
  # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
159
160
  # an optional Cloud Storage namespace path (this is not a Cloud Datastore
@@ -239,7 +240,9 @@ module Google
239
240
  # @!attribute [rw] input_url
240
241
  # @return [::String]
241
242
  # The location of the import metadata file. This will be the same value as
242
- # the {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field.
243
+ # the
244
+ # {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}
245
+ # field.
243
246
  class ImportEntitiesMetadata
244
247
  include ::Google::Protobuf::MessageExts
245
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -308,7 +311,8 @@ module Google
308
311
  extend ::Google::Protobuf::MessageExts::ClassMethods
309
312
  end
310
313
 
311
- # The request for {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#get_index google.datastore.admin.v1.DatastoreAdmin.GetIndex}.
314
+ # The request for
315
+ # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#get_index google.datastore.admin.v1.DatastoreAdmin.GetIndex}.
312
316
  # @!attribute [rw] project_id
313
317
  # @return [::String]
314
318
  # Project ID against which to make the request.
@@ -34,10 +34,15 @@ module Google
34
34
  # Required. The entity kind to which this index applies.
35
35
  # @!attribute [rw] ancestor
36
36
  # @return [::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode]
37
- # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
37
+ # Required. The index's ancestor mode. Must not be
38
+ # ANCESTOR_MODE_UNSPECIFIED.
38
39
  # @!attribute [rw] properties
39
40
  # @return [::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>]
40
41
  # Required. An ordered sequence of property names and their index attributes.
42
+ #
43
+ # Requires:
44
+ #
45
+ # * A maximum of 100 properties.
41
46
  # @!attribute [r] state
42
47
  # @return [::Google::Cloud::Datastore::Admin::V1::Index::State]
43
48
  # Output only. The state of the index.
@@ -51,7 +56,8 @@ module Google
51
56
  # Required. The property name to index.
52
57
  # @!attribute [rw] direction
53
58
  # @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
54
- # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.
59
+ # Required. The indexed property's direction. Must not be
60
+ # DIRECTION_UNSPECIFIED.
55
61
  class IndexedProperty
56
62
  include ::Google::Protobuf::MessageExts
57
63
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-datastore-admin-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-06 00:00:00.000000000 Z
11
+ date: 2023-09-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.20.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.20.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
219
219
  - !ruby/object:Gem::Version
220
220
  version: '0'
221
221
  requirements: []
222
- rubygems_version: 3.4.2
222
+ rubygems_version: 3.4.19
223
223
  signing_key:
224
224
  specification_version: 4
225
225
  summary: Accesses the schemaless NoSQL database to provide fully managed, robust,