google-cloud-workflows-executions-v1 0.4.0 → 0.6.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: 9001200b164299a0cf6f7de02899a2cc5c159bda9721a159668698accc91dc2b
4
- data.tar.gz: 6edce306b9aaf112a7f4b8dbf0bc01d1354b51fe83cac46e5c5cef048a3b3785
3
+ metadata.gz: 6ea6b3bcb519e08b0d5da26551bfa6c610fa0b677a17b090884345e7c5cb3d71
4
+ data.tar.gz: d381126032a08509420f813d1d6d5bad0e9938cb9e2062c505dfa7229ed7ab99
5
5
  SHA512:
6
- metadata.gz: 0f28ba4f9c902c338f0c1dd8d8bcc8c53cbc9200a1a8a1a892ebf277e9c3bb4b8531bc85651b012333a616bcd60ec343d1a5b91b238242deaf314f36d41d36fb
7
- data.tar.gz: 28f8052ab8030190e11c1b09672977e7357ee0d24d9a9962e1a0a2a1dc5537065c9b89237ac9d77e376dffc099bd44c9a79af94c66a3399b4b060edc814a9743
6
+ metadata.gz: 1791b6196f06437b20291a91f38e5896395db7074fc5940e90ea0ac3a3433b49467e198f44f256d536ce081a34dd3979019f5fb0977303d60d1f25e1c1fcb2c7
7
+ data.tar.gz: a1067052ace9dad20152e8a041409fc19845c05adb3198e83d699ccd420f183e5a28e3a04356f6d54f440c99292c9d39c49b56505cc57ad01ff2272eb5cce97e
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-workflows-executions-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-workflows-executions-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export WORKFLOWS_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/workflows/executions/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-workflows-executions-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-workflows-executions-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-workflows-executions-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Workflows::Executions::V1::Executions::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
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
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/workflows/executions/v1"
77
-
78
- ENV["WORKFLOWS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
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:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/workflows/executions/v1"
90
58
 
91
59
  client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/workflows/executions/v1"
100
68
 
101
69
  ::Google::Cloud::Workflows::Executions::V1::Executions::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-workflows-executions-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/workflows/executions/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-workflows-executions-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
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.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
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**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -32,6 +32,9 @@ module Google
32
32
  # [Workflows][google.cloud.workflows.v1.Workflow] called executions.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "workflowexecutions.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @executions_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new Executions client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,10 +150,13 @@ module Google
137
150
 
138
151
  @executions_stub = ::Gapic::ServiceStub.new(
139
152
  ::Google::Cloud::Workflows::Executions::V1::Executions::Stub,
140
- credentials: credentials,
141
- endpoint: @config.endpoint,
153
+ credentials: credentials,
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
142
157
  channel_args: @config.channel_args,
143
- interceptors: @config.interceptors
158
+ interceptors: @config.interceptors,
159
+ channel_pool_config: @config.channel_pool
144
160
  )
145
161
  end
146
162
 
@@ -564,9 +580,9 @@ module Google
564
580
  # end
565
581
  #
566
582
  # @!attribute [rw] endpoint
567
- # The hostname or hostname:port of the service endpoint.
568
- # Defaults to `"workflowexecutions.googleapis.com"`.
569
- # @return [::String]
583
+ # A custom service endpoint, as a hostname or hostname:port. The default is
584
+ # nil, indicating to use the default endpoint in the current universe domain.
585
+ # @return [::String,nil]
570
586
  # @!attribute [rw] credentials
571
587
  # Credentials to send with calls. You may provide any of the following types:
572
588
  # * (`String`) The path to a service account key file in JSON format
@@ -612,13 +628,20 @@ module Google
612
628
  # @!attribute [rw] quota_project
613
629
  # A separate project against which to charge quota.
614
630
  # @return [::String]
631
+ # @!attribute [rw] universe_domain
632
+ # The universe domain within which to make requests. This determines the
633
+ # default endpoint URL. The default value of nil uses the environment
634
+ # universe (usually the default "googleapis.com" universe).
635
+ # @return [::String,nil]
615
636
  #
616
637
  class Configuration
617
638
  extend ::Gapic::Config
618
639
 
640
+ # @private
641
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
619
642
  DEFAULT_ENDPOINT = "workflowexecutions.googleapis.com"
620
643
 
621
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
644
+ config_attr :endpoint, nil, ::String, nil
622
645
  config_attr :credentials, nil do |value|
623
646
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
624
647
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -633,6 +656,7 @@ module Google
633
656
  config_attr :metadata, nil, ::Hash, nil
634
657
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
635
658
  config_attr :quota_project, nil, ::String, nil
659
+ config_attr :universe_domain, nil, ::String, nil
636
660
 
637
661
  # @private
638
662
  def initialize parent_config = nil
@@ -653,6 +677,14 @@ module Google
653
677
  end
654
678
  end
655
679
 
680
+ ##
681
+ # Configuration for the channel pool
682
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
683
+ #
684
+ def channel_pool
685
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
686
+ end
687
+
656
688
  ##
657
689
  # Configuration RPC class for the Executions API.
658
690
  #
@@ -34,6 +34,9 @@ module Google
34
34
  # [Workflows][google.cloud.workflows.v1.Workflow] called executions.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "workflowexecutions.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @executions_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new Executions REST client object.
99
111
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -132,7 +145,12 @@ module Google
132
145
  @quota_project_id = @config.quota_project
133
146
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
134
147
 
135
- @executions_stub = ::Google::Cloud::Workflows::Executions::V1::Executions::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
148
+ @executions_stub = ::Google::Cloud::Workflows::Executions::V1::Executions::Rest::ServiceStub.new(
149
+ endpoint: @config.endpoint,
150
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
151
+ universe_domain: @config.universe_domain,
152
+ credentials: credentials
153
+ )
136
154
  end
137
155
 
138
156
  # Service calls
@@ -196,6 +214,26 @@ module Google
196
214
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1::Execution>]
197
215
  #
198
216
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
217
+ #
218
+ # @example Basic example
219
+ # require "google/cloud/workflows/executions/v1"
220
+ #
221
+ # # Create a client object. The client can be reused for multiple calls.
222
+ # client = Google::Cloud::Workflows::Executions::V1::Executions::Rest::Client.new
223
+ #
224
+ # # Create a request. To set request fields, pass in keyword arguments.
225
+ # request = Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest.new
226
+ #
227
+ # # Call the list_executions method.
228
+ # result = client.list_executions request
229
+ #
230
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
231
+ # # over elements, and API calls will be issued to fetch pages as needed.
232
+ # result.each do |item|
233
+ # # Each element is of type ::Google::Cloud::Workflows::Executions::V1::Execution.
234
+ # p item
235
+ # end
236
+ #
199
237
  def list_executions request, options = nil
200
238
  raise ::ArgumentError, "request must be provided" if request.nil?
201
239
 
@@ -263,6 +301,22 @@ module Google
263
301
  # @return [::Google::Cloud::Workflows::Executions::V1::Execution]
264
302
  #
265
303
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
304
+ #
305
+ # @example Basic example
306
+ # require "google/cloud/workflows/executions/v1"
307
+ #
308
+ # # Create a client object. The client can be reused for multiple calls.
309
+ # client = Google::Cloud::Workflows::Executions::V1::Executions::Rest::Client.new
310
+ #
311
+ # # Create a request. To set request fields, pass in keyword arguments.
312
+ # request = Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest.new
313
+ #
314
+ # # Call the create_execution method.
315
+ # result = client.create_execution request
316
+ #
317
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
318
+ # p result
319
+ #
266
320
  def create_execution request, options = nil
267
321
  raise ::ArgumentError, "request must be provided" if request.nil?
268
322
 
@@ -330,6 +384,22 @@ module Google
330
384
  # @return [::Google::Cloud::Workflows::Executions::V1::Execution]
331
385
  #
332
386
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
387
+ #
388
+ # @example Basic example
389
+ # require "google/cloud/workflows/executions/v1"
390
+ #
391
+ # # Create a client object. The client can be reused for multiple calls.
392
+ # client = Google::Cloud::Workflows::Executions::V1::Executions::Rest::Client.new
393
+ #
394
+ # # Create a request. To set request fields, pass in keyword arguments.
395
+ # request = Google::Cloud::Workflows::Executions::V1::GetExecutionRequest.new
396
+ #
397
+ # # Call the get_execution method.
398
+ # result = client.get_execution request
399
+ #
400
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
401
+ # p result
402
+ #
333
403
  def get_execution request, options = nil
334
404
  raise ::ArgumentError, "request must be provided" if request.nil?
335
405
 
@@ -394,6 +464,22 @@ module Google
394
464
  # @return [::Google::Cloud::Workflows::Executions::V1::Execution]
395
465
  #
396
466
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
467
+ #
468
+ # @example Basic example
469
+ # require "google/cloud/workflows/executions/v1"
470
+ #
471
+ # # Create a client object. The client can be reused for multiple calls.
472
+ # client = Google::Cloud::Workflows::Executions::V1::Executions::Rest::Client.new
473
+ #
474
+ # # Create a request. To set request fields, pass in keyword arguments.
475
+ # request = Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest.new
476
+ #
477
+ # # Call the cancel_execution method.
478
+ # result = client.cancel_execution request
479
+ #
480
+ # # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
481
+ # p result
482
+ #
397
483
  def cancel_execution request, options = nil
398
484
  raise ::ArgumentError, "request must be provided" if request.nil?
399
485
 
@@ -459,9 +545,9 @@ module Google
459
545
  # end
460
546
  #
461
547
  # @!attribute [rw] endpoint
462
- # The hostname or hostname:port of the service endpoint.
463
- # Defaults to `"workflowexecutions.googleapis.com"`.
464
- # @return [::String]
548
+ # A custom service endpoint, as a hostname or hostname:port. The default is
549
+ # nil, indicating to use the default endpoint in the current universe domain.
550
+ # @return [::String,nil]
465
551
  # @!attribute [rw] credentials
466
552
  # Credentials to send with calls. You may provide any of the following types:
467
553
  # * (`String`) The path to a service account key file in JSON format
@@ -498,13 +584,20 @@ module Google
498
584
  # @!attribute [rw] quota_project
499
585
  # A separate project against which to charge quota.
500
586
  # @return [::String]
587
+ # @!attribute [rw] universe_domain
588
+ # The universe domain within which to make requests. This determines the
589
+ # default endpoint URL. The default value of nil uses the environment
590
+ # universe (usually the default "googleapis.com" universe).
591
+ # @return [::String,nil]
501
592
  #
502
593
  class Configuration
503
594
  extend ::Gapic::Config
504
595
 
596
+ # @private
597
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
505
598
  DEFAULT_ENDPOINT = "workflowexecutions.googleapis.com"
506
599
 
507
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
600
+ config_attr :endpoint, nil, ::String, nil
508
601
  config_attr :credentials, nil do |value|
509
602
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
510
603
  allowed.any? { |klass| klass === value }
@@ -516,6 +609,7 @@ module Google
516
609
  config_attr :metadata, nil, ::Hash, nil
517
610
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
518
611
  config_attr :quota_project, nil, ::String, nil
612
+ config_attr :universe_domain, nil, ::String, nil
519
613
 
520
614
  # @private
521
615
  def initialize parent_config = nil
@@ -31,16 +31,28 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
35
35
  # These require statements are intentionally placed here to initialize
36
36
  # the REST modules only when it's required.
37
37
  require "gapic/rest"
38
38
 
39
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
40
43
  numeric_enums: false,
41
44
  raise_faraday_errors: false
42
45
  end
43
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
44
56
  ##
45
57
  # Baseline implementation for the list_executions REST call
46
58
  #
@@ -22,7 +22,7 @@ module Google
22
22
  module Workflows
23
23
  module Executions
24
24
  module V1
25
- VERSION = "0.4.0"
25
+ VERSION = "0.6.0"
26
26
  end
27
27
  end
28
28
  end
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-workflows-executions-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-04 00:00:00.000000000 Z
11
+ date: 2024-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.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
212
212
  - !ruby/object:Gem::Version
213
213
  version: '0'
214
214
  requirements: []
215
- rubygems_version: 3.4.19
215
+ rubygems_version: 3.5.3
216
216
  signing_key:
217
217
  specification_version: 4
218
218
  summary: Execute workflows created with Workflows API.