google-cloud-workflows-executions-v1beta 0.3.0 → 0.3.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.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +4 -4
  4. data/lib/google/cloud/workflows/executions/v1beta/executions/client.rb +42 -41
  5. data/lib/google/cloud/workflows/executions/v1beta/version.rb +1 -1
  6. data/proto_docs/google/api/field_behavior.rb +7 -1
  7. metadata +14 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 020ea97387391f824697564873313c9383c4cde3a4c33b5e419333f6fa17d72b
4
- data.tar.gz: 58e63cdc88979aba40915411173d119c5867ccf443a012d25ffdbaa73ed870d2
3
+ metadata.gz: 9afa870e438eec10b4d665e815b52e89a028b0718a9c8612852d4d5ab5a5c26b
4
+ data.tar.gz: b0a8460f7d507da2530191d011e42110d47b3a2981f5cb100b740c8d9c2dabbd
5
5
  SHA512:
6
- metadata.gz: 299a3a8a7f0ae88842288a4808b8dc485ce70715c1d8b9baa2c783d63de398f48208eadb5c03276a48a8969f5d754b9db8e98d61f57653d842d677dec6f55a56
7
- data.tar.gz: 540c5041489374f526856103660ff36bebecaac88272a4ca938944f6341310223e6c5d9eb34b80971996435948e4ec5bb87bf80aa00700e7df19d6e46ba731d2
6
+ metadata.gz: 89b1932ccc68b80c1af0f4744df9c16a489031f6ce52d24cde09940736c8dbbd759c1c0c7ba4eaa62046a1a60066d19a4d67b6308448349b2bb176dae2d122ee
7
+ data.tar.gz: c9f210b2d91aea4273228f89c3a22cc9a05d65e5fa30c1051cac4dd80ee1e4e5e64224a067c87fd1e5eb881c51ed3f44f83be8573bece96fc672e6b98a71997b
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-workflows-executions-v1beta
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Workflows::Executions::V1beta::Executions::Credentials}):
68
68
 
69
- 1. `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `WORKFLOWS_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
+ * `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `WORKFLOWS_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/workflows/executions/v1beta"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::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/workflows/executions/v1beta"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
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/workflows/executions/v1beta"
data/README.md CHANGED
@@ -9,7 +9,7 @@ https://github.com/googleapis/google-cloud-ruby
9
9
  This gem is a _versioned_ client. It provides basic client classes for a
10
10
  specific version of the Workflows Executions V1beta API. Most users should consider using
11
11
  the main client gem,
12
- [google-cloud-workflows-executions](https://rubygems.org/gems/google-cloud-workflows-executions).
12
+ [google-cloud-workflows](https://rubygems.org/gems/google-cloud-workflows).
13
13
  See the section below titled *Which client should I use?* for more information.
14
14
 
15
15
  ## Installation
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/workflows/executions/v1beta"
34
34
 
35
35
  client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest.new # (request fields as keyword arguments...)
37
37
  response = client.list_executions request
38
38
  ```
39
39
 
@@ -83,7 +83,7 @@ about the Ruby support schedule.
83
83
  ## Which client should I use?
84
84
 
85
85
  Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
- client library with a name such as `google-cloud-workflows-executions`,
86
+ client library with a name such as `google-cloud-workflows`,
87
87
  and lower-level _versioned_ client libraries with names such as
88
88
  `google-cloud-workflows-executions-v1beta`.
89
89
  _In most cases, you should install the main client._
@@ -110,7 +110,7 @@ service version.
110
110
 
111
111
  We recommend that most users install the main client gem for a service. You can
112
112
  identify this gem as the one _without_ a version in its name, e.g.
113
- `google-cloud-workflows-executions`.
113
+ `google-cloud-workflows`.
114
114
  The main client is recommended because it will embody the best practices for
115
115
  accessing the service, and may also provide more convenient interfaces or
116
116
  tighter integration into frameworks and third-party libraries. In addition, the
data/lib/google/cloud/workflows/executions/v1beta/executions/client.rb CHANGED
@@ -43,13 +43,12 @@ module Google
43
43
  # See {::Google::Cloud::Workflows::Executions::V1beta::Executions::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 Executions clients:
49
- #
50
- # ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
51
- # config.timeout = 10.0
52
- # end
48
+ # # Modify the configuration for all Executions clients
49
+ # ::Google::Cloud::Workflows::Executions::V1beta::Executions::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]
@@ -96,19 +95,15 @@ module Google
96
95
  ##
97
96
  # Create a new Executions client object.
98
97
  #
99
- # ## Examples
100
- #
101
- # To create a new Executions client with the default
102
- # configuration:
103
- #
104
- # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
98
+ # @example
105
99
  #
106
- # To create a new Executions client with a custom
107
- # configuration:
100
+ # # Create a client using the default configuration
101
+ # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
108
102
  #
109
- # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
110
- # config.timeout = 10.0
111
- # end
103
+ # # Create a client using a custom configuration
104
+ # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
105
+ # config.timeout = 10.0
106
+ # end
112
107
  #
113
108
  # @yield [config] Configure the Executions client.
114
109
  # @yieldparam config [Client::Configuration]
@@ -128,14 +123,13 @@ module Google
128
123
 
129
124
  # Create credentials
130
125
  credentials = @config.credentials
131
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
126
+ # Use self-signed JWT if the endpoint is unchanged from default,
132
127
  # but only if the default endpoint does not have a region prefix.
133
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
134
- @config.endpoint == Client.configure.endpoint &&
128
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
135
129
  !@config.endpoint.split(".").first.include?("-")
136
130
  credentials ||= Credentials.default scope: @config.scope,
137
131
  enable_self_signed_jwt: enable_self_signed_jwt
138
- if credentials.is_a?(String) || credentials.is_a?(Hash)
132
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
139
133
  credentials = Credentials.new credentials, scope: @config.scope
140
134
  end
141
135
  @quota_project_id = @config.quota_project
@@ -226,7 +220,9 @@ module Google
226
220
  options.apply_defaults timeout: @config.rpcs.list_executions.timeout,
227
221
  metadata: metadata,
228
222
  retry_policy: @config.rpcs.list_executions.retry_policy
229
- options.apply_defaults metadata: @config.metadata,
223
+
224
+ options.apply_defaults timeout: @config.timeout,
225
+ metadata: @config.metadata,
230
226
  retry_policy: @config.retry_policy
231
227
 
232
228
  @executions_stub.call_rpc :list_executions, request, options: options do |response, operation|
@@ -297,7 +293,9 @@ module Google
297
293
  options.apply_defaults timeout: @config.rpcs.create_execution.timeout,
298
294
  metadata: metadata,
299
295
  retry_policy: @config.rpcs.create_execution.retry_policy
300
- options.apply_defaults metadata: @config.metadata,
296
+
297
+ options.apply_defaults timeout: @config.timeout,
298
+ metadata: @config.metadata,
301
299
  retry_policy: @config.retry_policy
302
300
 
303
301
  @executions_stub.call_rpc :create_execution, request, options: options do |response, operation|
@@ -368,7 +366,9 @@ module Google
368
366
  options.apply_defaults timeout: @config.rpcs.get_execution.timeout,
369
367
  metadata: metadata,
370
368
  retry_policy: @config.rpcs.get_execution.retry_policy
371
- options.apply_defaults metadata: @config.metadata,
369
+
370
+ options.apply_defaults timeout: @config.timeout,
371
+ metadata: @config.metadata,
372
372
  retry_policy: @config.retry_policy
373
373
 
374
374
  @executions_stub.call_rpc :get_execution, request, options: options do |response, operation|
@@ -436,7 +436,9 @@ module Google
436
436
  options.apply_defaults timeout: @config.rpcs.cancel_execution.timeout,
437
437
  metadata: metadata,
438
438
  retry_policy: @config.rpcs.cancel_execution.retry_policy
439
- options.apply_defaults metadata: @config.metadata,
439
+
440
+ options.apply_defaults timeout: @config.timeout,
441
+ metadata: @config.metadata,
440
442
  retry_policy: @config.retry_policy
441
443
 
442
444
  @executions_stub.call_rpc :cancel_execution, request, options: options do |response, operation|
@@ -460,22 +462,21 @@ module Google
460
462
  # Configuration can be applied globally to all clients, or to a single client
461
463
  # on construction.
462
464
  #
463
- # # Examples
464
- #
465
- # To modify the global config, setting the timeout for list_executions
466
- # to 20 seconds, and all remaining timeouts to 10 seconds:
467
- #
468
- # ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
469
- # config.timeout = 10.0
470
- # config.rpcs.list_executions.timeout = 20.0
471
- # end
472
- #
473
- # To apply the above configuration only to a new client:
474
- #
475
- # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
476
- # config.timeout = 10.0
477
- # config.rpcs.list_executions.timeout = 20.0
478
- # end
465
+ # @example
466
+ #
467
+ # # Modify the global config, setting the timeout for
468
+ # # list_executions to 20 seconds,
469
+ # # and all remaining timeouts to 10 seconds.
470
+ # ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
471
+ # config.timeout = 10.0
472
+ # config.rpcs.list_executions.timeout = 20.0
473
+ # end
474
+ #
475
+ # # Apply the above configuration only to a new client.
476
+ # client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
477
+ # config.timeout = 10.0
478
+ # config.rpcs.list_executions.timeout = 20.0
479
+ # end
479
480
  #
480
481
  # @!attribute [rw] endpoint
481
482
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/workflows/executions/v1beta/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Workflows
23
23
  module Executions
24
24
  module V1beta
25
- VERSION = "0.3.0"
25
+ VERSION = "0.3.4"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
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
metadata CHANGED
@@ -1,29 +1,35 @@
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.0
4
+ version: 0.3.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-03-09 00:00:00.000000000 Z
11
+ date: 2021-08-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.7'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.7'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -156,8 +162,7 @@ description: Workflows link series of serverless tasks together in an order you
156
162
  Workflows requires no infrastructure management and scales seamlessly with demand,
157
163
  including scaling down to zero.. Note that google-cloud-workflows-executions-v1beta
158
164
  is a version-specific client library. For most uses, we recommend installing the
159
- main client library google-cloud-workflows-executions instead. See the readme for
160
- more details.
165
+ main client library google-cloud-workflows instead. See the readme for more details.
161
166
  email: googleapis-packages@google.com
162
167
  executables: []
163
168
  extensions: []
@@ -200,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
200
205
  - !ruby/object:Gem::Version
201
206
  version: '0'
202
207
  requirements: []
203
- rubygems_version: 3.2.13
208
+ rubygems_version: 3.2.17
204
209
  signing_key:
205
210
  specification_version: 4
206
211
  summary: API Client library for the Workflows Executions V1beta API