google-cloud-deploy-v1 0.15.0 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/deploy/v1/cloud_deploy/client.rb +85 -59
- data/lib/google/cloud/deploy/v1/cloud_deploy/operations.rb +28 -6
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb +87 -58
- 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/cloud_deploy_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/deliverypipeline_notification_payload_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/jobrun_notification_payload_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/release_notification_payload_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/release_render_payload_pb.rb +2 -1
- data/lib/google/cloud/deploy/v1/rollout_notification_payload_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/rollout_update_payload_pb.rb +1 -1
- data/lib/google/cloud/deploy/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -0
- data/proto_docs/google/cloud/deploy/v1/cloud_deploy.rb +69 -66
- data/proto_docs/google/cloud/deploy/v1/deliverypipeline_notification_payload.rb +3 -0
- data/proto_docs/google/cloud/deploy/v1/jobrun_notification_payload.rb +6 -0
- data/proto_docs/google/cloud/deploy/v1/release_notification_payload.rb +6 -0
- data/proto_docs/google/cloud/deploy/v1/release_render_payload.rb +8 -0
- data/proto_docs/google/cloud/deploy/v1/rollout_notification_payload.rb +9 -3
- data/proto_docs/google/cloud/deploy/v1/rollout_update_payload.rb +11 -6
- metadata +9 -9
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
|
|
@@ -537,9 +555,9 @@ module Google
|
|
|
537
555
|
# Required. The `DeliveryPipeline` to create.
|
|
538
556
|
# @param request_id [::String]
|
|
539
557
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
540
|
-
# so that if you must retry your request, the server
|
|
541
|
-
#
|
|
542
|
-
#
|
|
558
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
559
|
+
# request if it has already been completed. The server guarantees that for
|
|
560
|
+
# at least 60 minutes after the first request.
|
|
543
561
|
#
|
|
544
562
|
# For example, consider a situation where you make an initial request and the
|
|
545
563
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -647,15 +665,15 @@ module Google
|
|
|
647
665
|
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
648
666
|
# `DeliveryPipeline` resource by the update.
|
|
649
667
|
# The fields specified in the update_mask are relative to the resource, not
|
|
650
|
-
# the full request. A field will be overwritten if it
|
|
651
|
-
# user
|
|
668
|
+
# the full request. A field will be overwritten if it's in the mask. If the
|
|
669
|
+
# user doesn't provide a mask then all fields are overwritten.
|
|
652
670
|
# @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
|
|
653
671
|
# Required. The `DeliveryPipeline` to update.
|
|
654
672
|
# @param request_id [::String]
|
|
655
673
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
656
|
-
# so that if you must retry your request, the server
|
|
657
|
-
#
|
|
658
|
-
#
|
|
674
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
675
|
+
# request if it has already been completed. The server guarantees that for
|
|
676
|
+
# at least 60 minutes after the first request.
|
|
659
677
|
#
|
|
660
678
|
# For example, consider a situation where you make an initial request and the
|
|
661
679
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -767,9 +785,9 @@ module Google
|
|
|
767
785
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
768
786
|
# @param request_id [::String]
|
|
769
787
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
770
|
-
# so that if you must retry your request, the server
|
|
771
|
-
#
|
|
772
|
-
#
|
|
788
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
789
|
+
# request if it has already been completed. The server guarantees that for
|
|
790
|
+
# at least 60 minutes after the first request.
|
|
773
791
|
#
|
|
774
792
|
# For example, consider a situation where you make an initial request and the
|
|
775
793
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1191,9 +1209,9 @@ module Google
|
|
|
1191
1209
|
# Required. The `Target` to create.
|
|
1192
1210
|
# @param request_id [::String]
|
|
1193
1211
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1194
|
-
# so that if you must retry your request, the server
|
|
1195
|
-
#
|
|
1196
|
-
#
|
|
1212
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1213
|
+
# request if it has already been completed. The server guarantees that for
|
|
1214
|
+
# at least 60 minutes after the first request.
|
|
1197
1215
|
#
|
|
1198
1216
|
# For example, consider a situation where you make an initial request and the
|
|
1199
1217
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1301,15 +1319,15 @@ module Google
|
|
|
1301
1319
|
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
1302
1320
|
# Target resource by the update.
|
|
1303
1321
|
# The fields specified in the update_mask are relative to the resource, not
|
|
1304
|
-
# the full request. A field will be overwritten if it
|
|
1305
|
-
# user
|
|
1322
|
+
# the full request. A field will be overwritten if it's in the mask. If the
|
|
1323
|
+
# user doesn't provide a mask then all fields are overwritten.
|
|
1306
1324
|
# @param target [::Google::Cloud::Deploy::V1::Target, ::Hash]
|
|
1307
1325
|
# Required. The `Target` to update.
|
|
1308
1326
|
# @param request_id [::String]
|
|
1309
1327
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1310
|
-
# so that if you must retry your request, the server
|
|
1311
|
-
#
|
|
1312
|
-
#
|
|
1328
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1329
|
+
# request if it has already been completed. The server guarantees that for
|
|
1330
|
+
# at least 60 minutes after the first request.
|
|
1313
1331
|
#
|
|
1314
1332
|
# For example, consider a situation where you make an initial request and the
|
|
1315
1333
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1421,9 +1439,9 @@ module Google
|
|
|
1421
1439
|
# `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
|
|
1422
1440
|
# @param request_id [::String]
|
|
1423
1441
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1424
|
-
# so that if you must retry your request, the server
|
|
1425
|
-
#
|
|
1426
|
-
#
|
|
1442
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1443
|
+
# request if it has already been completed. The server guarantees that for
|
|
1444
|
+
# at least 60 minutes after the first request.
|
|
1427
1445
|
#
|
|
1428
1446
|
# For example, consider a situation where you make an initial request and the
|
|
1429
1447
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1730,7 +1748,7 @@ module Google
|
|
|
1730
1748
|
#
|
|
1731
1749
|
# @param parent [::String]
|
|
1732
1750
|
# Required. The parent collection in which the `CustomTargetType` should be
|
|
1733
|
-
# created
|
|
1751
|
+
# created. Format should be
|
|
1734
1752
|
# `projects/{project_id}/locations/{location_name}`.
|
|
1735
1753
|
# @param custom_target_type_id [::String]
|
|
1736
1754
|
# Required. ID of the `CustomTargetType`.
|
|
@@ -1738,9 +1756,9 @@ module Google
|
|
|
1738
1756
|
# Required. The `CustomTargetType` to create.
|
|
1739
1757
|
# @param request_id [::String]
|
|
1740
1758
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1741
|
-
# so that if you must retry your request, the server
|
|
1742
|
-
#
|
|
1743
|
-
#
|
|
1759
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1760
|
+
# request if it has already been completed. The server guarantees that for
|
|
1761
|
+
# at least 60 minutes after the first request.
|
|
1744
1762
|
#
|
|
1745
1763
|
# For example, consider a situation where you make an initial request and the
|
|
1746
1764
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1848,15 +1866,15 @@ module Google
|
|
|
1848
1866
|
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
1849
1867
|
# `CustomTargetType` resource by the update.
|
|
1850
1868
|
# The fields specified in the update_mask are relative to the resource, not
|
|
1851
|
-
# the full request. A field will be overwritten if it
|
|
1852
|
-
# user
|
|
1869
|
+
# the full request. A field will be overwritten if it's in the mask. If the
|
|
1870
|
+
# user doesn't provide a mask then all fields are overwritten.
|
|
1853
1871
|
# @param custom_target_type [::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash]
|
|
1854
1872
|
# Required. The `CustomTargetType` to update.
|
|
1855
1873
|
# @param request_id [::String]
|
|
1856
1874
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1857
|
-
# so that if you must retry your request, the server
|
|
1858
|
-
#
|
|
1859
|
-
#
|
|
1875
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1876
|
+
# request if it has already been completed. The server guarantees that for
|
|
1877
|
+
# at least 60 minutes after the first request.
|
|
1860
1878
|
#
|
|
1861
1879
|
# For example, consider a situation where you make an initial request and the
|
|
1862
1880
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -1968,9 +1986,9 @@ module Google
|
|
|
1968
1986
|
# `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.
|
|
1969
1987
|
# @param request_id [::String]
|
|
1970
1988
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1971
|
-
# so that if you must retry your request, the server
|
|
1972
|
-
#
|
|
1973
|
-
#
|
|
1989
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
1990
|
+
# request if it has already been completed. The server guarantees that for
|
|
1991
|
+
# at least 60 minutes after the first request.
|
|
1974
1992
|
#
|
|
1975
1993
|
# For example, consider a situation where you make an initial request and the
|
|
1976
1994
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -2285,9 +2303,9 @@ module Google
|
|
|
2285
2303
|
# Required. The `Release` to create.
|
|
2286
2304
|
# @param request_id [::String]
|
|
2287
2305
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
2288
|
-
# so that if you must retry your request, the server
|
|
2289
|
-
#
|
|
2290
|
-
#
|
|
2306
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
2307
|
+
# request if it has already been completed. The server guarantees that for
|
|
2308
|
+
# at least 60 minutes after the first request.
|
|
2291
2309
|
#
|
|
2292
2310
|
# For example, consider a situation where you make an initial request and the
|
|
2293
2311
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -2942,9 +2960,9 @@ module Google
|
|
|
2942
2960
|
# Required. The `Rollout` to create.
|
|
2943
2961
|
# @param request_id [::String]
|
|
2944
2962
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
2945
|
-
# so that if you must retry your request, the server
|
|
2946
|
-
#
|
|
2947
|
-
#
|
|
2963
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
2964
|
+
# request if it has already been completed. The server guarantees that for
|
|
2965
|
+
# at least 60 minutes after the first request.
|
|
2948
2966
|
#
|
|
2949
2967
|
# For example, consider a situation where you make an initial request and the
|
|
2950
2968
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -3605,9 +3623,9 @@ module Google
|
|
|
3605
3623
|
# Required. The `Automation` to create.
|
|
3606
3624
|
# @param request_id [::String]
|
|
3607
3625
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
3608
|
-
# so that if you must retry your request, the server
|
|
3609
|
-
#
|
|
3610
|
-
#
|
|
3626
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
3627
|
+
# request if it has already been completed. The server guarantees that for
|
|
3628
|
+
# at least 60 minutes after the first request.
|
|
3611
3629
|
#
|
|
3612
3630
|
# For example, consider a situation where you make an initial request and the
|
|
3613
3631
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -3715,15 +3733,15 @@ module Google
|
|
|
3715
3733
|
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
3716
3734
|
# `Automation` resource by the update.
|
|
3717
3735
|
# The fields specified in the update_mask are relative to the resource, not
|
|
3718
|
-
# the full request. A field will be overwritten if it
|
|
3719
|
-
# user
|
|
3736
|
+
# the full request. A field will be overwritten if it's in the mask. If the
|
|
3737
|
+
# user doesn't provide a mask then all fields are overwritten.
|
|
3720
3738
|
# @param automation [::Google::Cloud::Deploy::V1::Automation, ::Hash]
|
|
3721
3739
|
# Required. The `Automation` to update.
|
|
3722
3740
|
# @param request_id [::String]
|
|
3723
3741
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
3724
|
-
# so that if you must retry your request, the server
|
|
3725
|
-
#
|
|
3726
|
-
#
|
|
3742
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
3743
|
+
# request if it has already been completed. The server guarantees that for
|
|
3744
|
+
# at least 60 minutes after the first request.
|
|
3727
3745
|
#
|
|
3728
3746
|
# For example, consider a situation where you make an initial request and the
|
|
3729
3747
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -3835,9 +3853,9 @@ module Google
|
|
|
3835
3853
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
|
|
3836
3854
|
# @param request_id [::String]
|
|
3837
3855
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
3838
|
-
# so that if you must retry your request, the server
|
|
3839
|
-
#
|
|
3840
|
-
#
|
|
3856
|
+
# so that if you must retry your request, the server knows to ignore the
|
|
3857
|
+
# request if it has already been completed. The server guarantees that for
|
|
3858
|
+
# at least 60 minutes after the first request.
|
|
3841
3859
|
#
|
|
3842
3860
|
# For example, consider a situation where you make an initial request and the
|
|
3843
3861
|
# request times out. If you make the request again with the same request ID,
|
|
@@ -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
|