google-cloud-build-v1 0.25.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/build/v1/cloud_build/client.rb +32 -8
  4. data/lib/google/cloud/build/v1/cloud_build/operations.rb +28 -6
  5. data/lib/google/cloud/build/v1/cloud_build/rest/client.rb +34 -7
  6. data/lib/google/cloud/build/v1/cloud_build/rest/operations.rb +33 -8
  7. data/lib/google/cloud/build/v1/cloud_build/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/build/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +14 -0
  10. data/proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb +2 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a587eb6dbe3c1aeb953b185cb47290338c2a992ebef14964a76b2db0e9e96f86
4
- data.tar.gz: b1be50695fd1c222d7e8c089617b839defe9384e8b4910953269b1c97d5bcb8e
3
+ metadata.gz: 84987256f26179c7e7454e2c60c169f59778926a080ba7b2b1fbfd13cb6c3958
4
+ data.tar.gz: 0a9699e7adf57bd5071383dad87c992b0ebc41dbec12977fc63cab0ff7176bb0
5
5
  SHA512:
6
- metadata.gz: 52e32d5aab2068951698366c9690ed25451f9555d073f321f45c350a6e061df47a0ee9c682f4de843775c1ed7b210e6be968645c0fc5b33324789ab70519d5a7
7
- data.tar.gz: b156618c49b2638fae129c2a6b196a034b7987dd14306971b378728acc400d237b44dc52954528a75bdbbdc80bb886888fab737c4744cc5a3ec2ccfa87e7ddde
6
+ metadata.gz: fd41b124389c87ae86dec53e2786f34f3e279fccc3741d942a71019f3dc500ab4cda78a6d47cea1d608df1648e6b5e31f9dda7f04aa84ff2aa60e0c7bf24b423
7
+ data.tar.gz: 39145261d440a9886c34990bd22b02b95ff4866cd0fdf517aa2f54f008e6c373debded1891d069c6b38a8dbad46732953c64b44ae74d80d3d021d8eb2484ca02
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-build-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-build-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 CLOUD_BUILD_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/build/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::Build::V1::CloudBuild::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-build-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-build-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-build-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Build::V1::CloudBuild::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `CLOUD_BUILD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `CLOUD_BUILD_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/build/v1"
77
-
78
- ENV["CLOUD_BUILD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Build::V1::CloudBuild::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/build/v1"
90
58
 
91
59
  client = ::Google::Cloud::Build::V1::CloudBuild::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/build/v1"
100
68
 
101
69
  ::Google::Cloud::Build::V1::CloudBuild::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::Build::V1::CloudBuild::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-build-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/build/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-build-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::Build::V1::CloudBuild::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).
data/lib/google/cloud/build/v1/cloud_build/client.rb CHANGED
@@ -37,6 +37,9 @@ module Google
37
37
  # determine the status of the build.
38
38
  #
39
39
  class Client
40
+ # @private
41
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudbuild.$UNIVERSE_DOMAIN$"
42
+
40
43
  include Paths
41
44
 
42
45
  # @private
@@ -150,6 +153,15 @@ module Google
150
153
  @config
151
154
  end
152
155
 
156
+ ##
157
+ # The effective universe domain
158
+ #
159
+ # @return [String]
160
+ #
161
+ def universe_domain
162
+ @cloud_build_stub.universe_domain
163
+ end
164
+
153
165
  ##
154
166
  # Create a new CloudBuild client object.
155
167
  #
@@ -183,8 +195,9 @@ module Google
183
195
  credentials = @config.credentials
184
196
  # Use self-signed JWT if the endpoint is unchanged from default,
185
197
  # but only if the default endpoint does not have a region prefix.
186
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
187
- !@config.endpoint.split(".").first.include?("-")
198
+ enable_self_signed_jwt = @config.endpoint.nil? ||
199
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
200
+ !@config.endpoint.split(".").first.include?("-"))
188
201
  credentials ||= Credentials.default scope: @config.scope,
189
202
  enable_self_signed_jwt: enable_self_signed_jwt
190
203
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -197,12 +210,15 @@ module Google
197
210
  config.credentials = credentials
198
211
  config.quota_project = @quota_project_id
199
212
  config.endpoint = @config.endpoint
213
+ config.universe_domain = @config.universe_domain
200
214
  end
201
215
 
202
216
  @cloud_build_stub = ::Gapic::ServiceStub.new(
203
217
  ::Google::Cloud::Build::V1::CloudBuild::Stub,
204
- credentials: credentials,
205
- endpoint: @config.endpoint,
218
+ credentials: credentials,
219
+ endpoint: @config.endpoint,
220
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
221
+ universe_domain: @config.universe_domain,
206
222
  channel_args: @config.channel_args,
207
223
  interceptors: @config.interceptors,
208
224
  channel_pool_config: @config.channel_pool
@@ -2087,9 +2103,9 @@ module Google
2087
2103
  # end
2088
2104
  #
2089
2105
  # @!attribute [rw] endpoint
2090
- # The hostname or hostname:port of the service endpoint.
2091
- # Defaults to `"cloudbuild.googleapis.com"`.
2092
- # @return [::String]
2106
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2107
+ # nil, indicating to use the default endpoint in the current universe domain.
2108
+ # @return [::String,nil]
2093
2109
  # @!attribute [rw] credentials
2094
2110
  # Credentials to send with calls. You may provide any of the following types:
2095
2111
  # * (`String`) The path to a service account key file in JSON format
@@ -2135,13 +2151,20 @@ module Google
2135
2151
  # @!attribute [rw] quota_project
2136
2152
  # A separate project against which to charge quota.
2137
2153
  # @return [::String]
2154
+ # @!attribute [rw] universe_domain
2155
+ # The universe domain within which to make requests. This determines the
2156
+ # default endpoint URL. The default value of nil uses the environment
2157
+ # universe (usually the default "googleapis.com" universe).
2158
+ # @return [::String,nil]
2138
2159
  #
2139
2160
  class Configuration
2140
2161
  extend ::Gapic::Config
2141
2162
 
2163
+ # @private
2164
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2142
2165
  DEFAULT_ENDPOINT = "cloudbuild.googleapis.com"
2143
2166
 
2144
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2167
+ config_attr :endpoint, nil, ::String, nil
2145
2168
  config_attr :credentials, nil do |value|
2146
2169
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2147
2170
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2156,6 +2179,7 @@ module Google
2156
2179
  config_attr :metadata, nil, ::Hash, nil
2157
2180
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2158
2181
  config_attr :quota_project, nil, ::String, nil
2182
+ config_attr :universe_domain, nil, ::String, nil
2159
2183
 
2160
2184
  # @private
2161
2185
  def initialize parent_config = nil
data/lib/google/cloud/build/v1/cloud_build/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module CloudBuild
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudbuild.$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: credentials,
94
- endpoint: @config.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
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"cloudbuild.googleapis.com"`.
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 = "cloudbuild.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
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
data/lib/google/cloud/build/v1/cloud_build/rest/client.rb CHANGED
@@ -39,6 +39,9 @@ module Google
39
39
  # determine the status of the build.
40
40
  #
41
41
  class Client
42
+ # @private
43
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudbuild.$UNIVERSE_DOMAIN$"
44
+
42
45
  include Paths
43
46
 
44
47
  # @private
@@ -152,6 +155,15 @@ module Google
152
155
  @config
153
156
  end
154
157
 
158
+ ##
159
+ # The effective universe domain
160
+ #
161
+ # @return [String]
162
+ #
163
+ def universe_domain
164
+ @cloud_build_stub.universe_domain
165
+ end
166
+
155
167
  ##
156
168
  # Create a new CloudBuild REST client object.
157
169
  #
@@ -179,8 +191,9 @@ module Google
179
191
  credentials = @config.credentials
180
192
  # Use self-signed JWT if the endpoint is unchanged from default,
181
193
  # but only if the default endpoint does not have a region prefix.
182
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
183
- !@config.endpoint.split(".").first.include?("-")
194
+ enable_self_signed_jwt = @config.endpoint.nil? ||
195
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
196
+ !@config.endpoint.split(".").first.include?("-"))
184
197
  credentials ||= Credentials.default scope: @config.scope,
185
198
  enable_self_signed_jwt: enable_self_signed_jwt
186
199
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -194,9 +207,15 @@ module Google
194
207
  config.credentials = credentials
195
208
  config.quota_project = @quota_project_id
196
209
  config.endpoint = @config.endpoint
210
+ config.universe_domain = @config.universe_domain
197
211
  end
198
212
 
199
- @cloud_build_stub = ::Google::Cloud::Build::V1::CloudBuild::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
213
+ @cloud_build_stub = ::Google::Cloud::Build::V1::CloudBuild::Rest::ServiceStub.new(
214
+ endpoint: @config.endpoint,
215
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
216
+ universe_domain: @config.universe_domain,
217
+ credentials: credentials
218
+ )
200
219
  end
201
220
 
202
221
  ##
@@ -1897,9 +1916,9 @@ module Google
1897
1916
  # end
1898
1917
  #
1899
1918
  # @!attribute [rw] endpoint
1900
- # The hostname or hostname:port of the service endpoint.
1901
- # Defaults to `"cloudbuild.googleapis.com"`.
1902
- # @return [::String]
1919
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1920
+ # nil, indicating to use the default endpoint in the current universe domain.
1921
+ # @return [::String,nil]
1903
1922
  # @!attribute [rw] credentials
1904
1923
  # Credentials to send with calls. You may provide any of the following types:
1905
1924
  # * (`String`) The path to a service account key file in JSON format
@@ -1936,13 +1955,20 @@ module Google
1936
1955
  # @!attribute [rw] quota_project
1937
1956
  # A separate project against which to charge quota.
1938
1957
  # @return [::String]
1958
+ # @!attribute [rw] universe_domain
1959
+ # The universe domain within which to make requests. This determines the
1960
+ # default endpoint URL. The default value of nil uses the environment
1961
+ # universe (usually the default "googleapis.com" universe).
1962
+ # @return [::String,nil]
1939
1963
  #
1940
1964
  class Configuration
1941
1965
  extend ::Gapic::Config
1942
1966
 
1967
+ # @private
1968
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1943
1969
  DEFAULT_ENDPOINT = "cloudbuild.googleapis.com"
1944
1970
 
1945
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1971
+ config_attr :endpoint, nil, ::String, nil
1946
1972
  config_attr :credentials, nil do |value|
1947
1973
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1948
1974
  allowed.any? { |klass| klass === value }
@@ -1954,6 +1980,7 @@ module Google
1954
1980
  config_attr :metadata, nil, ::Hash, nil
1955
1981
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1956
1982
  config_attr :quota_project, nil, ::String, nil
1983
+ config_attr :universe_domain, nil, ::String, nil
1957
1984
 
1958
1985
  # @private
1959
1986
  def initialize parent_config = nil
data/lib/google/cloud/build/v1/cloud_build/rest/operations.rb CHANGED
@@ -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 = "cloudbuild.$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: @config.endpoint,
88
- credentials: credentials
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
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"cloudbuild.googleapis.com"`.
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 = "cloudbuild.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
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, credentials: credentials
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
  ##
data/lib/google/cloud/build/v1/cloud_build/rest/service_stub.rb CHANGED
@@ -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, credentials: credentials,
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 create_build REST call
45
57
  #
data/lib/google/cloud/build/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Build
23
23
  module V1
24
- VERSION = "0.25.0"
24
+ VERSION = "0.26.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb CHANGED
@@ -1533,6 +1533,7 @@ module Google
1533
1533
  # GitHubEventsConfig describes the configuration of a trigger that creates a
1534
1534
  # build whenever a GitHub event is received.
1535
1535
  # @!attribute [rw] installation_id
1536
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1536
1537
  # @return [::Integer]
1537
1538
  # The installationID that emits the GitHub event.
1538
1539
  # @!attribute [rw] owner
@@ -1819,6 +1820,7 @@ module Google
1819
1820
  # Option to define build log streaming behavior to Cloud
1820
1821
  # Storage.
1821
1822
  # @!attribute [rw] worker_pool
1823
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1822
1824
  # @return [::String]
1823
1825
  # This field deprecated; please use `pool.name` instead.
1824
1826
  # @!attribute [rw] pool
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-build-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.25.0
4
+ version: 0.26.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-11-06 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.20.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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
220
220
  - !ruby/object:Gem::Version
221
221
  version: '0'
222
222
  requirements: []
223
- rubygems_version: 3.4.19
223
+ rubygems_version: 3.5.3
224
224
  signing_key:
225
225
  specification_version: 4
226
226
  summary: Creates and manages builds on Google Cloud Platform.