google-cloud-eventarc-v1 0.1.0 → 0.1.4

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: 84c602a953dd4ef352c01e2f4f41262e4bf33becf805add3990ee6898e2711b4
4
- data.tar.gz: bb34d47c78eae0421c3749a5173264665e7297ad89095a4e427d7a33087b849c
3
+ metadata.gz: 8a4b946b32ecd93bad219a88770c02dd33844ad435ece41906c096a4564a8216
4
+ data.tar.gz: e7e8e52e5dcf6a0cf3121daf43d3896f60a5ace93ee504a3afd28e26a121ef2b
5
5
  SHA512:
6
- metadata.gz: 95df536fa1738fee8d697e7771f1cf247b974f8276f062aea738857460affb335642c454b2a319299bd36d2395af84eb28b5b8889118691d5cbc1ea903702358
7
- data.tar.gz: 053121b65548dd3c02e1babafbfad89874424679bb548470d0667775dc20cd8ddb352a5fc96db28bb9f950d95b6f16677276cae84abdaccd59d86711e7a37c21
6
+ metadata.gz: e235ea079e62ee8b7a99c4c98f9c7979beeb3351c2b223638b927f263d887830f1f74521612760e812e871f4884466f0a16c025296292f77c32e65b6a3d2ce76
7
+ data.tar.gz: 3a69360681d720bf45d7001cc60796427cd6c4188835e49ce9558335fbc427c9011fcf2d90e94fc674ba494071081cd46e3e625006ac489f8288229f343b159a
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Eventarc V1 API
2
+ --title="Eventarc 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-eventarc-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Eventarc::V1::Eventarc::Credentials}):
68
68
 
69
- 1. `EVENTARC_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `EVENTARC_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
+ * `EVENTARC_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `EVENTARC_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/eventarc/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Eventarc::V1::Eventarc::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/eventarc/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Eventarc::V1::Eventarc::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/eventarc/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/eventarc/v1"
34
34
 
35
35
  client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Eventarc::V1::GetTriggerRequest.new # (request fields as keyword arguments...)
37
37
  response = client.get_trigger request
38
38
  ```
39
39
 
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::Eventarc::V1::Eventarc::Client::Configuration}
43
43
  # for a description of the configuration fields.
44
44
  #
45
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all Eventarc clients:
48
- #
49
- # ::Google::Cloud::Eventarc::V1::Eventarc::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all Eventarc clients
48
+ # ::Google::Cloud::Eventarc::V1::Eventarc::Client.configure do |config|
49
+ # config.timeout = 10.0
50
+ # end
52
51
  #
53
52
  # @yield [config] Configure the Client client.
54
53
  # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
95
94
  ##
96
95
  # Create a new Eventarc client object.
97
96
  #
98
- # ## Examples
99
- #
100
- # To create a new Eventarc client with the default
101
- # configuration:
102
- #
103
- # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new
97
+ # @example
104
98
  #
105
- # To create a new Eventarc client with a custom
106
- # configuration:
99
+ # # Create a client using the default configuration
100
+ # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new
107
101
  #
108
- # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new do |config|
109
- # config.timeout = 10.0
110
- # end
102
+ # # Create a client using a custom configuration
103
+ # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new do |config|
104
+ # config.timeout = 10.0
105
+ # end
111
106
  #
112
107
  # @yield [config] Configure the Eventarc client.
113
108
  # @yieldparam config [Client::Configuration]
@@ -127,14 +122,13 @@ module Google
127
122
 
128
123
  # Create credentials
129
124
  credentials = @config.credentials
130
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
125
+ # Use self-signed JWT if the endpoint is unchanged from default,
131
126
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
133
- @config.endpoint == Client.configure.endpoint &&
127
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
134
128
  !@config.endpoint.split(".").first.include?("-")
135
129
  credentials ||= Credentials.default scope: @config.scope,
136
130
  enable_self_signed_jwt: enable_self_signed_jwt
137
- if credentials.is_a?(String) || credentials.is_a?(Hash)
131
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
138
132
  credentials = Credentials.new credentials, scope: @config.scope
139
133
  end
140
134
  @quota_project_id = @config.quota_project
@@ -142,6 +136,7 @@ module Google
142
136
 
143
137
  @operations_client = Operations.new do |config|
144
138
  config.credentials = credentials
139
+ config.quota_project = @quota_project_id
145
140
  config.endpoint = @config.endpoint
146
141
  end
147
142
 
@@ -192,6 +187,21 @@ module Google
192
187
  #
193
188
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
194
189
  #
190
+ # @example Basic example
191
+ # require "google/cloud/eventarc/v1"
192
+ #
193
+ # # Create a client object. The client can be reused for multiple calls.
194
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Client.new
195
+ #
196
+ # # Create a request. To set request fields, pass in keyword arguments.
197
+ # request = Google::Cloud::Eventarc::V1::GetTriggerRequest.new
198
+ #
199
+ # # Call the get_trigger method.
200
+ # result = client.get_trigger request
201
+ #
202
+ # # The returned object is of type Google::Cloud::Eventarc::V1::Trigger.
203
+ # p result
204
+ #
195
205
  def get_trigger request, options = nil
196
206
  raise ::ArgumentError, "request must be provided" if request.nil?
197
207
 
@@ -209,16 +219,20 @@ module Google
209
219
  gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
210
220
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
211
221
 
212
- header_params = {
213
- "name" => request.name
214
- }
222
+ header_params = {}
223
+ if request.name
224
+ header_params["name"] = request.name
225
+ end
226
+
215
227
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
216
228
  metadata[:"x-goog-request-params"] ||= request_params_header
217
229
 
218
230
  options.apply_defaults timeout: @config.rpcs.get_trigger.timeout,
219
231
  metadata: metadata,
220
232
  retry_policy: @config.rpcs.get_trigger.retry_policy
221
- options.apply_defaults metadata: @config.metadata,
233
+
234
+ options.apply_defaults timeout: @config.timeout,
235
+ metadata: @config.metadata,
222
236
  retry_policy: @config.retry_policy
223
237
 
224
238
  @eventarc_stub.call_rpc :get_trigger, request, options: options do |response, operation|
@@ -272,6 +286,27 @@ module Google
272
286
  #
273
287
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
274
288
  #
289
+ # @example Basic example
290
+ # require "google/cloud/eventarc/v1"
291
+ #
292
+ # # Create a client object. The client can be reused for multiple calls.
293
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Client.new
294
+ #
295
+ # # Create a request. To set request fields, pass in keyword arguments.
296
+ # request = Google::Cloud::Eventarc::V1::ListTriggersRequest.new
297
+ #
298
+ # # Call the list_triggers method.
299
+ # result = client.list_triggers request
300
+ #
301
+ # # The returned object is of type Gapic::PagedEnumerable. You can
302
+ # # iterate over all elements by calling #each, and the enumerable
303
+ # # will lazily make API calls to fetch subsequent pages. Other
304
+ # # methods are also available for managing paging directly.
305
+ # result.each do |response|
306
+ # # Each element is of type ::Google::Cloud::Eventarc::V1::Trigger.
307
+ # p response
308
+ # end
309
+ #
275
310
  def list_triggers request, options = nil
276
311
  raise ::ArgumentError, "request must be provided" if request.nil?
277
312
 
@@ -289,16 +324,20 @@ module Google
289
324
  gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
290
325
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
291
326
 
292
- header_params = {
293
- "parent" => request.parent
294
- }
327
+ header_params = {}
328
+ if request.parent
329
+ header_params["parent"] = request.parent
330
+ end
331
+
295
332
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
296
333
  metadata[:"x-goog-request-params"] ||= request_params_header
297
334
 
298
335
  options.apply_defaults timeout: @config.rpcs.list_triggers.timeout,
299
336
  metadata: metadata,
300
337
  retry_policy: @config.rpcs.list_triggers.retry_policy
301
- options.apply_defaults metadata: @config.metadata,
338
+
339
+ options.apply_defaults timeout: @config.timeout,
340
+ metadata: @config.metadata,
302
341
  retry_policy: @config.retry_policy
303
342
 
304
343
  @eventarc_stub.call_rpc :list_triggers, request, options: options do |response, operation|
@@ -346,6 +385,28 @@ module Google
346
385
  #
347
386
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
348
387
  #
388
+ # @example Basic example
389
+ # require "google/cloud/eventarc/v1"
390
+ #
391
+ # # Create a client object. The client can be reused for multiple calls.
392
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Client.new
393
+ #
394
+ # # Create a request. To set request fields, pass in keyword arguments.
395
+ # request = Google::Cloud::Eventarc::V1::CreateTriggerRequest.new
396
+ #
397
+ # # Call the create_trigger method.
398
+ # result = client.create_trigger request
399
+ #
400
+ # # The returned object is of type Gapic::Operation. You can use this
401
+ # # object to check the status of an operation, cancel it, or wait
402
+ # # for results. Here is how to block until completion:
403
+ # result.wait_until_done! timeout: 60
404
+ # if result.response?
405
+ # p result.response
406
+ # else
407
+ # puts "Error!"
408
+ # end
409
+ #
349
410
  def create_trigger request, options = nil
350
411
  raise ::ArgumentError, "request must be provided" if request.nil?
351
412
 
@@ -363,16 +424,20 @@ module Google
363
424
  gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
364
425
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
365
426
 
366
- header_params = {
367
- "parent" => request.parent
368
- }
427
+ header_params = {}
428
+ if request.parent
429
+ header_params["parent"] = request.parent
430
+ end
431
+
369
432
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
370
433
  metadata[:"x-goog-request-params"] ||= request_params_header
371
434
 
372
435
  options.apply_defaults timeout: @config.rpcs.create_trigger.timeout,
373
436
  metadata: metadata,
374
437
  retry_policy: @config.rpcs.create_trigger.retry_policy
375
- options.apply_defaults metadata: @config.metadata,
438
+
439
+ options.apply_defaults timeout: @config.timeout,
440
+ metadata: @config.metadata,
376
441
  retry_policy: @config.retry_policy
377
442
 
378
443
  @eventarc_stub.call_rpc :create_trigger, request, options: options do |response, operation|
@@ -423,6 +488,28 @@ module Google
423
488
  #
424
489
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
425
490
  #
491
+ # @example Basic example
492
+ # require "google/cloud/eventarc/v1"
493
+ #
494
+ # # Create a client object. The client can be reused for multiple calls.
495
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Client.new
496
+ #
497
+ # # Create a request. To set request fields, pass in keyword arguments.
498
+ # request = Google::Cloud::Eventarc::V1::UpdateTriggerRequest.new
499
+ #
500
+ # # Call the update_trigger method.
501
+ # result = client.update_trigger request
502
+ #
503
+ # # The returned object is of type Gapic::Operation. You can use this
504
+ # # object to check the status of an operation, cancel it, or wait
505
+ # # for results. Here is how to block until completion:
506
+ # result.wait_until_done! timeout: 60
507
+ # if result.response?
508
+ # p result.response
509
+ # else
510
+ # puts "Error!"
511
+ # end
512
+ #
426
513
  def update_trigger request, options = nil
427
514
  raise ::ArgumentError, "request must be provided" if request.nil?
428
515
 
@@ -440,16 +527,20 @@ module Google
440
527
  gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
441
528
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
442
529
 
443
- header_params = {
444
- "trigger.name" => request.trigger.name
445
- }
530
+ header_params = {}
531
+ if request.trigger&.name
532
+ header_params["trigger.name"] = request.trigger.name
533
+ end
534
+
446
535
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
447
536
  metadata[:"x-goog-request-params"] ||= request_params_header
448
537
 
449
538
  options.apply_defaults timeout: @config.rpcs.update_trigger.timeout,
450
539
  metadata: metadata,
451
540
  retry_policy: @config.rpcs.update_trigger.retry_policy
452
- options.apply_defaults metadata: @config.metadata,
541
+
542
+ options.apply_defaults timeout: @config.timeout,
543
+ metadata: @config.metadata,
453
544
  retry_policy: @config.retry_policy
454
545
 
455
546
  @eventarc_stub.call_rpc :update_trigger, request, options: options do |response, operation|
@@ -499,6 +590,28 @@ module Google
499
590
  #
500
591
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
501
592
  #
593
+ # @example Basic example
594
+ # require "google/cloud/eventarc/v1"
595
+ #
596
+ # # Create a client object. The client can be reused for multiple calls.
597
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Client.new
598
+ #
599
+ # # Create a request. To set request fields, pass in keyword arguments.
600
+ # request = Google::Cloud::Eventarc::V1::DeleteTriggerRequest.new
601
+ #
602
+ # # Call the delete_trigger method.
603
+ # result = client.delete_trigger request
604
+ #
605
+ # # The returned object is of type Gapic::Operation. You can use this
606
+ # # object to check the status of an operation, cancel it, or wait
607
+ # # for results. Here is how to block until completion:
608
+ # result.wait_until_done! timeout: 60
609
+ # if result.response?
610
+ # p result.response
611
+ # else
612
+ # puts "Error!"
613
+ # end
614
+ #
502
615
  def delete_trigger request, options = nil
503
616
  raise ::ArgumentError, "request must be provided" if request.nil?
504
617
 
@@ -516,16 +629,20 @@ module Google
516
629
  gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
517
630
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
518
631
 
519
- header_params = {
520
- "name" => request.name
521
- }
632
+ header_params = {}
633
+ if request.name
634
+ header_params["name"] = request.name
635
+ end
636
+
522
637
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
523
638
  metadata[:"x-goog-request-params"] ||= request_params_header
524
639
 
525
640
  options.apply_defaults timeout: @config.rpcs.delete_trigger.timeout,
526
641
  metadata: metadata,
527
642
  retry_policy: @config.rpcs.delete_trigger.retry_policy
528
- options.apply_defaults metadata: @config.metadata,
643
+
644
+ options.apply_defaults timeout: @config.timeout,
645
+ metadata: @config.metadata,
529
646
  retry_policy: @config.retry_policy
530
647
 
531
648
  @eventarc_stub.call_rpc :delete_trigger, request, options: options do |response, operation|
@@ -550,22 +667,21 @@ module Google
550
667
  # Configuration can be applied globally to all clients, or to a single client
551
668
  # on construction.
552
669
  #
553
- # # Examples
554
- #
555
- # To modify the global config, setting the timeout for get_trigger
556
- # to 20 seconds, and all remaining timeouts to 10 seconds:
557
- #
558
- # ::Google::Cloud::Eventarc::V1::Eventarc::Client.configure do |config|
559
- # config.timeout = 10.0
560
- # config.rpcs.get_trigger.timeout = 20.0
561
- # end
562
- #
563
- # To apply the above configuration only to a new client:
564
- #
565
- # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new do |config|
566
- # config.timeout = 10.0
567
- # config.rpcs.get_trigger.timeout = 20.0
568
- # end
670
+ # @example
671
+ #
672
+ # # Modify the global config, setting the timeout for
673
+ # # get_trigger to 20 seconds,
674
+ # # and all remaining timeouts to 10 seconds.
675
+ # ::Google::Cloud::Eventarc::V1::Eventarc::Client.configure do |config|
676
+ # config.timeout = 10.0
677
+ # config.rpcs.get_trigger.timeout = 20.0
678
+ # end
679
+ #
680
+ # # Apply the above configuration only to a new client.
681
+ # client = ::Google::Cloud::Eventarc::V1::Eventarc::Client.new do |config|
682
+ # config.timeout = 10.0
683
+ # config.rpcs.get_trigger.timeout = 20.0
684
+ # end
569
685
  #
570
686
  # @!attribute [rw] endpoint
571
687
  # 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::Eventarc::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::Eventarc::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::Eventarc::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::Eventarc::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.
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/eventarc/v1/eventarc.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/cloud/eventarc/v1/trigger_pb'
11
9
  require 'google/longrunning/operations_pb'
12
10
  require 'google/protobuf/field_mask_pb'
13
11
  require 'google/protobuf/timestamp_pb'
12
+ require 'google/protobuf'
13
+
14
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
15
15
  add_file("google/cloud/eventarc/v1/eventarc.proto", :syntax => :proto3) do
16
16
  add_message "google.cloud.eventarc.v1.GetTriggerRequest" do
@@ -28,7 +28,7 @@ module Google
28
28
  # Google Cloud services and forward them to supported destinations.
29
29
  class Service
30
30
 
31
- include GRPC::GenericService
31
+ include ::GRPC::GenericService
32
32
 
33
33
  self.marshal_class_method = :encode
34
34
  self.unmarshal_class_method = :decode
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/eventarc/v1/trigger.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/field_behavior_pb'
8
6
  require 'google/api/resource_pb'
9
7
  require 'google/protobuf/timestamp_pb'
8
+ require 'google/protobuf'
9
+
10
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/cloud/eventarc/v1/trigger.proto", :syntax => :proto3) do
12
12
  add_message "google.cloud.eventarc.v1.Trigger" do
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Eventarc
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.1.4"
25
25
  end
26
26
  end
27
27
  end
@@ -60,6 +60,12 @@ module Google
60
60
  # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-eventarc-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
@@ -213,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
213
213
  - !ruby/object:Gem::Version
214
214
  version: '0'
215
215
  requirements: []
216
- rubygems_version: 3.2.17
216
+ rubygems_version: 3.3.4
217
217
  signing_key:
218
218
  specification_version: 4
219
219
  summary: API Client library for the Eventarc V1 API