google-cloud-service_usage-v1 0.1.0 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1d5f5dc30edbbc2e13c09dfdf16a724123ecf7e02dd4af444e8694671d446b83
4
- data.tar.gz: bac490dab61bd19b601e9dd0d28624c39840f4201eb52959162f2fefb59b04a3
3
+ metadata.gz: 97543115b12a7b1664e9da0e5f1b36369e7dfb8e03a4f73f04b7f37a9fb6d8ae
4
+ data.tar.gz: 4f112cc20a7229094ff1434b32a84bb5edbe925d769d0f6866ef413da59d8689
5
5
  SHA512:
6
- metadata.gz: ad771b8a3a34ea8d70180bc30bed4f940f350e34587aaf98b610ea06a68b9b04bf4cf413594e781a5d0d2a53e24d9314db08dc5356f87dbe49d0362d07834cb3
7
- data.tar.gz: d9115bd8781d2ccc295832132675d84cc1ee073a262ed3358125128a5b6596022ffa35da883ea23291672ad05b894029881c8e66edd97c03ab699914cda634b6
6
+ metadata.gz: 0440a54967f1792ab3052b6462237f226bab5a63777211726032427e4313c58f924ffa8f0024d48c16777d1f53e797fac8b91f9dca725402a45956bdc5aaba4e
7
+ data.tar.gz: c537f5026f8a6db6e3a0eaab5b76752908c50ef6231a5ba94d9b5d7dc20206b859c572dde4a58fb1a386d67fb2082deddf811bf67875c8ed68ba5517cec8a14c
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Service Usage V1 API
2
+ --title="Service Usage V1 API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-service_usage-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::ServiceUsage::V1::ServiceUsage::Credentials}):
68
68
 
69
- 1. `SERVICE_USAGE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `SERVICE_USAGE_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `SERVICE_USAGE_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `SERVICE_USAGE_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/service_usage/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/service_usage/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/service_usage/v1"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
121
  *should* only be used during development.
122
122
 
123
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
- [dev-console]: https://console.cloud.google.com/project
125
-
126
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
-
128
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
-
132
123
  ## Creating a Service Account
133
124
 
134
125
  Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
139
130
  [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
131
  need a Google Developers service account.
141
132
 
142
- 1. Visit the [Google Developers Console][dev-console].
133
+ 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
143
134
  2. Create a new project or click on an existing project.
144
- 3. Activate the slide-out navigation tray and select **API Manager**. From
135
+ 3. Activate the menu in the upper left and select **APIs & Services**. From
145
136
  here, you will enable the APIs that your application requires.
146
137
 
147
- ![Enable the APIs that your application requires][enable-apis]
148
-
149
138
  *Note: You may need to enable billing in order to use these services.*
150
139
 
151
140
  4. Select **Credentials** from the side navigation.
152
141
 
153
- You should see a screen like one of the following.
154
-
155
- ![Create a new service account][create-new-service-account]
156
-
157
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
-
159
- Find the "Add credentials" drop down and select "Service account" to be
160
- guided through downloading a new JSON key file.
142
+ Find the "Create credentials" drop down near the top of the page, and select
143
+ "Service account" to be guided through downloading a new JSON key file.
161
144
 
162
145
  If you want to re-use an existing service account, you can easily generate a
163
- new key file. Just select the account you wish to re-use, and click "Generate
164
- new JSON key":
165
-
166
- ![Re-use an existing service account][reuse-service-account]
146
+ new key file. Just select the account you wish to re-use, click the pencil
147
+ tool on the right side to edit the service account, select the **Keys** tab,
148
+ and then select **Add Key**.
167
149
 
168
150
  The key file you download will be used by this library to authenticate API
169
151
  requests and should be stored in a secure location.
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/service_usage/v1"
34
34
 
35
35
  client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::ServiceUsage::V1::EnableServiceRequest.new # (request fields as keyword arguments...)
37
37
  response = client.enable_service request
38
38
  ```
39
39
 
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/api/serviceusage/v1/resources.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/auth_pb'
7
5
  require 'google/api/documentation_pb'
8
6
  require 'google/api/endpoint_pb'
@@ -12,6 +10,8 @@ require 'google/api/quota_pb'
12
10
  require 'google/api/usage_pb'
13
11
  require 'google/protobuf/api_pb'
14
12
  require 'google/api/annotations_pb'
13
+ require 'google/protobuf'
14
+
15
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  add_file("google/api/serviceusage/v1/resources.proto", :syntax => :proto3) do
17
17
  add_message "google.api.serviceusage.v1.Service" do
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/api/serviceusage/v1/serviceusage.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/serviceusage/v1/resources_pb'
8
6
  require 'google/longrunning/operations_pb'
9
7
  require 'google/api/client_pb'
8
+ require 'google/protobuf'
9
+
10
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/api/serviceusage/v1/serviceusage.proto", :syntax => :proto3) do
12
12
  add_message "google.api.serviceusage.v1.EnableServiceRequest" do
@@ -31,7 +31,7 @@ module Google
31
31
  # See [Service Usage API](https://cloud.google.com/service-usage/docs/overview)
32
32
  class Service
33
33
 
34
- include GRPC::GenericService
34
+ include ::GRPC::GenericService
35
35
 
36
36
  self.marshal_class_method = :encode
37
37
  self.unmarshal_class_method = :decode
@@ -43,13 +43,12 @@ module Google
43
43
  # See {::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client::Configuration}
44
44
  # for a description of the configuration fields.
45
45
  #
46
- # ## Example
46
+ # @example
47
47
  #
48
- # To modify the configuration for all ServiceUsage clients:
49
- #
50
- # ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.configure do |config|
51
- # config.timeout = 10.0
52
- # end
48
+ # # Modify the configuration for all ServiceUsage clients
49
+ # ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
53
52
  #
54
53
  # @yield [config] Configure the Client client.
55
54
  # @yieldparam config [Client::Configuration]
@@ -98,19 +97,15 @@ module Google
98
97
  ##
99
98
  # Create a new ServiceUsage client object.
100
99
  #
101
- # ## Examples
102
- #
103
- # To create a new ServiceUsage client with the default
104
- # configuration:
100
+ # @example
105
101
  #
106
- # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
102
+ # # Create a client using the default configuration
103
+ # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
107
104
  #
108
- # To create a new ServiceUsage client with a custom
109
- # configuration:
110
- #
111
- # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
112
- # config.timeout = 10.0
113
- # end
105
+ # # Create a client using a custom configuration
106
+ # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
107
+ # config.timeout = 10.0
108
+ # end
114
109
  #
115
110
  # @yield [config] Configure the ServiceUsage client.
116
111
  # @yieldparam config [Client::Configuration]
@@ -130,14 +125,13 @@ module Google
130
125
 
131
126
  # Create credentials
132
127
  credentials = @config.credentials
133
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
128
+ # Use self-signed JWT if the endpoint is unchanged from default,
134
129
  # but only if the default endpoint does not have a region prefix.
135
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
136
- @config.endpoint == Client.configure.endpoint &&
130
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
137
131
  !@config.endpoint.split(".").first.include?("-")
138
132
  credentials ||= Credentials.default scope: @config.scope,
139
133
  enable_self_signed_jwt: enable_self_signed_jwt
140
- if credentials.is_a?(String) || credentials.is_a?(Hash)
134
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
141
135
  credentials = Credentials.new credentials, scope: @config.scope
142
136
  end
143
137
  @quota_project_id = @config.quota_project
@@ -145,6 +139,7 @@ module Google
145
139
 
146
140
  @operations_client = Operations.new do |config|
147
141
  config.credentials = credentials
142
+ config.quota_project = @quota_project_id
148
143
  config.endpoint = @config.endpoint
149
144
  end
150
145
 
@@ -205,6 +200,28 @@ module Google
205
200
  #
206
201
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
207
202
  #
203
+ # @example Basic example
204
+ # require "google/cloud/service_usage/v1"
205
+ #
206
+ # # Create a client object. The client can be reused for multiple calls.
207
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
208
+ #
209
+ # # Create a request. To set request fields, pass in keyword arguments.
210
+ # request = Google::Cloud::ServiceUsage::V1::EnableServiceRequest.new
211
+ #
212
+ # # Call the enable_service method.
213
+ # result = client.enable_service request
214
+ #
215
+ # # The returned object is of type Gapic::Operation. You can use this
216
+ # # object to check the status of an operation, cancel it, or wait
217
+ # # for results. Here is how to block until completion:
218
+ # result.wait_until_done! timeout: 60
219
+ # if result.response?
220
+ # p result.response
221
+ # else
222
+ # puts "Error!"
223
+ # end
224
+ #
208
225
  def enable_service request, options = nil
209
226
  raise ::ArgumentError, "request must be provided" if request.nil?
210
227
 
@@ -222,16 +239,20 @@ module Google
222
239
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
223
240
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
224
241
 
225
- header_params = {
226
- "name" => request.name
227
- }
242
+ header_params = {}
243
+ if request.name
244
+ header_params["name"] = request.name
245
+ end
246
+
228
247
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
229
248
  metadata[:"x-goog-request-params"] ||= request_params_header
230
249
 
231
250
  options.apply_defaults timeout: @config.rpcs.enable_service.timeout,
232
251
  metadata: metadata,
233
252
  retry_policy: @config.rpcs.enable_service.retry_policy
234
- options.apply_defaults metadata: @config.metadata,
253
+
254
+ options.apply_defaults timeout: @config.timeout,
255
+ metadata: @config.metadata,
235
256
  retry_policy: @config.retry_policy
236
257
 
237
258
  @service_usage_stub.call_rpc :enable_service, request, options: options do |response, operation|
@@ -292,6 +313,28 @@ module Google
292
313
  #
293
314
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
294
315
  #
316
+ # @example Basic example
317
+ # require "google/cloud/service_usage/v1"
318
+ #
319
+ # # Create a client object. The client can be reused for multiple calls.
320
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
321
+ #
322
+ # # Create a request. To set request fields, pass in keyword arguments.
323
+ # request = Google::Cloud::ServiceUsage::V1::DisableServiceRequest.new
324
+ #
325
+ # # Call the disable_service method.
326
+ # result = client.disable_service request
327
+ #
328
+ # # The returned object is of type Gapic::Operation. You can use this
329
+ # # object to check the status of an operation, cancel it, or wait
330
+ # # for results. Here is how to block until completion:
331
+ # result.wait_until_done! timeout: 60
332
+ # if result.response?
333
+ # p result.response
334
+ # else
335
+ # puts "Error!"
336
+ # end
337
+ #
295
338
  def disable_service request, options = nil
296
339
  raise ::ArgumentError, "request must be provided" if request.nil?
297
340
 
@@ -309,16 +352,20 @@ module Google
309
352
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
310
353
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
311
354
 
312
- header_params = {
313
- "name" => request.name
314
- }
355
+ header_params = {}
356
+ if request.name
357
+ header_params["name"] = request.name
358
+ end
359
+
315
360
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
316
361
  metadata[:"x-goog-request-params"] ||= request_params_header
317
362
 
318
363
  options.apply_defaults timeout: @config.rpcs.disable_service.timeout,
319
364
  metadata: metadata,
320
365
  retry_policy: @config.rpcs.disable_service.retry_policy
321
- options.apply_defaults metadata: @config.metadata,
366
+
367
+ options.apply_defaults timeout: @config.timeout,
368
+ metadata: @config.metadata,
322
369
  retry_policy: @config.retry_policy
323
370
 
324
371
  @service_usage_stub.call_rpc :disable_service, request, options: options do |response, operation|
@@ -363,6 +410,21 @@ module Google
363
410
  #
364
411
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
365
412
  #
413
+ # @example Basic example
414
+ # require "google/cloud/service_usage/v1"
415
+ #
416
+ # # Create a client object. The client can be reused for multiple calls.
417
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
418
+ #
419
+ # # Create a request. To set request fields, pass in keyword arguments.
420
+ # request = Google::Cloud::ServiceUsage::V1::GetServiceRequest.new
421
+ #
422
+ # # Call the get_service method.
423
+ # result = client.get_service request
424
+ #
425
+ # # The returned object is of type Google::Cloud::ServiceUsage::V1::Service.
426
+ # p result
427
+ #
366
428
  def get_service request, options = nil
367
429
  raise ::ArgumentError, "request must be provided" if request.nil?
368
430
 
@@ -380,16 +442,20 @@ module Google
380
442
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
381
443
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
382
444
 
383
- header_params = {
384
- "name" => request.name
385
- }
445
+ header_params = {}
446
+ if request.name
447
+ header_params["name"] = request.name
448
+ end
449
+
386
450
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
387
451
  metadata[:"x-goog-request-params"] ||= request_params_header
388
452
 
389
453
  options.apply_defaults timeout: @config.rpcs.get_service.timeout,
390
454
  metadata: metadata,
391
455
  retry_policy: @config.rpcs.get_service.retry_policy
392
- options.apply_defaults metadata: @config.metadata,
456
+
457
+ options.apply_defaults timeout: @config.timeout,
458
+ metadata: @config.metadata,
393
459
  retry_policy: @config.retry_policy
394
460
 
395
461
  @service_usage_stub.call_rpc :get_service, request, options: options do |response, operation|
@@ -438,7 +504,7 @@ module Google
438
504
  # @param page_size [::Integer]
439
505
  # Requested size of the next page of data.
440
506
  # Requested page size cannot exceed 200.
441
- # If not set, the default page size is 50.
507
+ # If not set, the default page size is 50.
442
508
  # @param page_token [::String]
443
509
  # Token identifying which result to start with, which is returned by a
444
510
  # previous list call.
@@ -454,6 +520,27 @@ module Google
454
520
  #
455
521
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
456
522
  #
523
+ # @example Basic example
524
+ # require "google/cloud/service_usage/v1"
525
+ #
526
+ # # Create a client object. The client can be reused for multiple calls.
527
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
528
+ #
529
+ # # Create a request. To set request fields, pass in keyword arguments.
530
+ # request = Google::Cloud::ServiceUsage::V1::ListServicesRequest.new
531
+ #
532
+ # # Call the list_services method.
533
+ # result = client.list_services request
534
+ #
535
+ # # The returned object is of type Gapic::PagedEnumerable. You can
536
+ # # iterate over all elements by calling #each, and the enumerable
537
+ # # will lazily make API calls to fetch subsequent pages. Other
538
+ # # methods are also available for managing paging directly.
539
+ # result.each do |response|
540
+ # # Each element is of type ::Google::Cloud::ServiceUsage::V1::Service.
541
+ # p response
542
+ # end
543
+ #
457
544
  def list_services request, options = nil
458
545
  raise ::ArgumentError, "request must be provided" if request.nil?
459
546
 
@@ -471,16 +558,20 @@ module Google
471
558
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
472
559
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
473
560
 
474
- header_params = {
475
- "parent" => request.parent
476
- }
561
+ header_params = {}
562
+ if request.parent
563
+ header_params["parent"] = request.parent
564
+ end
565
+
477
566
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
478
567
  metadata[:"x-goog-request-params"] ||= request_params_header
479
568
 
480
569
  options.apply_defaults timeout: @config.rpcs.list_services.timeout,
481
570
  metadata: metadata,
482
571
  retry_policy: @config.rpcs.list_services.retry_policy
483
- options.apply_defaults metadata: @config.metadata,
572
+
573
+ options.apply_defaults timeout: @config.timeout,
574
+ metadata: @config.metadata,
484
575
  retry_policy: @config.retry_policy
485
576
 
486
577
  @service_usage_stub.call_rpc :list_services, request, options: options do |response, operation|
@@ -540,6 +631,28 @@ module Google
540
631
  #
541
632
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
542
633
  #
634
+ # @example Basic example
635
+ # require "google/cloud/service_usage/v1"
636
+ #
637
+ # # Create a client object. The client can be reused for multiple calls.
638
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
639
+ #
640
+ # # Create a request. To set request fields, pass in keyword arguments.
641
+ # request = Google::Cloud::ServiceUsage::V1::BatchEnableServicesRequest.new
642
+ #
643
+ # # Call the batch_enable_services method.
644
+ # result = client.batch_enable_services request
645
+ #
646
+ # # The returned object is of type Gapic::Operation. You can use this
647
+ # # object to check the status of an operation, cancel it, or wait
648
+ # # for results. Here is how to block until completion:
649
+ # result.wait_until_done! timeout: 60
650
+ # if result.response?
651
+ # p result.response
652
+ # else
653
+ # puts "Error!"
654
+ # end
655
+ #
543
656
  def batch_enable_services request, options = nil
544
657
  raise ::ArgumentError, "request must be provided" if request.nil?
545
658
 
@@ -557,16 +670,20 @@ module Google
557
670
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
558
671
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
559
672
 
560
- header_params = {
561
- "parent" => request.parent
562
- }
673
+ header_params = {}
674
+ if request.parent
675
+ header_params["parent"] = request.parent
676
+ end
677
+
563
678
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
564
679
  metadata[:"x-goog-request-params"] ||= request_params_header
565
680
 
566
681
  options.apply_defaults timeout: @config.rpcs.batch_enable_services.timeout,
567
682
  metadata: metadata,
568
683
  retry_policy: @config.rpcs.batch_enable_services.retry_policy
569
- options.apply_defaults metadata: @config.metadata,
684
+
685
+ options.apply_defaults timeout: @config.timeout,
686
+ metadata: @config.metadata,
570
687
  retry_policy: @config.retry_policy
571
688
 
572
689
  @service_usage_stub.call_rpc :batch_enable_services, request, options: options do |response, operation|
@@ -619,6 +736,21 @@ module Google
619
736
  #
620
737
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
621
738
  #
739
+ # @example Basic example
740
+ # require "google/cloud/service_usage/v1"
741
+ #
742
+ # # Create a client object. The client can be reused for multiple calls.
743
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
744
+ #
745
+ # # Create a request. To set request fields, pass in keyword arguments.
746
+ # request = Google::Cloud::ServiceUsage::V1::BatchGetServicesRequest.new
747
+ #
748
+ # # Call the batch_get_services method.
749
+ # result = client.batch_get_services request
750
+ #
751
+ # # The returned object is of type Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse.
752
+ # p result
753
+ #
622
754
  def batch_get_services request, options = nil
623
755
  raise ::ArgumentError, "request must be provided" if request.nil?
624
756
 
@@ -636,16 +768,20 @@ module Google
636
768
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
637
769
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
638
770
 
639
- header_params = {
640
- "parent" => request.parent
641
- }
771
+ header_params = {}
772
+ if request.parent
773
+ header_params["parent"] = request.parent
774
+ end
775
+
642
776
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
643
777
  metadata[:"x-goog-request-params"] ||= request_params_header
644
778
 
645
779
  options.apply_defaults timeout: @config.rpcs.batch_get_services.timeout,
646
780
  metadata: metadata,
647
781
  retry_policy: @config.rpcs.batch_get_services.retry_policy
648
- options.apply_defaults metadata: @config.metadata,
782
+
783
+ options.apply_defaults timeout: @config.timeout,
784
+ metadata: @config.metadata,
649
785
  retry_policy: @config.retry_policy
650
786
 
651
787
  @service_usage_stub.call_rpc :batch_get_services, request, options: options do |response, operation|
@@ -669,22 +805,21 @@ module Google
669
805
  # Configuration can be applied globally to all clients, or to a single client
670
806
  # on construction.
671
807
  #
672
- # # Examples
673
- #
674
- # To modify the global config, setting the timeout for enable_service
675
- # to 20 seconds, and all remaining timeouts to 10 seconds:
676
- #
677
- # ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.configure do |config|
678
- # config.timeout = 10.0
679
- # config.rpcs.enable_service.timeout = 20.0
680
- # end
681
- #
682
- # To apply the above configuration only to a new client:
683
- #
684
- # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
685
- # config.timeout = 10.0
686
- # config.rpcs.enable_service.timeout = 20.0
687
- # end
808
+ # @example
809
+ #
810
+ # # Modify the global config, setting the timeout for
811
+ # # enable_service to 20 seconds,
812
+ # # and all remaining timeouts to 10 seconds.
813
+ # ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.configure do |config|
814
+ # config.timeout = 10.0
815
+ # config.rpcs.enable_service.timeout = 20.0
816
+ # end
817
+ #
818
+ # # Apply the above configuration only to a new client.
819
+ # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
820
+ # config.timeout = 10.0
821
+ # config.rpcs.enable_service.timeout = 20.0
822
+ # end
688
823
  #
689
824
  # @!attribute [rw] endpoint
690
825
  # The hostname or hostname:port of the service endpoint.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,16 +181,20 @@ module Google
160
181
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
169
192
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
193
  metadata: metadata,
171
194
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
195
+
196
+ options.apply_defaults timeout: @config.timeout,
197
+ metadata: @config.metadata,
173
198
  retry_policy: @config.retry_policy
174
199
 
175
200
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
213
238
  #
214
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
216
263
  def get_operation request, options = nil
217
264
  raise ::ArgumentError, "request must be provided" if request.nil?
218
265
 
@@ -230,16 +277,20 @@ module Google
230
277
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
231
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
279
 
233
- header_params = {
234
- "name" => request.name
235
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
236
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
286
  metadata[:"x-goog-request-params"] ||= request_params_header
238
287
 
239
288
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
289
  metadata: metadata,
241
290
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
291
+
292
+ options.apply_defaults timeout: @config.timeout,
293
+ metadata: @config.metadata,
243
294
  retry_policy: @config.retry_policy
244
295
 
245
296
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
283
334
  #
284
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
285
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
286
352
  def delete_operation request, options = nil
287
353
  raise ::ArgumentError, "request must be provided" if request.nil?
288
354
 
@@ -300,16 +366,20 @@ module Google
300
366
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
301
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
302
368
 
303
- header_params = {
304
- "name" => request.name
305
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
306
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
307
375
  metadata[:"x-goog-request-params"] ||= request_params_header
308
376
 
309
377
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
378
  metadata: metadata,
311
379
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
380
+
381
+ options.apply_defaults timeout: @config.timeout,
382
+ metadata: @config.metadata,
313
383
  retry_policy: @config.retry_policy
314
384
 
315
385
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
358
428
  #
359
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
360
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
361
446
  def cancel_operation request, options = nil
362
447
  raise ::ArgumentError, "request must be provided" if request.nil?
363
448
 
@@ -375,16 +460,20 @@ module Google
375
460
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
376
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
462
 
378
- header_params = {
379
- "name" => request.name
380
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
381
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
382
469
  metadata[:"x-goog-request-params"] ||= request_params_header
383
470
 
384
471
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
472
  metadata: metadata,
386
473
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
388
477
  retry_policy: @config.retry_policy
389
478
 
390
479
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -436,6 +525,28 @@ module Google
436
525
  #
437
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
439
550
  def wait_operation request, options = nil
440
551
  raise ::ArgumentError, "request must be provided" if request.nil?
441
552
 
@@ -456,7 +567,9 @@ module Google
456
567
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
568
  metadata: metadata,
458
569
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
570
+
571
+ options.apply_defaults timeout: @config.timeout,
572
+ metadata: @config.metadata,
460
573
  retry_policy: @config.retry_policy
461
574
 
462
575
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
481
594
  # Configuration can be applied globally to all clients, or to a single client
482
595
  # on construction.
483
596
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
597
+ # @example
598
+ #
599
+ # # Modify the global config, setting the timeout for
600
+ # # list_operations to 20 seconds,
601
+ # # and all remaining timeouts to 10 seconds.
602
+ # ::Google::Longrunning::Operations::Client.configure do |config|
603
+ # config.timeout = 10.0
604
+ # config.rpcs.list_operations.timeout = 20.0
605
+ # end
606
+ #
607
+ # # Apply the above configuration only to a new client.
608
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
609
+ # config.timeout = 10.0
610
+ # config.rpcs.list_operations.timeout = 20.0
611
+ # end
500
612
  #
501
613
  # @!attribute [rw] endpoint
502
614
  # The hostname or hostname:port of the service endpoint.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceUsage
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.1.4"
25
25
  end
26
26
  end
27
27
  end
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
@@ -126,7 +126,7 @@ module Google
126
126
  # @return [::Integer]
127
127
  # Requested size of the next page of data.
128
128
  # Requested page size cannot exceed 200.
129
- # If not set, the default page size is 50.
129
+ # If not set, the default page size is 50.
130
130
  # @!attribute [rw] page_token
131
131
  # @return [::String]
132
132
  # Token identifying which result to start with, which is returned by a
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_usage-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-21 00:00:00.000000000 Z
11
+ date: 2022-01-11 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.5'
19
+ version: '0.7'
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.5'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
222
222
  - !ruby/object:Gem::Version
223
223
  version: '0'
224
224
  requirements: []
225
- rubygems_version: 3.2.17
225
+ rubygems_version: 3.3.4
226
226
  signing_key:
227
227
  specification_version: 4
228
228
  summary: API Client library for the Service Usage V1 API