google-cloud-billing-v1 0.16.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 -101
- data/lib/google/cloud/billing/v1/cloud_billing/client.rb +31 -8
- data/lib/google/cloud/billing/v1/cloud_billing/rest/client.rb +33 -7
- data/lib/google/cloud/billing/v1/cloud_billing/rest/service_stub.rb +14 -2
- data/lib/google/cloud/billing/v1/cloud_catalog/client.rb +31 -8
- data/lib/google/cloud/billing/v1/cloud_catalog/rest/client.rb +33 -7
- data/lib/google/cloud/billing/v1/cloud_catalog/rest/service_stub.rb +14 -2
- data/lib/google/cloud/billing/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 69b9cf0939f5fa48e2e27c276aec0d6b9d550a086411a3e80c166dfc82f25ca2
|
|
4
|
+
data.tar.gz: a8ace83814440ed6358a7fc695e1d6f5177321af3014622804849691f16c10cf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b06643be2bf76cd015b292b1373cb3b1a1984ec5ecc32fe2c36fdeb2321b9501377c32461e72fd891c7f78a137791e6afd3e4392c5d84c70cb771c87c19eace0
|
|
7
|
+
data.tar.gz: 6ce95a00909b38013b202eca9d15531618e4e80bd536c96c5ddc5a3f7550f010e9f6e75aa77b54743a825d6d087c1df520aadae4ec20cc38af408642a3505309
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +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-billing-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-billing-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-billing-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::Billing::V1::CloudBilling::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
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
|
-
|
|
76
|
-
require "google/cloud/billing/v1"
|
|
77
|
-
|
|
78
|
-
ENV["BILLING_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
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
|
-
|
|
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
|
-
|
|
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/billing/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Billing::V1::CloudBilling::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/billing/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Billing::V1::CloudBilling::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Billing::V1::CloudBilling::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
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
|
-
|
|
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
|
-
|
|
117
|
-
|
|
118
|
-
|
|
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-billing-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/billing/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-billing-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Billing::V1::CloudBilling::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
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
|
-
|
|
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
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
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
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -31,6 +31,9 @@ module Google
|
|
|
31
31
|
# projects.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudbilling.$UNIVERSE_DOMAIN$"
|
|
36
|
+
|
|
34
37
|
include Paths
|
|
35
38
|
|
|
36
39
|
# @private
|
|
@@ -138,6 +141,15 @@ module Google
|
|
|
138
141
|
@config
|
|
139
142
|
end
|
|
140
143
|
|
|
144
|
+
##
|
|
145
|
+
# The effective universe domain
|
|
146
|
+
#
|
|
147
|
+
# @return [String]
|
|
148
|
+
#
|
|
149
|
+
def universe_domain
|
|
150
|
+
@cloud_billing_stub.universe_domain
|
|
151
|
+
end
|
|
152
|
+
|
|
141
153
|
##
|
|
142
154
|
# Create a new CloudBilling client object.
|
|
143
155
|
#
|
|
@@ -171,8 +183,9 @@ module Google
|
|
|
171
183
|
credentials = @config.credentials
|
|
172
184
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
173
185
|
# but only if the default endpoint does not have a region prefix.
|
|
174
|
-
enable_self_signed_jwt = @config.endpoint
|
|
175
|
-
|
|
186
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
187
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
188
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
176
189
|
credentials ||= Credentials.default scope: @config.scope,
|
|
177
190
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
178
191
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -183,8 +196,10 @@ module Google
|
|
|
183
196
|
|
|
184
197
|
@cloud_billing_stub = ::Gapic::ServiceStub.new(
|
|
185
198
|
::Google::Cloud::Billing::V1::CloudBilling::Stub,
|
|
186
|
-
credentials:
|
|
187
|
-
endpoint:
|
|
199
|
+
credentials: credentials,
|
|
200
|
+
endpoint: @config.endpoint,
|
|
201
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
202
|
+
universe_domain: @config.universe_domain,
|
|
188
203
|
channel_args: @config.channel_args,
|
|
189
204
|
interceptors: @config.interceptors,
|
|
190
205
|
channel_pool_config: @config.channel_pool
|
|
@@ -1304,9 +1319,9 @@ module Google
|
|
|
1304
1319
|
# end
|
|
1305
1320
|
#
|
|
1306
1321
|
# @!attribute [rw] endpoint
|
|
1307
|
-
#
|
|
1308
|
-
#
|
|
1309
|
-
# @return [::String]
|
|
1322
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1323
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1324
|
+
# @return [::String,nil]
|
|
1310
1325
|
# @!attribute [rw] credentials
|
|
1311
1326
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1312
1327
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1352,13 +1367,20 @@ module Google
|
|
|
1352
1367
|
# @!attribute [rw] quota_project
|
|
1353
1368
|
# A separate project against which to charge quota.
|
|
1354
1369
|
# @return [::String]
|
|
1370
|
+
# @!attribute [rw] universe_domain
|
|
1371
|
+
# The universe domain within which to make requests. This determines the
|
|
1372
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1373
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1374
|
+
# @return [::String,nil]
|
|
1355
1375
|
#
|
|
1356
1376
|
class Configuration
|
|
1357
1377
|
extend ::Gapic::Config
|
|
1358
1378
|
|
|
1379
|
+
# @private
|
|
1380
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1359
1381
|
DEFAULT_ENDPOINT = "cloudbilling.googleapis.com"
|
|
1360
1382
|
|
|
1361
|
-
config_attr :endpoint,
|
|
1383
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1362
1384
|
config_attr :credentials, nil do |value|
|
|
1363
1385
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1364
1386
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1373,6 +1395,7 @@ module Google
|
|
|
1373
1395
|
config_attr :metadata, nil, ::Hash, nil
|
|
1374
1396
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1375
1397
|
config_attr :quota_project, nil, ::String, nil
|
|
1398
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1376
1399
|
|
|
1377
1400
|
# @private
|
|
1378
1401
|
def initialize parent_config = nil
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# projects.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudbilling.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -140,6 +143,15 @@ module Google
|
|
|
140
143
|
@config
|
|
141
144
|
end
|
|
142
145
|
|
|
146
|
+
##
|
|
147
|
+
# The effective universe domain
|
|
148
|
+
#
|
|
149
|
+
# @return [String]
|
|
150
|
+
#
|
|
151
|
+
def universe_domain
|
|
152
|
+
@cloud_billing_stub.universe_domain
|
|
153
|
+
end
|
|
154
|
+
|
|
143
155
|
##
|
|
144
156
|
# Create a new CloudBilling REST client object.
|
|
145
157
|
#
|
|
@@ -167,8 +179,9 @@ module Google
|
|
|
167
179
|
credentials = @config.credentials
|
|
168
180
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
169
181
|
# but only if the default endpoint does not have a region prefix.
|
|
170
|
-
enable_self_signed_jwt = @config.endpoint
|
|
171
|
-
|
|
182
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
183
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
184
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
172
185
|
credentials ||= Credentials.default scope: @config.scope,
|
|
173
186
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
174
187
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -178,7 +191,12 @@ module Google
|
|
|
178
191
|
@quota_project_id = @config.quota_project
|
|
179
192
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
180
193
|
|
|
181
|
-
@cloud_billing_stub = ::Google::Cloud::Billing::V1::CloudBilling::Rest::ServiceStub.new
|
|
194
|
+
@cloud_billing_stub = ::Google::Cloud::Billing::V1::CloudBilling::Rest::ServiceStub.new(
|
|
195
|
+
endpoint: @config.endpoint,
|
|
196
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
197
|
+
universe_domain: @config.universe_domain,
|
|
198
|
+
credentials: credentials
|
|
199
|
+
)
|
|
182
200
|
end
|
|
183
201
|
|
|
184
202
|
# Service calls
|
|
@@ -1233,9 +1251,9 @@ module Google
|
|
|
1233
1251
|
# end
|
|
1234
1252
|
#
|
|
1235
1253
|
# @!attribute [rw] endpoint
|
|
1236
|
-
#
|
|
1237
|
-
#
|
|
1238
|
-
# @return [::String]
|
|
1254
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1255
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1256
|
+
# @return [::String,nil]
|
|
1239
1257
|
# @!attribute [rw] credentials
|
|
1240
1258
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1241
1259
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1272,13 +1290,20 @@ module Google
|
|
|
1272
1290
|
# @!attribute [rw] quota_project
|
|
1273
1291
|
# A separate project against which to charge quota.
|
|
1274
1292
|
# @return [::String]
|
|
1293
|
+
# @!attribute [rw] universe_domain
|
|
1294
|
+
# The universe domain within which to make requests. This determines the
|
|
1295
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1296
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1297
|
+
# @return [::String,nil]
|
|
1275
1298
|
#
|
|
1276
1299
|
class Configuration
|
|
1277
1300
|
extend ::Gapic::Config
|
|
1278
1301
|
|
|
1302
|
+
# @private
|
|
1303
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1279
1304
|
DEFAULT_ENDPOINT = "cloudbilling.googleapis.com"
|
|
1280
1305
|
|
|
1281
|
-
config_attr :endpoint,
|
|
1306
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1282
1307
|
config_attr :credentials, nil do |value|
|
|
1283
1308
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1284
1309
|
allowed.any? { |klass| klass === value }
|
|
@@ -1290,6 +1315,7 @@ module Google
|
|
|
1290
1315
|
config_attr :metadata, nil, ::Hash, nil
|
|
1291
1316
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1292
1317
|
config_attr :quota_project, nil, ::String, nil
|
|
1318
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1293
1319
|
|
|
1294
1320
|
# @private
|
|
1295
1321
|
def initialize parent_config = nil
|
|
@@ -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 get_billing_account REST call
|
|
45
57
|
#
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# and SKUs.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudbilling.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -96,6 +99,15 @@ module Google
|
|
|
96
99
|
@config
|
|
97
100
|
end
|
|
98
101
|
|
|
102
|
+
##
|
|
103
|
+
# The effective universe domain
|
|
104
|
+
#
|
|
105
|
+
# @return [String]
|
|
106
|
+
#
|
|
107
|
+
def universe_domain
|
|
108
|
+
@cloud_catalog_stub.universe_domain
|
|
109
|
+
end
|
|
110
|
+
|
|
99
111
|
##
|
|
100
112
|
# Create a new CloudCatalog client object.
|
|
101
113
|
#
|
|
@@ -129,8 +141,9 @@ module Google
|
|
|
129
141
|
credentials = @config.credentials
|
|
130
142
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
131
143
|
# but only if the default endpoint does not have a region prefix.
|
|
132
|
-
enable_self_signed_jwt = @config.endpoint
|
|
133
|
-
|
|
144
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
145
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
134
147
|
credentials ||= Credentials.default scope: @config.scope,
|
|
135
148
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
136
149
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -141,8 +154,10 @@ module Google
|
|
|
141
154
|
|
|
142
155
|
@cloud_catalog_stub = ::Gapic::ServiceStub.new(
|
|
143
156
|
::Google::Cloud::Billing::V1::CloudCatalog::Stub,
|
|
144
|
-
credentials:
|
|
145
|
-
endpoint:
|
|
157
|
+
credentials: credentials,
|
|
158
|
+
endpoint: @config.endpoint,
|
|
159
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
160
|
+
universe_domain: @config.universe_domain,
|
|
146
161
|
channel_args: @config.channel_args,
|
|
147
162
|
interceptors: @config.interceptors,
|
|
148
163
|
channel_pool_config: @config.channel_pool
|
|
@@ -382,9 +397,9 @@ module Google
|
|
|
382
397
|
# end
|
|
383
398
|
#
|
|
384
399
|
# @!attribute [rw] endpoint
|
|
385
|
-
#
|
|
386
|
-
#
|
|
387
|
-
# @return [::String]
|
|
400
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
401
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
402
|
+
# @return [::String,nil]
|
|
388
403
|
# @!attribute [rw] credentials
|
|
389
404
|
# Credentials to send with calls. You may provide any of the following types:
|
|
390
405
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -430,13 +445,20 @@ module Google
|
|
|
430
445
|
# @!attribute [rw] quota_project
|
|
431
446
|
# A separate project against which to charge quota.
|
|
432
447
|
# @return [::String]
|
|
448
|
+
# @!attribute [rw] universe_domain
|
|
449
|
+
# The universe domain within which to make requests. This determines the
|
|
450
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
451
|
+
# universe (usually the default "googleapis.com" universe).
|
|
452
|
+
# @return [::String,nil]
|
|
433
453
|
#
|
|
434
454
|
class Configuration
|
|
435
455
|
extend ::Gapic::Config
|
|
436
456
|
|
|
457
|
+
# @private
|
|
458
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
437
459
|
DEFAULT_ENDPOINT = "cloudbilling.googleapis.com"
|
|
438
460
|
|
|
439
|
-
config_attr :endpoint,
|
|
461
|
+
config_attr :endpoint, nil, ::String, nil
|
|
440
462
|
config_attr :credentials, nil do |value|
|
|
441
463
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
442
464
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -451,6 +473,7 @@ module Google
|
|
|
451
473
|
config_attr :metadata, nil, ::Hash, nil
|
|
452
474
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
453
475
|
config_attr :quota_project, nil, ::String, nil
|
|
476
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
454
477
|
|
|
455
478
|
# @private
|
|
456
479
|
def initialize parent_config = nil
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# and SKUs.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudbilling.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -98,6 +101,15 @@ module Google
|
|
|
98
101
|
@config
|
|
99
102
|
end
|
|
100
103
|
|
|
104
|
+
##
|
|
105
|
+
# The effective universe domain
|
|
106
|
+
#
|
|
107
|
+
# @return [String]
|
|
108
|
+
#
|
|
109
|
+
def universe_domain
|
|
110
|
+
@cloud_catalog_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new CloudCatalog REST client object.
|
|
103
115
|
#
|
|
@@ -125,8 +137,9 @@ module Google
|
|
|
125
137
|
credentials = @config.credentials
|
|
126
138
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
127
139
|
# but only if the default endpoint does not have a region prefix.
|
|
128
|
-
enable_self_signed_jwt = @config.endpoint
|
|
129
|
-
|
|
140
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
141
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
142
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
130
143
|
credentials ||= Credentials.default scope: @config.scope,
|
|
131
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
132
145
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -136,7 +149,12 @@ module Google
|
|
|
136
149
|
@quota_project_id = @config.quota_project
|
|
137
150
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
138
151
|
|
|
139
|
-
@cloud_catalog_stub = ::Google::Cloud::Billing::V1::CloudCatalog::Rest::ServiceStub.new
|
|
152
|
+
@cloud_catalog_stub = ::Google::Cloud::Billing::V1::CloudCatalog::Rest::ServiceStub.new(
|
|
153
|
+
endpoint: @config.endpoint,
|
|
154
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
155
|
+
universe_domain: @config.universe_domain,
|
|
156
|
+
credentials: credentials
|
|
157
|
+
)
|
|
140
158
|
end
|
|
141
159
|
|
|
142
160
|
# Service calls
|
|
@@ -366,9 +384,9 @@ module Google
|
|
|
366
384
|
# end
|
|
367
385
|
#
|
|
368
386
|
# @!attribute [rw] endpoint
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
# @return [::String]
|
|
387
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
388
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
389
|
+
# @return [::String,nil]
|
|
372
390
|
# @!attribute [rw] credentials
|
|
373
391
|
# Credentials to send with calls. You may provide any of the following types:
|
|
374
392
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -405,13 +423,20 @@ module Google
|
|
|
405
423
|
# @!attribute [rw] quota_project
|
|
406
424
|
# A separate project against which to charge quota.
|
|
407
425
|
# @return [::String]
|
|
426
|
+
# @!attribute [rw] universe_domain
|
|
427
|
+
# The universe domain within which to make requests. This determines the
|
|
428
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
429
|
+
# universe (usually the default "googleapis.com" universe).
|
|
430
|
+
# @return [::String,nil]
|
|
408
431
|
#
|
|
409
432
|
class Configuration
|
|
410
433
|
extend ::Gapic::Config
|
|
411
434
|
|
|
435
|
+
# @private
|
|
436
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
412
437
|
DEFAULT_ENDPOINT = "cloudbilling.googleapis.com"
|
|
413
438
|
|
|
414
|
-
config_attr :endpoint,
|
|
439
|
+
config_attr :endpoint, nil, ::String, nil
|
|
415
440
|
config_attr :credentials, nil do |value|
|
|
416
441
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
417
442
|
allowed.any? { |klass| klass === value }
|
|
@@ -423,6 +448,7 @@ module Google
|
|
|
423
448
|
config_attr :metadata, nil, ::Hash, nil
|
|
424
449
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
425
450
|
config_attr :quota_project, nil, ::String, nil
|
|
451
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
426
452
|
|
|
427
453
|
# @private
|
|
428
454
|
def initialize parent_config = nil
|
|
@@ -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_services 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-billing-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:
|
|
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
|
|
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
239
239
|
- !ruby/object:Gem::Version
|
|
240
240
|
version: '0'
|
|
241
241
|
requirements: []
|
|
242
|
-
rubygems_version: 3.
|
|
242
|
+
rubygems_version: 3.5.3
|
|
243
243
|
signing_key:
|
|
244
244
|
specification_version: 4
|
|
245
245
|
summary: Allows developers to manage billing for their Google Cloud Platform projects
|