google-cloud-workflows-executions-v1beta 0.3.4 → 0.4.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: 9afa870e438eec10b4d665e815b52e89a028b0718a9c8612852d4d5ab5a5c26b
4
- data.tar.gz: b0a8460f7d507da2530191d011e42110d47b3a2981f5cb100b740c8d9c2dabbd
3
+ metadata.gz: ccd46710f4c1c966d7b180691e77e2344480391dd7eed9ef70e33092f10723bb
4
+ data.tar.gz: 8e48273816153c3aa39f6cf0955e4683e386934ba42012c9acf33ee18dde2f35
5
5
  SHA512:
6
- metadata.gz: 89b1932ccc68b80c1af0f4744df9c16a489031f6ce52d24cde09940736c8dbbd759c1c0c7ba4eaa62046a1a60066d19a4d67b6308448349b2bb176dae2d122ee
7
- data.tar.gz: c9f210b2d91aea4273228f89c3a22cc9a05d65e5fa30c1051cac4dd80ee1e4e5e64224a067c87fd1e5eb881c51ed3f44f83be8573bece96fc672e6b98a71997b
6
+ metadata.gz: 8ed8148bdceda36e94b930a8afee42160861dd27c03cecc996c38fa90f9048feee2b7326c69f8e58790fdb014fbe440813d701275e38270b360d0a78109975f8
7
+ data.tar.gz: 76add0f12f103f8e21c1e9027946a8cd6923f955d05e6483b697ced2fdd250ff2d5c20cb2a8b1ff9e486417ebee5ff91d748bd0fddd772f47422a6f2d425e49c
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Workflows Executions V1beta API
2
+ --title="Workflows Executions V1beta API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -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
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest.
37
37
  response = client.list_executions request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-workflows-executions-v1beta/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1beta/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/workflows/)
@@ -69,16 +69,21 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
- This library is supported on Ruby 2.5+.
79
+ This library is supported on Ruby 2.6+.
75
80
 
76
81
  Google provides official support for Ruby versions that are actively supported
77
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
78
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
79
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
80
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
81
- about the Ruby support schedule.
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
82
87
 
83
88
  ## Which client should I use?
84
89
 
@@ -194,6 +194,27 @@ module Google
194
194
  #
195
195
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
196
196
  #
197
+ # @example Basic example
198
+ # require "google/cloud/workflows/executions/v1beta"
199
+ #
200
+ # # Create a client object. The client can be reused for multiple calls.
201
+ # client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
202
+ #
203
+ # # Create a request. To set request fields, pass in keyword arguments.
204
+ # request = Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest.new
205
+ #
206
+ # # Call the list_executions method.
207
+ # result = client.list_executions request
208
+ #
209
+ # # The returned object is of type Gapic::PagedEnumerable. You can
210
+ # # iterate over all elements by calling #each, and the enumerable
211
+ # # will lazily make API calls to fetch subsequent pages. Other
212
+ # # methods are also available for managing paging directly.
213
+ # result.each do |response|
214
+ # # Each element is of type ::Google::Cloud::Workflows::Executions::V1beta::Execution.
215
+ # p response
216
+ # end
217
+ #
197
218
  def list_executions request, options = nil
198
219
  raise ::ArgumentError, "request must be provided" if request.nil?
199
220
 
@@ -211,9 +232,11 @@ module Google
211
232
  gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
212
233
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
213
234
 
214
- header_params = {
215
- "parent" => request.parent
216
- }
235
+ header_params = {}
236
+ if request.parent
237
+ header_params["parent"] = request.parent
238
+ end
239
+
217
240
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
218
241
  metadata[:"x-goog-request-params"] ||= request_params_header
219
242
 
@@ -267,6 +290,21 @@ module Google
267
290
  #
268
291
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
269
292
  #
293
+ # @example Basic example
294
+ # require "google/cloud/workflows/executions/v1beta"
295
+ #
296
+ # # Create a client object. The client can be reused for multiple calls.
297
+ # client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
298
+ #
299
+ # # Create a request. To set request fields, pass in keyword arguments.
300
+ # request = Google::Cloud::Workflows::Executions::V1beta::CreateExecutionRequest.new
301
+ #
302
+ # # Call the create_execution method.
303
+ # result = client.create_execution request
304
+ #
305
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
306
+ # p result
307
+ #
270
308
  def create_execution request, options = nil
271
309
  raise ::ArgumentError, "request must be provided" if request.nil?
272
310
 
@@ -284,9 +322,11 @@ module Google
284
322
  gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
285
323
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
286
324
 
287
- header_params = {
288
- "parent" => request.parent
289
- }
325
+ header_params = {}
326
+ if request.parent
327
+ header_params["parent"] = request.parent
328
+ end
329
+
290
330
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
291
331
  metadata[:"x-goog-request-params"] ||= request_params_header
292
332
 
@@ -340,6 +380,21 @@ module Google
340
380
  #
341
381
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
342
382
  #
383
+ # @example Basic example
384
+ # require "google/cloud/workflows/executions/v1beta"
385
+ #
386
+ # # Create a client object. The client can be reused for multiple calls.
387
+ # client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
388
+ #
389
+ # # Create a request. To set request fields, pass in keyword arguments.
390
+ # request = Google::Cloud::Workflows::Executions::V1beta::GetExecutionRequest.new
391
+ #
392
+ # # Call the get_execution method.
393
+ # result = client.get_execution request
394
+ #
395
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
396
+ # p result
397
+ #
343
398
  def get_execution request, options = nil
344
399
  raise ::ArgumentError, "request must be provided" if request.nil?
345
400
 
@@ -357,9 +412,11 @@ module Google
357
412
  gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
358
413
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
359
414
 
360
- header_params = {
361
- "name" => request.name
362
- }
415
+ header_params = {}
416
+ if request.name
417
+ header_params["name"] = request.name
418
+ end
419
+
363
420
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
364
421
  metadata[:"x-goog-request-params"] ||= request_params_header
365
422
 
@@ -410,6 +467,21 @@ module Google
410
467
  #
411
468
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
412
469
  #
470
+ # @example Basic example
471
+ # require "google/cloud/workflows/executions/v1beta"
472
+ #
473
+ # # Create a client object. The client can be reused for multiple calls.
474
+ # client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
475
+ #
476
+ # # Create a request. To set request fields, pass in keyword arguments.
477
+ # request = Google::Cloud::Workflows::Executions::V1beta::CancelExecutionRequest.new
478
+ #
479
+ # # Call the cancel_execution method.
480
+ # result = client.cancel_execution request
481
+ #
482
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
483
+ # p result
484
+ #
413
485
  def cancel_execution request, options = nil
414
486
  raise ::ArgumentError, "request must be provided" if request.nil?
415
487
 
@@ -427,9 +499,11 @@ module Google
427
499
  gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
428
500
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
429
501
 
430
- header_params = {
431
- "name" => request.name
432
- }
502
+ header_params = {}
503
+ if request.name
504
+ header_params["name"] = request.name
505
+ end
506
+
433
507
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
434
508
  metadata[:"x-goog-request-params"] ||= request_params_header
435
509
 
@@ -8,6 +8,7 @@ require 'google/api/client_pb'
8
8
  require 'google/api/field_behavior_pb'
9
9
  require 'google/api/resource_pb'
10
10
  require 'google/protobuf/timestamp_pb'
11
+
11
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
13
  add_file("google/cloud/workflows/executions/v1beta/executions.proto", :syntax => :proto3) do
13
14
  add_message "google.cloud.workflows.executions.v1beta.Execution" do
@@ -29,7 +29,7 @@ module Google
29
29
  # [Workflows][google.cloud.workflows.v1beta.Workflow] called executions.
30
30
  class Service
31
31
 
32
- include GRPC::GenericService
32
+ include ::GRPC::GenericService
33
33
 
34
34
  self.marshal_class_method = :encode
35
35
  self.unmarshal_class_method = :decode
@@ -22,7 +22,7 @@ module Google
22
22
  module Workflows
23
23
  module Executions
24
24
  module V1beta
25
- VERSION = "0.3.4"
25
+ VERSION = "0.4.0"
26
26
  end
27
27
  end
28
28
  end
@@ -26,6 +26,8 @@ module Google
26
26
  ##
27
27
  # To load this package, including all its services, and instantiate a client:
28
28
  #
29
+ # @example
30
+ #
29
31
  # require "google/cloud/workflows/executions/v1beta"
30
32
  # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
31
33
  #
@@ -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-workflows-executions-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.4
4
+ version: 0.4.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: 2021-08-30 00:00:00.000000000 Z
11
+ date: 2022-07-08 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.7'
19
+ version: '0.10'
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.7'
29
+ version: '0.10'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,28 +50,28 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: 1.25.1
53
+ version: 1.26.1
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 1.25.1
60
+ version: 1.26.1
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: minitest
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: '5.14'
67
+ version: '5.16'
68
68
  type: :development
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: '5.14'
74
+ version: '5.16'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: minitest-focus
77
77
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
106
106
  requirements:
107
107
  - - ">="
108
108
  - !ruby/object:Gem::Version
109
- version: '12.0'
109
+ version: '13.0'
110
110
  type: :development
111
111
  prerelease: false
112
112
  version_requirements: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - ">="
115
115
  - !ruby/object:Gem::Version
116
- version: '12.0'
116
+ version: '13.0'
117
117
  - !ruby/object:Gem::Dependency
118
118
  name: redcarpet
119
119
  requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
198
198
  requirements:
199
199
  - - ">="
200
200
  - !ruby/object:Gem::Version
201
- version: '2.5'
201
+ version: '2.6'
202
202
  required_rubygems_version: !ruby/object:Gem::Requirement
203
203
  requirements:
204
204
  - - ">="
205
205
  - !ruby/object:Gem::Version
206
206
  version: '0'
207
207
  requirements: []
208
- rubygems_version: 3.2.17
208
+ rubygems_version: 3.3.14
209
209
  signing_key:
210
210
  specification_version: 4
211
211
  summary: API Client library for the Workflows Executions V1beta API