google-cloud-service_control-v1 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/service_control/v1/quota_controller/client.rb +31 -8
- data/lib/google/cloud/service_control/v1/quota_controller/rest/client.rb +33 -7
- data/lib/google/cloud/service_control/v1/quota_controller/rest/service_stub.rb +14 -2
- data/lib/google/cloud/service_control/v1/service_controller/client.rb +31 -8
- data/lib/google/cloud/service_control/v1/service_controller/rest/client.rb +33 -7
- data/lib/google/cloud/service_control/v1/service_controller/rest/service_stub.rb +14 -2
- data/lib/google/cloud/service_control/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -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: 91ae25c256669ce416fb52554cde9315f91a2c9b5c68e1585ab783d4e0a789db
|
|
4
|
+
data.tar.gz: f7c5a8470b01c4e31fb0fd0a86ac88d749a73d0fd50923b84d379cff5c9a3dbd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0206e8664115d82ea142b63dffd8945cb6bf90b68cb3ba3c965701f6b0edb2886ad94020668a8343f5f743cef31740eb61a5f953ead6ae4b16d579c07ee21c07
|
|
7
|
+
data.tar.gz: 1afb31c264b06c4097bc231e104b34b3a547d414602290706df00aa65351d2c3889c753db25ec869f7bf6666925c6141663804feccacec2727239cc945bf1717
|
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-service_control-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-service_control-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-service_control-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::ServiceControl::V1::QuotaController::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/service_control/v1"
|
|
77
|
-
|
|
78
|
-
ENV["SERVICE_CONTROL_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/service_control/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::ServiceControl::V1::QuotaController::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/service_control/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::ServiceControl::V1::QuotaController::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::ServiceControl::V1::QuotaController::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-service_control-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/service_control/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-service_control-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::ServiceControl::V1::QuotaController::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).
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicecontrol.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
# @private
|
|
37
40
|
attr_reader :quota_controller_stub
|
|
38
41
|
|
|
@@ -91,6 +94,15 @@ module Google
|
|
|
91
94
|
@config
|
|
92
95
|
end
|
|
93
96
|
|
|
97
|
+
##
|
|
98
|
+
# The effective universe domain
|
|
99
|
+
#
|
|
100
|
+
# @return [String]
|
|
101
|
+
#
|
|
102
|
+
def universe_domain
|
|
103
|
+
@quota_controller_stub.universe_domain
|
|
104
|
+
end
|
|
105
|
+
|
|
94
106
|
##
|
|
95
107
|
# Create a new QuotaController client object.
|
|
96
108
|
#
|
|
@@ -124,8 +136,9 @@ module Google
|
|
|
124
136
|
credentials = @config.credentials
|
|
125
137
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
126
138
|
# but only if the default endpoint does not have a region prefix.
|
|
127
|
-
enable_self_signed_jwt = @config.endpoint
|
|
128
|
-
|
|
139
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
140
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
141
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
129
142
|
credentials ||= Credentials.default scope: @config.scope,
|
|
130
143
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
131
144
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -136,8 +149,10 @@ module Google
|
|
|
136
149
|
|
|
137
150
|
@quota_controller_stub = ::Gapic::ServiceStub.new(
|
|
138
151
|
::Google::Cloud::ServiceControl::V1::QuotaController::Stub,
|
|
139
|
-
credentials:
|
|
140
|
-
endpoint:
|
|
152
|
+
credentials: credentials,
|
|
153
|
+
endpoint: @config.endpoint,
|
|
154
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
155
|
+
universe_domain: @config.universe_domain,
|
|
141
156
|
channel_args: @config.channel_args,
|
|
142
157
|
interceptors: @config.interceptors,
|
|
143
158
|
channel_pool_config: @config.channel_pool
|
|
@@ -280,9 +295,9 @@ module Google
|
|
|
280
295
|
# end
|
|
281
296
|
#
|
|
282
297
|
# @!attribute [rw] endpoint
|
|
283
|
-
#
|
|
284
|
-
#
|
|
285
|
-
# @return [::String]
|
|
298
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
299
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
300
|
+
# @return [::String,nil]
|
|
286
301
|
# @!attribute [rw] credentials
|
|
287
302
|
# Credentials to send with calls. You may provide any of the following types:
|
|
288
303
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -328,13 +343,20 @@ module Google
|
|
|
328
343
|
# @!attribute [rw] quota_project
|
|
329
344
|
# A separate project against which to charge quota.
|
|
330
345
|
# @return [::String]
|
|
346
|
+
# @!attribute [rw] universe_domain
|
|
347
|
+
# The universe domain within which to make requests. This determines the
|
|
348
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
349
|
+
# universe (usually the default "googleapis.com" universe).
|
|
350
|
+
# @return [::String,nil]
|
|
331
351
|
#
|
|
332
352
|
class Configuration
|
|
333
353
|
extend ::Gapic::Config
|
|
334
354
|
|
|
355
|
+
# @private
|
|
356
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
335
357
|
DEFAULT_ENDPOINT = "servicecontrol.googleapis.com"
|
|
336
358
|
|
|
337
|
-
config_attr :endpoint,
|
|
359
|
+
config_attr :endpoint, nil, ::String, nil
|
|
338
360
|
config_attr :credentials, nil do |value|
|
|
339
361
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
340
362
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -349,6 +371,7 @@ module Google
|
|
|
349
371
|
config_attr :metadata, nil, ::Hash, nil
|
|
350
372
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
351
373
|
config_attr :quota_project, nil, ::String, nil
|
|
374
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
352
375
|
|
|
353
376
|
# @private
|
|
354
377
|
def initialize parent_config = nil
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicecontrol.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
# @private
|
|
39
42
|
attr_reader :quota_controller_stub
|
|
40
43
|
|
|
@@ -93,6 +96,15 @@ module Google
|
|
|
93
96
|
@config
|
|
94
97
|
end
|
|
95
98
|
|
|
99
|
+
##
|
|
100
|
+
# The effective universe domain
|
|
101
|
+
#
|
|
102
|
+
# @return [String]
|
|
103
|
+
#
|
|
104
|
+
def universe_domain
|
|
105
|
+
@quota_controller_stub.universe_domain
|
|
106
|
+
end
|
|
107
|
+
|
|
96
108
|
##
|
|
97
109
|
# Create a new QuotaController REST client object.
|
|
98
110
|
#
|
|
@@ -120,8 +132,9 @@ module Google
|
|
|
120
132
|
credentials = @config.credentials
|
|
121
133
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
122
134
|
# but only if the default endpoint does not have a region prefix.
|
|
123
|
-
enable_self_signed_jwt = @config.endpoint
|
|
124
|
-
|
|
135
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
136
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
137
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
125
138
|
credentials ||= Credentials.default scope: @config.scope,
|
|
126
139
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
127
140
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -131,7 +144,12 @@ module Google
|
|
|
131
144
|
@quota_project_id = @config.quota_project
|
|
132
145
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
133
146
|
|
|
134
|
-
@quota_controller_stub = ::Google::Cloud::ServiceControl::V1::QuotaController::Rest::ServiceStub.new
|
|
147
|
+
@quota_controller_stub = ::Google::Cloud::ServiceControl::V1::QuotaController::Rest::ServiceStub.new(
|
|
148
|
+
endpoint: @config.endpoint,
|
|
149
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
150
|
+
universe_domain: @config.universe_domain,
|
|
151
|
+
credentials: credentials
|
|
152
|
+
)
|
|
135
153
|
end
|
|
136
154
|
|
|
137
155
|
# Service calls
|
|
@@ -263,9 +281,9 @@ module Google
|
|
|
263
281
|
# end
|
|
264
282
|
#
|
|
265
283
|
# @!attribute [rw] endpoint
|
|
266
|
-
#
|
|
267
|
-
#
|
|
268
|
-
# @return [::String]
|
|
284
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
285
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
286
|
+
# @return [::String,nil]
|
|
269
287
|
# @!attribute [rw] credentials
|
|
270
288
|
# Credentials to send with calls. You may provide any of the following types:
|
|
271
289
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -302,13 +320,20 @@ module Google
|
|
|
302
320
|
# @!attribute [rw] quota_project
|
|
303
321
|
# A separate project against which to charge quota.
|
|
304
322
|
# @return [::String]
|
|
323
|
+
# @!attribute [rw] universe_domain
|
|
324
|
+
# The universe domain within which to make requests. This determines the
|
|
325
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
326
|
+
# universe (usually the default "googleapis.com" universe).
|
|
327
|
+
# @return [::String,nil]
|
|
305
328
|
#
|
|
306
329
|
class Configuration
|
|
307
330
|
extend ::Gapic::Config
|
|
308
331
|
|
|
332
|
+
# @private
|
|
333
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
309
334
|
DEFAULT_ENDPOINT = "servicecontrol.googleapis.com"
|
|
310
335
|
|
|
311
|
-
config_attr :endpoint,
|
|
336
|
+
config_attr :endpoint, nil, ::String, nil
|
|
312
337
|
config_attr :credentials, nil do |value|
|
|
313
338
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
314
339
|
allowed.any? { |klass| klass === value }
|
|
@@ -320,6 +345,7 @@ module Google
|
|
|
320
345
|
config_attr :metadata, nil, ::Hash, nil
|
|
321
346
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
322
347
|
config_attr :quota_project, nil, ::String, nil
|
|
348
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
323
349
|
|
|
324
350
|
# @private
|
|
325
351
|
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 allocate_quota REST call
|
|
45
57
|
#
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicecontrol.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
# @private
|
|
37
40
|
attr_reader :service_controller_stub
|
|
38
41
|
|
|
@@ -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
|
+
@service_controller_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new ServiceController client object.
|
|
103
115
|
#
|
|
@@ -131,8 +143,9 @@ module Google
|
|
|
131
143
|
credentials = @config.credentials
|
|
132
144
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
133
145
|
# but only if the default endpoint does not have a region prefix.
|
|
134
|
-
enable_self_signed_jwt = @config.endpoint
|
|
135
|
-
|
|
146
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
147
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
148
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
136
149
|
credentials ||= Credentials.default scope: @config.scope,
|
|
137
150
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
138
151
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -143,8 +156,10 @@ module Google
|
|
|
143
156
|
|
|
144
157
|
@service_controller_stub = ::Gapic::ServiceStub.new(
|
|
145
158
|
::Google::Cloud::ServiceControl::V1::ServiceController::Stub,
|
|
146
|
-
credentials:
|
|
147
|
-
endpoint:
|
|
159
|
+
credentials: credentials,
|
|
160
|
+
endpoint: @config.endpoint,
|
|
161
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
162
|
+
universe_domain: @config.universe_domain,
|
|
148
163
|
channel_args: @config.channel_args,
|
|
149
164
|
interceptors: @config.interceptors,
|
|
150
165
|
channel_pool_config: @config.channel_pool
|
|
@@ -419,9 +434,9 @@ module Google
|
|
|
419
434
|
# end
|
|
420
435
|
#
|
|
421
436
|
# @!attribute [rw] endpoint
|
|
422
|
-
#
|
|
423
|
-
#
|
|
424
|
-
# @return [::String]
|
|
437
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
438
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
439
|
+
# @return [::String,nil]
|
|
425
440
|
# @!attribute [rw] credentials
|
|
426
441
|
# Credentials to send with calls. You may provide any of the following types:
|
|
427
442
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -467,13 +482,20 @@ module Google
|
|
|
467
482
|
# @!attribute [rw] quota_project
|
|
468
483
|
# A separate project against which to charge quota.
|
|
469
484
|
# @return [::String]
|
|
485
|
+
# @!attribute [rw] universe_domain
|
|
486
|
+
# The universe domain within which to make requests. This determines the
|
|
487
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
488
|
+
# universe (usually the default "googleapis.com" universe).
|
|
489
|
+
# @return [::String,nil]
|
|
470
490
|
#
|
|
471
491
|
class Configuration
|
|
472
492
|
extend ::Gapic::Config
|
|
473
493
|
|
|
494
|
+
# @private
|
|
495
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
474
496
|
DEFAULT_ENDPOINT = "servicecontrol.googleapis.com"
|
|
475
497
|
|
|
476
|
-
config_attr :endpoint,
|
|
498
|
+
config_attr :endpoint, nil, ::String, nil
|
|
477
499
|
config_attr :credentials, nil do |value|
|
|
478
500
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
479
501
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -488,6 +510,7 @@ module Google
|
|
|
488
510
|
config_attr :metadata, nil, ::Hash, nil
|
|
489
511
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
490
512
|
config_attr :quota_project, nil, ::String, nil
|
|
513
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
491
514
|
|
|
492
515
|
# @private
|
|
493
516
|
def initialize parent_config = nil
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicecontrol.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
# @private
|
|
39
42
|
attr_reader :service_controller_stub
|
|
40
43
|
|
|
@@ -100,6 +103,15 @@ module Google
|
|
|
100
103
|
@config
|
|
101
104
|
end
|
|
102
105
|
|
|
106
|
+
##
|
|
107
|
+
# The effective universe domain
|
|
108
|
+
#
|
|
109
|
+
# @return [String]
|
|
110
|
+
#
|
|
111
|
+
def universe_domain
|
|
112
|
+
@service_controller_stub.universe_domain
|
|
113
|
+
end
|
|
114
|
+
|
|
103
115
|
##
|
|
104
116
|
# Create a new ServiceController REST client object.
|
|
105
117
|
#
|
|
@@ -127,8 +139,9 @@ module Google
|
|
|
127
139
|
credentials = @config.credentials
|
|
128
140
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
129
141
|
# but only if the default endpoint does not have a region prefix.
|
|
130
|
-
enable_self_signed_jwt = @config.endpoint
|
|
131
|
-
|
|
142
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
143
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
144
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
132
145
|
credentials ||= Credentials.default scope: @config.scope,
|
|
133
146
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
134
147
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -138,7 +151,12 @@ module Google
|
|
|
138
151
|
@quota_project_id = @config.quota_project
|
|
139
152
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
140
153
|
|
|
141
|
-
@service_controller_stub = ::Google::Cloud::ServiceControl::V1::ServiceController::Rest::ServiceStub.new
|
|
154
|
+
@service_controller_stub = ::Google::Cloud::ServiceControl::V1::ServiceController::Rest::ServiceStub.new(
|
|
155
|
+
endpoint: @config.endpoint,
|
|
156
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
157
|
+
universe_domain: @config.universe_domain,
|
|
158
|
+
credentials: credentials
|
|
159
|
+
)
|
|
142
160
|
end
|
|
143
161
|
|
|
144
162
|
# Service calls
|
|
@@ -395,9 +413,9 @@ module Google
|
|
|
395
413
|
# end
|
|
396
414
|
#
|
|
397
415
|
# @!attribute [rw] endpoint
|
|
398
|
-
#
|
|
399
|
-
#
|
|
400
|
-
# @return [::String]
|
|
416
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
417
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
418
|
+
# @return [::String,nil]
|
|
401
419
|
# @!attribute [rw] credentials
|
|
402
420
|
# Credentials to send with calls. You may provide any of the following types:
|
|
403
421
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -434,13 +452,20 @@ module Google
|
|
|
434
452
|
# @!attribute [rw] quota_project
|
|
435
453
|
# A separate project against which to charge quota.
|
|
436
454
|
# @return [::String]
|
|
455
|
+
# @!attribute [rw] universe_domain
|
|
456
|
+
# The universe domain within which to make requests. This determines the
|
|
457
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
458
|
+
# universe (usually the default "googleapis.com" universe).
|
|
459
|
+
# @return [::String,nil]
|
|
437
460
|
#
|
|
438
461
|
class Configuration
|
|
439
462
|
extend ::Gapic::Config
|
|
440
463
|
|
|
464
|
+
# @private
|
|
465
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
441
466
|
DEFAULT_ENDPOINT = "servicecontrol.googleapis.com"
|
|
442
467
|
|
|
443
|
-
config_attr :endpoint,
|
|
468
|
+
config_attr :endpoint, nil, ::String, nil
|
|
444
469
|
config_attr :credentials, nil do |value|
|
|
445
470
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
446
471
|
allowed.any? { |klass| klass === value }
|
|
@@ -452,6 +477,7 @@ module Google
|
|
|
452
477
|
config_attr :metadata, nil, ::Hash, nil
|
|
453
478
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
454
479
|
config_attr :quota_project, nil, ::String, nil
|
|
480
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
455
481
|
|
|
456
482
|
# @private
|
|
457
483
|
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 check 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
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-service_control-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.9.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
|
|
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
234
234
|
- !ruby/object:Gem::Version
|
|
235
235
|
version: '0'
|
|
236
236
|
requirements: []
|
|
237
|
-
rubygems_version: 3.
|
|
237
|
+
rubygems_version: 3.5.3
|
|
238
238
|
signing_key:
|
|
239
239
|
specification_version: 4
|
|
240
240
|
summary: Provides admission control and telemetry reporting for services integrated
|