google-cloud-deploy-v1 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/deploy/v1/cloud_deploy/client.rb +34 -8
- data/lib/google/cloud/deploy/v1/cloud_deploy/operations.rb +28 -6
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb +36 -7
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/operations.rb +33 -8
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/service_stub.rb +14 -2
- data/lib/google/cloud/deploy/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -0
- metadata +8 -8
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fc09c93492f0e1d7198ba72ee64cda5016c0fc09ccb5f953356ce2d69fb8e12e
|
|
4
|
+
data.tar.gz: 445f481f08a9dacec010b737e6e980a0ffb5b74dff8d96a11cbc169311232643
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b15030c068851073d12532474a32c9aaa3a6c0c09ace2395d7f7dccc7fa2438c597b3f103708fd11d1cca95302c706a65ce0fb67b6217e3315bab2b33776555a
|
|
7
|
+
data.tar.gz: 3c9301beecc41cb750f7de92bdb4ac78c1333b52a550b999b8f8d0b2066f545914c410f7bfbeae40d30cda7f453cfc662e8b4f1122b94ef86b84f23f95da1b74
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
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-deploy-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
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
28
|
-
|
|
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
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-deploy-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
|
-
|
|
51
|
-
|
|
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
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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-deploy-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
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Deploy::V1::CloudDeploy::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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)
|
|
72
41
|
|
|
73
|
-
|
|
74
|
-
require "google/cloud/deploy/v1"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
79
|
-
|
|
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).
|
|
80
49
|
|
|
81
|
-
|
|
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.
|
|
82
53
|
|
|
83
|
-
|
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
85
55
|
|
|
86
56
|
```ruby
|
|
87
57
|
require "google/cloud/deploy/v1"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Client.new do |config|
|
|
90
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
95
65
|
|
|
96
66
|
```ruby
|
|
97
67
|
require "google/cloud/deploy/v1"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::Deploy::V1::CloudDeploy::Client.configure do |config|
|
|
100
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
101
71
|
end
|
|
102
72
|
|
|
103
73
|
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
|
104
74
|
```
|
|
105
75
|
|
|
106
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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.
|
|
111
82
|
|
|
112
|
-
|
|
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).
|
|
113
87
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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-deploy-v1
|
|
93
|
+
checks for credentials are:
|
|
117
94
|
|
|
118
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/deploy/v1"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-deploy-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
132
|
-
2. Create a new project or click on an existing project.
|
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
134
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
135
107
|
|
|
136
|
-
|
|
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.
|
|
137
111
|
|
|
138
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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.
|
|
147
120
|
|
|
148
|
-
|
|
149
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# on Google Cloud Platform via Skaffold (https://skaffold.dev).
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -222,6 +225,15 @@ module Google
|
|
|
222
225
|
@config
|
|
223
226
|
end
|
|
224
227
|
|
|
228
|
+
##
|
|
229
|
+
# The effective universe domain
|
|
230
|
+
#
|
|
231
|
+
# @return [String]
|
|
232
|
+
#
|
|
233
|
+
def universe_domain
|
|
234
|
+
@cloud_deploy_stub.universe_domain
|
|
235
|
+
end
|
|
236
|
+
|
|
225
237
|
##
|
|
226
238
|
# Create a new CloudDeploy client object.
|
|
227
239
|
#
|
|
@@ -255,8 +267,9 @@ module Google
|
|
|
255
267
|
credentials = @config.credentials
|
|
256
268
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
257
269
|
# but only if the default endpoint does not have a region prefix.
|
|
258
|
-
enable_self_signed_jwt = @config.endpoint
|
|
259
|
-
|
|
270
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
271
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
272
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
260
273
|
credentials ||= Credentials.default scope: @config.scope,
|
|
261
274
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
262
275
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -269,24 +282,29 @@ module Google
|
|
|
269
282
|
config.credentials = credentials
|
|
270
283
|
config.quota_project = @quota_project_id
|
|
271
284
|
config.endpoint = @config.endpoint
|
|
285
|
+
config.universe_domain = @config.universe_domain
|
|
272
286
|
end
|
|
273
287
|
|
|
274
288
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
275
289
|
config.credentials = credentials
|
|
276
290
|
config.quota_project = @quota_project_id
|
|
277
291
|
config.endpoint = @config.endpoint
|
|
292
|
+
config.universe_domain = @config.universe_domain
|
|
278
293
|
end
|
|
279
294
|
|
|
280
295
|
@iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
|
|
281
296
|
config.credentials = credentials
|
|
282
297
|
config.quota_project = @quota_project_id
|
|
283
298
|
config.endpoint = @config.endpoint
|
|
299
|
+
config.universe_domain = @config.universe_domain
|
|
284
300
|
end
|
|
285
301
|
|
|
286
302
|
@cloud_deploy_stub = ::Gapic::ServiceStub.new(
|
|
287
303
|
::Google::Cloud::Deploy::V1::CloudDeploy::Stub,
|
|
288
|
-
credentials:
|
|
289
|
-
endpoint:
|
|
304
|
+
credentials: credentials,
|
|
305
|
+
endpoint: @config.endpoint,
|
|
306
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
307
|
+
universe_domain: @config.universe_domain,
|
|
290
308
|
channel_args: @config.channel_args,
|
|
291
309
|
interceptors: @config.interceptors,
|
|
292
310
|
channel_pool_config: @config.channel_pool
|
|
@@ -4438,9 +4456,9 @@ module Google
|
|
|
4438
4456
|
# end
|
|
4439
4457
|
#
|
|
4440
4458
|
# @!attribute [rw] endpoint
|
|
4441
|
-
#
|
|
4442
|
-
#
|
|
4443
|
-
# @return [::String]
|
|
4459
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
4460
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
4461
|
+
# @return [::String,nil]
|
|
4444
4462
|
# @!attribute [rw] credentials
|
|
4445
4463
|
# Credentials to send with calls. You may provide any of the following types:
|
|
4446
4464
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -4486,13 +4504,20 @@ module Google
|
|
|
4486
4504
|
# @!attribute [rw] quota_project
|
|
4487
4505
|
# A separate project against which to charge quota.
|
|
4488
4506
|
# @return [::String]
|
|
4507
|
+
# @!attribute [rw] universe_domain
|
|
4508
|
+
# The universe domain within which to make requests. This determines the
|
|
4509
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
4510
|
+
# universe (usually the default "googleapis.com" universe).
|
|
4511
|
+
# @return [::String,nil]
|
|
4489
4512
|
#
|
|
4490
4513
|
class Configuration
|
|
4491
4514
|
extend ::Gapic::Config
|
|
4492
4515
|
|
|
4516
|
+
# @private
|
|
4517
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
4493
4518
|
DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
|
|
4494
4519
|
|
|
4495
|
-
config_attr :endpoint,
|
|
4520
|
+
config_attr :endpoint, nil, ::String, nil
|
|
4496
4521
|
config_attr :credentials, nil do |value|
|
|
4497
4522
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
4498
4523
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -4507,6 +4532,7 @@ module Google
|
|
|
4507
4532
|
config_attr :metadata, nil, ::Hash, nil
|
|
4508
4533
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
4509
4534
|
config_attr :quota_project, nil, ::String, nil
|
|
4535
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
4510
4536
|
|
|
4511
4537
|
# @private
|
|
4512
4538
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module CloudDeploy
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# on Google Cloud Platform via Skaffold (https://skaffold.dev).
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
include Paths
|
|
39
42
|
|
|
40
43
|
# @private
|
|
@@ -224,6 +227,15 @@ module Google
|
|
|
224
227
|
@config
|
|
225
228
|
end
|
|
226
229
|
|
|
230
|
+
##
|
|
231
|
+
# The effective universe domain
|
|
232
|
+
#
|
|
233
|
+
# @return [String]
|
|
234
|
+
#
|
|
235
|
+
def universe_domain
|
|
236
|
+
@cloud_deploy_stub.universe_domain
|
|
237
|
+
end
|
|
238
|
+
|
|
227
239
|
##
|
|
228
240
|
# Create a new CloudDeploy REST client object.
|
|
229
241
|
#
|
|
@@ -251,8 +263,9 @@ module Google
|
|
|
251
263
|
credentials = @config.credentials
|
|
252
264
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
253
265
|
# but only if the default endpoint does not have a region prefix.
|
|
254
|
-
enable_self_signed_jwt = @config.endpoint
|
|
255
|
-
|
|
266
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
267
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
268
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
256
269
|
credentials ||= Credentials.default scope: @config.scope,
|
|
257
270
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
258
271
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -266,12 +279,14 @@ module Google
|
|
|
266
279
|
config.credentials = credentials
|
|
267
280
|
config.quota_project = @quota_project_id
|
|
268
281
|
config.endpoint = @config.endpoint
|
|
282
|
+
config.universe_domain = @config.universe_domain
|
|
269
283
|
end
|
|
270
284
|
|
|
271
285
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
272
286
|
config.credentials = credentials
|
|
273
287
|
config.quota_project = @quota_project_id
|
|
274
288
|
config.endpoint = @config.endpoint
|
|
289
|
+
config.universe_domain = @config.universe_domain
|
|
275
290
|
config.bindings_override = @config.bindings_override
|
|
276
291
|
end
|
|
277
292
|
|
|
@@ -279,10 +294,16 @@ module Google
|
|
|
279
294
|
config.credentials = credentials
|
|
280
295
|
config.quota_project = @quota_project_id
|
|
281
296
|
config.endpoint = @config.endpoint
|
|
297
|
+
config.universe_domain = @config.universe_domain
|
|
282
298
|
config.bindings_override = @config.bindings_override
|
|
283
299
|
end
|
|
284
300
|
|
|
285
|
-
@cloud_deploy_stub = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::ServiceStub.new
|
|
301
|
+
@cloud_deploy_stub = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::ServiceStub.new(
|
|
302
|
+
endpoint: @config.endpoint,
|
|
303
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
304
|
+
universe_domain: @config.universe_domain,
|
|
305
|
+
credentials: credentials
|
|
306
|
+
)
|
|
286
307
|
end
|
|
287
308
|
|
|
288
309
|
##
|
|
@@ -4142,9 +4163,9 @@ module Google
|
|
|
4142
4163
|
# end
|
|
4143
4164
|
#
|
|
4144
4165
|
# @!attribute [rw] endpoint
|
|
4145
|
-
#
|
|
4146
|
-
#
|
|
4147
|
-
# @return [::String]
|
|
4166
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
4167
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
4168
|
+
# @return [::String,nil]
|
|
4148
4169
|
# @!attribute [rw] credentials
|
|
4149
4170
|
# Credentials to send with calls. You may provide any of the following types:
|
|
4150
4171
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -4181,13 +4202,20 @@ module Google
|
|
|
4181
4202
|
# @!attribute [rw] quota_project
|
|
4182
4203
|
# A separate project against which to charge quota.
|
|
4183
4204
|
# @return [::String]
|
|
4205
|
+
# @!attribute [rw] universe_domain
|
|
4206
|
+
# The universe domain within which to make requests. This determines the
|
|
4207
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
4208
|
+
# universe (usually the default "googleapis.com" universe).
|
|
4209
|
+
# @return [::String,nil]
|
|
4184
4210
|
#
|
|
4185
4211
|
class Configuration
|
|
4186
4212
|
extend ::Gapic::Config
|
|
4187
4213
|
|
|
4214
|
+
# @private
|
|
4215
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
4188
4216
|
DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
|
|
4189
4217
|
|
|
4190
|
-
config_attr :endpoint,
|
|
4218
|
+
config_attr :endpoint, nil, ::String, nil
|
|
4191
4219
|
config_attr :credentials, nil do |value|
|
|
4192
4220
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
4193
4221
|
allowed.any? { |klass| klass === value }
|
|
@@ -4199,6 +4227,7 @@ module Google
|
|
|
4199
4227
|
config_attr :metadata, nil, ::Hash, nil
|
|
4200
4228
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
4201
4229
|
config_attr :quota_project, nil, ::String, nil
|
|
4230
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
4202
4231
|
|
|
4203
4232
|
# @private
|
|
4204
4233
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_delivery_pipelines REST call
|
|
45
57
|
#
|
|
@@ -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
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-deploy-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.17.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: 2024-01-
|
|
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
|
+
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.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -50,7 +50,7 @@ dependencies:
|
|
|
50
50
|
requirements:
|
|
51
51
|
- - ">="
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '0.
|
|
53
|
+
version: '0.7'
|
|
54
54
|
- - "<"
|
|
55
55
|
- !ruby/object:Gem::Version
|
|
56
56
|
version: 2.a
|
|
@@ -60,7 +60,7 @@ dependencies:
|
|
|
60
60
|
requirements:
|
|
61
61
|
- - ">="
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
|
-
version: '0.
|
|
63
|
+
version: '0.7'
|
|
64
64
|
- - "<"
|
|
65
65
|
- !ruby/object:Gem::Version
|
|
66
66
|
version: 2.a
|
|
@@ -70,7 +70,7 @@ dependencies:
|
|
|
70
70
|
requirements:
|
|
71
71
|
- - ">="
|
|
72
72
|
- !ruby/object:Gem::Version
|
|
73
|
-
version: '0.
|
|
73
|
+
version: '0.7'
|
|
74
74
|
- - "<"
|
|
75
75
|
- !ruby/object:Gem::Version
|
|
76
76
|
version: 2.a
|
|
@@ -80,7 +80,7 @@ dependencies:
|
|
|
80
80
|
requirements:
|
|
81
81
|
- - ">="
|
|
82
82
|
- !ruby/object:Gem::Version
|
|
83
|
-
version: '0.
|
|
83
|
+
version: '0.7'
|
|
84
84
|
- - "<"
|
|
85
85
|
- !ruby/object:Gem::Version
|
|
86
86
|
version: 2.a
|