google-cloud-resource_settings-v1 0.4.1 → 0.6.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/resource_settings/v1/resource_settings_service/client.rb +41 -9
- data/lib/google/cloud/resource_settings/v1/resource_settings_service/rest/client.rb +85 -7
- data/lib/google/cloud/resource_settings/v1/resource_settings_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_settings/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.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: e40ed694d7540169fdb57506727eba5615a85f56f77ef69cab3a39287eee21c9
|
4
|
+
data.tar.gz: dac994c46d4af83371ff7d99ce7d0bdf6a2e56d170272e11a092ca8f99f6b764
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a7cd9ffc0164dfbc2316d605b79e94249de2664457ab9180d70d5bec3b814fb208297585a56ef896e567a304f0b595e868cb488bcbe7ae7e556a6e3f3381c383
|
7
|
+
data.tar.gz: a4d678c9a3612cdb424d775079ba328b5832ac1335f8d1caac236073de331531a93a9c86de6ad536397ab087e64ee42ae1751dae2aacee06ff1f551ec2587d14
|
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-resource_settings-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-resource_settings-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-resource_settings-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::ResourceSettings::V1::ResourceSettingsService::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/resource_settings/v1"
|
77
|
-
|
78
|
-
ENV["RESOURCE_SETTINGS_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/resource_settings/v1"
|
90
58
|
|
91
59
|
client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::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/resource_settings/v1"
|
100
68
|
|
101
69
|
::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::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::ResourceSettings::V1::ResourceSettingsService::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-resource_settings-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/resource_settings/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-resource_settings-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::ResourceSettings::V1::ResourceSettingsService::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).
|
@@ -41,6 +41,9 @@ module Google
|
|
41
41
|
# `google.rpc.Code.INVALID_ARGUMENT` if the request is malformed.
|
42
42
|
#
|
43
43
|
class Client
|
44
|
+
# @private
|
45
|
+
DEFAULT_ENDPOINT_TEMPLATE = "resourcesettings.$UNIVERSE_DOMAIN$"
|
46
|
+
|
44
47
|
include Paths
|
45
48
|
|
46
49
|
# @private
|
@@ -116,6 +119,15 @@ module Google
|
|
116
119
|
@config
|
117
120
|
end
|
118
121
|
|
122
|
+
##
|
123
|
+
# The effective universe domain
|
124
|
+
#
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
def universe_domain
|
128
|
+
@resource_settings_service_stub.universe_domain
|
129
|
+
end
|
130
|
+
|
119
131
|
##
|
120
132
|
# Create a new ResourceSettingsService client object.
|
121
133
|
#
|
@@ -149,8 +161,9 @@ module Google
|
|
149
161
|
credentials = @config.credentials
|
150
162
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
151
163
|
# but only if the default endpoint does not have a region prefix.
|
152
|
-
enable_self_signed_jwt = @config.endpoint
|
153
|
-
|
164
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
165
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
166
|
+
!@config.endpoint.split(".").first.include?("-"))
|
154
167
|
credentials ||= Credentials.default scope: @config.scope,
|
155
168
|
enable_self_signed_jwt: enable_self_signed_jwt
|
156
169
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -161,10 +174,13 @@ module Google
|
|
161
174
|
|
162
175
|
@resource_settings_service_stub = ::Gapic::ServiceStub.new(
|
163
176
|
::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Stub,
|
164
|
-
credentials:
|
165
|
-
endpoint:
|
177
|
+
credentials: credentials,
|
178
|
+
endpoint: @config.endpoint,
|
179
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
180
|
+
universe_domain: @config.universe_domain,
|
166
181
|
channel_args: @config.channel_args,
|
167
|
-
interceptors: @config.interceptors
|
182
|
+
interceptors: @config.interceptors,
|
183
|
+
channel_pool_config: @config.channel_pool
|
168
184
|
)
|
169
185
|
end
|
170
186
|
|
@@ -493,9 +509,9 @@ module Google
|
|
493
509
|
# end
|
494
510
|
#
|
495
511
|
# @!attribute [rw] endpoint
|
496
|
-
#
|
497
|
-
#
|
498
|
-
# @return [::String]
|
512
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
513
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
514
|
+
# @return [::String,nil]
|
499
515
|
# @!attribute [rw] credentials
|
500
516
|
# Credentials to send with calls. You may provide any of the following types:
|
501
517
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -541,13 +557,20 @@ module Google
|
|
541
557
|
# @!attribute [rw] quota_project
|
542
558
|
# A separate project against which to charge quota.
|
543
559
|
# @return [::String]
|
560
|
+
# @!attribute [rw] universe_domain
|
561
|
+
# The universe domain within which to make requests. This determines the
|
562
|
+
# default endpoint URL. The default value of nil uses the environment
|
563
|
+
# universe (usually the default "googleapis.com" universe).
|
564
|
+
# @return [::String,nil]
|
544
565
|
#
|
545
566
|
class Configuration
|
546
567
|
extend ::Gapic::Config
|
547
568
|
|
569
|
+
# @private
|
570
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
548
571
|
DEFAULT_ENDPOINT = "resourcesettings.googleapis.com"
|
549
572
|
|
550
|
-
config_attr :endpoint,
|
573
|
+
config_attr :endpoint, nil, ::String, nil
|
551
574
|
config_attr :credentials, nil do |value|
|
552
575
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
553
576
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -562,6 +585,7 @@ module Google
|
|
562
585
|
config_attr :metadata, nil, ::Hash, nil
|
563
586
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
564
587
|
config_attr :quota_project, nil, ::String, nil
|
588
|
+
config_attr :universe_domain, nil, ::String, nil
|
565
589
|
|
566
590
|
# @private
|
567
591
|
def initialize parent_config = nil
|
@@ -582,6 +606,14 @@ module Google
|
|
582
606
|
end
|
583
607
|
end
|
584
608
|
|
609
|
+
##
|
610
|
+
# Configuration for the channel pool
|
611
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
612
|
+
#
|
613
|
+
def channel_pool
|
614
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
615
|
+
end
|
616
|
+
|
585
617
|
##
|
586
618
|
# Configuration RPC class for the ResourceSettingsService API.
|
587
619
|
#
|
@@ -43,6 +43,9 @@ module Google
|
|
43
43
|
# `google.rpc.Code.INVALID_ARGUMENT` if the request is malformed.
|
44
44
|
#
|
45
45
|
class Client
|
46
|
+
# @private
|
47
|
+
DEFAULT_ENDPOINT_TEMPLATE = "resourcesettings.$UNIVERSE_DOMAIN$"
|
48
|
+
|
46
49
|
include Paths
|
47
50
|
|
48
51
|
# @private
|
@@ -118,6 +121,15 @@ module Google
|
|
118
121
|
@config
|
119
122
|
end
|
120
123
|
|
124
|
+
##
|
125
|
+
# The effective universe domain
|
126
|
+
#
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
def universe_domain
|
130
|
+
@resource_settings_service_stub.universe_domain
|
131
|
+
end
|
132
|
+
|
121
133
|
##
|
122
134
|
# Create a new ResourceSettingsService REST client object.
|
123
135
|
#
|
@@ -145,8 +157,9 @@ module Google
|
|
145
157
|
credentials = @config.credentials
|
146
158
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
147
159
|
# but only if the default endpoint does not have a region prefix.
|
148
|
-
enable_self_signed_jwt = @config.endpoint
|
149
|
-
|
160
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
161
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
162
|
+
!@config.endpoint.split(".").first.include?("-"))
|
150
163
|
credentials ||= Credentials.default scope: @config.scope,
|
151
164
|
enable_self_signed_jwt: enable_self_signed_jwt
|
152
165
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -156,7 +169,12 @@ module Google
|
|
156
169
|
@quota_project_id = @config.quota_project
|
157
170
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
158
171
|
|
159
|
-
@resource_settings_service_stub = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Rest::ServiceStub.new
|
172
|
+
@resource_settings_service_stub = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Rest::ServiceStub.new(
|
173
|
+
endpoint: @config.endpoint,
|
174
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
175
|
+
universe_domain: @config.universe_domain,
|
176
|
+
credentials: credentials
|
177
|
+
)
|
160
178
|
end
|
161
179
|
|
162
180
|
# Service calls
|
@@ -200,6 +218,26 @@ module Google
|
|
200
218
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceSettings::V1::Setting>]
|
201
219
|
#
|
202
220
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
221
|
+
#
|
222
|
+
# @example Basic example
|
223
|
+
# require "google/cloud/resource_settings/v1"
|
224
|
+
#
|
225
|
+
# # Create a client object. The client can be reused for multiple calls.
|
226
|
+
# client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Rest::Client.new
|
227
|
+
#
|
228
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
229
|
+
# request = Google::Cloud::ResourceSettings::V1::ListSettingsRequest.new
|
230
|
+
#
|
231
|
+
# # Call the list_settings method.
|
232
|
+
# result = client.list_settings request
|
233
|
+
#
|
234
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
235
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
236
|
+
# result.each do |item|
|
237
|
+
# # Each element is of type ::Google::Cloud::ResourceSettings::V1::Setting.
|
238
|
+
# p item
|
239
|
+
# end
|
240
|
+
#
|
203
241
|
def list_settings request, options = nil
|
204
242
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
205
243
|
|
@@ -269,6 +307,22 @@ module Google
|
|
269
307
|
# @return [::Google::Cloud::ResourceSettings::V1::Setting]
|
270
308
|
#
|
271
309
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
310
|
+
#
|
311
|
+
# @example Basic example
|
312
|
+
# require "google/cloud/resource_settings/v1"
|
313
|
+
#
|
314
|
+
# # Create a client object. The client can be reused for multiple calls.
|
315
|
+
# client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Rest::Client.new
|
316
|
+
#
|
317
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
318
|
+
# request = Google::Cloud::ResourceSettings::V1::GetSettingRequest.new
|
319
|
+
#
|
320
|
+
# # Call the get_setting method.
|
321
|
+
# result = client.get_setting request
|
322
|
+
#
|
323
|
+
# # The returned object is of type Google::Cloud::ResourceSettings::V1::Setting.
|
324
|
+
# p result
|
325
|
+
#
|
272
326
|
def get_setting request, options = nil
|
273
327
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
274
328
|
|
@@ -346,6 +400,22 @@ module Google
|
|
346
400
|
# @return [::Google::Cloud::ResourceSettings::V1::Setting]
|
347
401
|
#
|
348
402
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
403
|
+
#
|
404
|
+
# @example Basic example
|
405
|
+
# require "google/cloud/resource_settings/v1"
|
406
|
+
#
|
407
|
+
# # Create a client object. The client can be reused for multiple calls.
|
408
|
+
# client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Rest::Client.new
|
409
|
+
#
|
410
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
411
|
+
# request = Google::Cloud::ResourceSettings::V1::UpdateSettingRequest.new
|
412
|
+
#
|
413
|
+
# # Call the update_setting method.
|
414
|
+
# result = client.update_setting request
|
415
|
+
#
|
416
|
+
# # The returned object is of type Google::Cloud::ResourceSettings::V1::Setting.
|
417
|
+
# p result
|
418
|
+
#
|
349
419
|
def update_setting request, options = nil
|
350
420
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
351
421
|
|
@@ -411,9 +481,9 @@ module Google
|
|
411
481
|
# end
|
412
482
|
#
|
413
483
|
# @!attribute [rw] endpoint
|
414
|
-
#
|
415
|
-
#
|
416
|
-
# @return [::String]
|
484
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
485
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
486
|
+
# @return [::String,nil]
|
417
487
|
# @!attribute [rw] credentials
|
418
488
|
# Credentials to send with calls. You may provide any of the following types:
|
419
489
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -450,13 +520,20 @@ module Google
|
|
450
520
|
# @!attribute [rw] quota_project
|
451
521
|
# A separate project against which to charge quota.
|
452
522
|
# @return [::String]
|
523
|
+
# @!attribute [rw] universe_domain
|
524
|
+
# The universe domain within which to make requests. This determines the
|
525
|
+
# default endpoint URL. The default value of nil uses the environment
|
526
|
+
# universe (usually the default "googleapis.com" universe).
|
527
|
+
# @return [::String,nil]
|
453
528
|
#
|
454
529
|
class Configuration
|
455
530
|
extend ::Gapic::Config
|
456
531
|
|
532
|
+
# @private
|
533
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
457
534
|
DEFAULT_ENDPOINT = "resourcesettings.googleapis.com"
|
458
535
|
|
459
|
-
config_attr :endpoint,
|
536
|
+
config_attr :endpoint, nil, ::String, nil
|
460
537
|
config_attr :credentials, nil do |value|
|
461
538
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
462
539
|
allowed.any? { |klass| klass === value }
|
@@ -468,6 +545,7 @@ module Google
|
|
468
545
|
config_attr :metadata, nil, ::Hash, nil
|
469
546
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
470
547
|
config_attr :quota_project, nil, ::String, nil
|
548
|
+
config_attr :universe_domain, nil, ::String, nil
|
471
549
|
|
472
550
|
# @private
|
473
551
|
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_settings 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
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-resource_settings-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.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
|
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
210
210
|
- !ruby/object:Gem::Version
|
211
211
|
version: '0'
|
212
212
|
requirements: []
|
213
|
-
rubygems_version: 3.
|
213
|
+
rubygems_version: 3.5.3
|
214
214
|
signing_key:
|
215
215
|
specification_version: 4
|
216
216
|
summary: The Resource Settings API allows users to control and modify the behavior
|