google-cloud-resource_settings-v1 0.1.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 +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google-cloud-resource_settings-v1.rb +21 -0
- data/lib/google/cloud/resource_settings/v1.rb +38 -0
- data/lib/google/cloud/resource_settings/v1/resource_settings_service.rb +60 -0
- data/lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb +574 -0
- data/lib/google/cloud/resource_settings/v1/resource_settings_service/credentials.rb +51 -0
- data/lib/google/cloud/resource_settings/v1/resource_settings_service/paths.rb +85 -0
- data/lib/google/cloud/resource_settings/v1/version.rb +28 -0
- data/lib/google/cloud/resourcesettings/v1/resource_settings_pb.rb +91 -0
- data/lib/google/cloud/resourcesettings/v1/resource_settings_services_pb.rb +78 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +65 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb +229 -0
- metadata +210 -0
@@ -0,0 +1,229 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module ResourceSettings
|
23
|
+
module V1
|
24
|
+
# The schema for settings.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# The resource name of the setting. Must be in one of the following forms:
|
28
|
+
#
|
29
|
+
# * `projects/{project_number}/settings/{setting_name}`
|
30
|
+
# * `folders/{folder_id}/settings/{setting_name}`
|
31
|
+
# * `organizations/{organization_id}/settings/{setting_name}`
|
32
|
+
#
|
33
|
+
# For example, "/projects/123/settings/gcp-enableMyFeature"
|
34
|
+
# @!attribute [r] metadata
|
35
|
+
# @return [::Google::Cloud::ResourceSettings::V1::SettingMetadata]
|
36
|
+
# Output only. Metadata about a setting which is not editable by the end user.
|
37
|
+
# @!attribute [rw] local_value
|
38
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Value]
|
39
|
+
# The configured value of the setting at the given parent resource (ignoring
|
40
|
+
# the resource hierarchy). The data type of {::Google::Cloud::ResourceSettings::V1::Value Value} must always be
|
41
|
+
# consistent with the data type defined in {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}.
|
42
|
+
# @!attribute [r] effective_value
|
43
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Value]
|
44
|
+
# Output only. The computed effective value of the setting at the given parent resource
|
45
|
+
# (based on the resource hierarchy).
|
46
|
+
#
|
47
|
+
# The effective value evaluates to one of the following options in the given
|
48
|
+
# order (the next option is used if the previous one does not exist):
|
49
|
+
#
|
50
|
+
# 1. the local setting value on the given resource: {::Google::Cloud::ResourceSettings::V1::Setting#local_value Setting.local_value}
|
51
|
+
# 2. if one of the given resource's ancestors have a local setting value,
|
52
|
+
# the local value at the nearest such ancestor
|
53
|
+
# 3. the setting's default value: {::Google::Cloud::ResourceSettings::V1::SettingMetadata#default_value SettingMetadata.default_value}
|
54
|
+
# 4. an empty value (defined as a `Value` with all fields unset)
|
55
|
+
#
|
56
|
+
# The data type of {::Google::Cloud::ResourceSettings::V1::Value Value} must always be
|
57
|
+
# consistent with the data type defined in {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}.
|
58
|
+
# @!attribute [rw] etag
|
59
|
+
# @return [::String]
|
60
|
+
# A fingerprint used for optimistic concurrency. See
|
61
|
+
# {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client#update_setting UpdateSetting} for more
|
62
|
+
# details.
|
63
|
+
class Setting
|
64
|
+
include ::Google::Protobuf::MessageExts
|
65
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
66
|
+
end
|
67
|
+
|
68
|
+
# Metadata about a setting which is not editable by the end user.
|
69
|
+
# @!attribute [rw] display_name
|
70
|
+
# @return [::String]
|
71
|
+
# The human readable name for this setting.
|
72
|
+
# @!attribute [rw] description
|
73
|
+
# @return [::String]
|
74
|
+
# A detailed description of what this setting does.
|
75
|
+
# @!attribute [rw] read_only
|
76
|
+
# @return [::Boolean]
|
77
|
+
# A flag indicating that values of this setting cannot be modified (see
|
78
|
+
# documentation of the specific setting for updates and reasons).
|
79
|
+
# @!attribute [rw] data_type
|
80
|
+
# @return [::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType]
|
81
|
+
# The data type for this setting.
|
82
|
+
# @!attribute [rw] default_value
|
83
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Value]
|
84
|
+
# The value provided by {::Google::Cloud::ResourceSettings::V1::Setting#effective_value Setting.effective_value} if no setting value is
|
85
|
+
# explicitly set.
|
86
|
+
#
|
87
|
+
# Note: not all settings have a default value.
|
88
|
+
class SettingMetadata
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
|
92
|
+
# The data type for setting values of this setting. See {::Google::Cloud::ResourceSettings::V1::Value Value} for more
|
93
|
+
# details on the available data types.
|
94
|
+
module DataType
|
95
|
+
# Unspecified data type.
|
96
|
+
DATA_TYPE_UNSPECIFIED = 0
|
97
|
+
|
98
|
+
# A boolean setting.
|
99
|
+
BOOLEAN = 1
|
100
|
+
|
101
|
+
# A string setting.
|
102
|
+
STRING = 2
|
103
|
+
|
104
|
+
# A string set setting.
|
105
|
+
STRING_SET = 3
|
106
|
+
|
107
|
+
# A Enum setting
|
108
|
+
ENUM_VALUE = 4
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# The data in a setting value.
|
113
|
+
# @!attribute [rw] boolean_value
|
114
|
+
# @return [::Boolean]
|
115
|
+
# Defines this value as being a boolean value.
|
116
|
+
# @!attribute [rw] string_value
|
117
|
+
# @return [::String]
|
118
|
+
# Defines this value as being a string value.
|
119
|
+
# @!attribute [rw] string_set_value
|
120
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Value::StringSet]
|
121
|
+
# Defines this value as being a StringSet.
|
122
|
+
# @!attribute [rw] enum_value
|
123
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Value::EnumValue]
|
124
|
+
# Defines this value as being a Enum.
|
125
|
+
class Value
|
126
|
+
include ::Google::Protobuf::MessageExts
|
127
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
128
|
+
|
129
|
+
# A string set value that can hold a set of strings. The maximum length of
|
130
|
+
# each string is 200 characters and there can be a maximum of 50 strings in
|
131
|
+
# the string set.
|
132
|
+
# @!attribute [rw] values
|
133
|
+
# @return [::Array<::String>]
|
134
|
+
# The strings in the set
|
135
|
+
class StringSet
|
136
|
+
include ::Google::Protobuf::MessageExts
|
137
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
138
|
+
end
|
139
|
+
|
140
|
+
# A enum value that can hold any enum type setting values.
|
141
|
+
# Each enum type is represented by a number, this representation
|
142
|
+
# is stored in the definitions.
|
143
|
+
# @!attribute [rw] value
|
144
|
+
# @return [::String]
|
145
|
+
# The value of this enum
|
146
|
+
class EnumValue
|
147
|
+
include ::Google::Protobuf::MessageExts
|
148
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
# The request for ListSettings.
|
153
|
+
# @!attribute [rw] parent
|
154
|
+
# @return [::String]
|
155
|
+
# Required. The Cloud resource that parents the setting. Must be in one of the
|
156
|
+
# following forms:
|
157
|
+
#
|
158
|
+
# * `projects/{project_number}`
|
159
|
+
# * `projects/{project_id}`
|
160
|
+
# * `folders/{folder_id}`
|
161
|
+
# * `organizations/{organization_id}`
|
162
|
+
# @!attribute [rw] page_size
|
163
|
+
# @return [::Integer]
|
164
|
+
# Unused. The size of the page to be returned.
|
165
|
+
# @!attribute [rw] page_token
|
166
|
+
# @return [::String]
|
167
|
+
# Unused. A page token used to retrieve the next page.
|
168
|
+
# @!attribute [rw] view
|
169
|
+
# @return [::Google::Cloud::ResourceSettings::V1::SettingView]
|
170
|
+
# The SettingView for this request.
|
171
|
+
class ListSettingsRequest
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# The response from ListSettings.
|
177
|
+
# @!attribute [rw] settings
|
178
|
+
# @return [::Array<::Google::Cloud::ResourceSettings::V1::Setting>]
|
179
|
+
# A list of settings that are available at the specified Cloud resource.
|
180
|
+
# @!attribute [rw] next_page_token
|
181
|
+
# @return [::String]
|
182
|
+
# Unused. A page token used to retrieve the next page.
|
183
|
+
class ListSettingsResponse
|
184
|
+
include ::Google::Protobuf::MessageExts
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
186
|
+
end
|
187
|
+
|
188
|
+
# The request for GetSetting.
|
189
|
+
# @!attribute [rw] name
|
190
|
+
# @return [::String]
|
191
|
+
# Required. The name of the setting to get. See {::Google::Cloud::ResourceSettings::V1::Setting Setting} for naming
|
192
|
+
# requirements.
|
193
|
+
# @!attribute [rw] view
|
194
|
+
# @return [::Google::Cloud::ResourceSettings::V1::SettingView]
|
195
|
+
# The SettingView for this request.
|
196
|
+
class GetSettingRequest
|
197
|
+
include ::Google::Protobuf::MessageExts
|
198
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
199
|
+
end
|
200
|
+
|
201
|
+
# The request for UpdateSetting.
|
202
|
+
# @!attribute [rw] setting
|
203
|
+
# @return [::Google::Cloud::ResourceSettings::V1::Setting]
|
204
|
+
# Required. The setting to update. See {::Google::Cloud::ResourceSettings::V1::Setting Setting} for field requirements.
|
205
|
+
class UpdateSettingRequest
|
206
|
+
include ::Google::Protobuf::MessageExts
|
207
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
208
|
+
end
|
209
|
+
|
210
|
+
# View options for Settings.
|
211
|
+
module SettingView
|
212
|
+
# The default / unset value.
|
213
|
+
# The API will default to the SETTING_VIEW_BASIC view.
|
214
|
+
SETTING_VIEW_UNSPECIFIED = 0
|
215
|
+
|
216
|
+
# Include {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}, but nothing else.
|
217
|
+
# This is the default value (for both ListSettings and GetSetting).
|
218
|
+
SETTING_VIEW_BASIC = 1
|
219
|
+
|
220
|
+
# Include {::Google::Cloud::ResourceSettings::V1::Setting#effective_value Setting.effective_value}, but nothing else.
|
221
|
+
SETTING_VIEW_EFFECTIVE_VALUE = 2
|
222
|
+
|
223
|
+
# Include {::Google::Cloud::ResourceSettings::V1::Setting#local_value Setting.local_value}, but nothing else.
|
224
|
+
SETTING_VIEW_LOCAL_VALUE = 3
|
225
|
+
end
|
226
|
+
end
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|
metadata
ADDED
@@ -0,0 +1,210 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-cloud-resource_settings-v1
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-06-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: gapic-common
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.5'
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 2.a
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0.5'
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 2.a
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: google-cloud-errors
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.0'
|
40
|
+
type: :runtime
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.0'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: google-style
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 1.25.1
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 1.25.1
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: minitest
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '5.14'
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '5.14'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: minitest-focus
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '1.1'
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '1.1'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: minitest-rg
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '5.2'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '5.2'
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: rake
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '12.0'
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '12.0'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: redcarpet
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - "~>"
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '3.0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - "~>"
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '3.0'
|
131
|
+
- !ruby/object:Gem::Dependency
|
132
|
+
name: simplecov
|
133
|
+
requirement: !ruby/object:Gem::Requirement
|
134
|
+
requirements:
|
135
|
+
- - "~>"
|
136
|
+
- !ruby/object:Gem::Version
|
137
|
+
version: '0.18'
|
138
|
+
type: :development
|
139
|
+
prerelease: false
|
140
|
+
version_requirements: !ruby/object:Gem::Requirement
|
141
|
+
requirements:
|
142
|
+
- - "~>"
|
143
|
+
- !ruby/object:Gem::Version
|
144
|
+
version: '0.18'
|
145
|
+
- !ruby/object:Gem::Dependency
|
146
|
+
name: yard
|
147
|
+
requirement: !ruby/object:Gem::Requirement
|
148
|
+
requirements:
|
149
|
+
- - "~>"
|
150
|
+
- !ruby/object:Gem::Version
|
151
|
+
version: '0.9'
|
152
|
+
type: :development
|
153
|
+
prerelease: false
|
154
|
+
version_requirements: !ruby/object:Gem::Requirement
|
155
|
+
requirements:
|
156
|
+
- - "~>"
|
157
|
+
- !ruby/object:Gem::Version
|
158
|
+
version: '0.9'
|
159
|
+
description: You can use Resource Settings to centrally configure settings for your
|
160
|
+
Google Cloud projects, folders, and organization. These settings are inherited by
|
161
|
+
their descendants in the resource hierarchy. Each setting is created and managed
|
162
|
+
by Google. Note that google-cloud-resource_settings-v1 is a version-specific client
|
163
|
+
library. For most uses, we recommend installing the main client library google-cloud-resource_settings
|
164
|
+
instead. See the readme for more details.
|
165
|
+
email: googleapis-packages@google.com
|
166
|
+
executables: []
|
167
|
+
extensions: []
|
168
|
+
extra_rdoc_files: []
|
169
|
+
files:
|
170
|
+
- ".yardopts"
|
171
|
+
- AUTHENTICATION.md
|
172
|
+
- LICENSE.md
|
173
|
+
- README.md
|
174
|
+
- lib/google-cloud-resource_settings-v1.rb
|
175
|
+
- lib/google/cloud/resource_settings/v1.rb
|
176
|
+
- lib/google/cloud/resource_settings/v1/resource_settings_service.rb
|
177
|
+
- lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb
|
178
|
+
- lib/google/cloud/resource_settings/v1/resource_settings_service/credentials.rb
|
179
|
+
- lib/google/cloud/resource_settings/v1/resource_settings_service/paths.rb
|
180
|
+
- lib/google/cloud/resource_settings/v1/version.rb
|
181
|
+
- lib/google/cloud/resourcesettings/v1/resource_settings_pb.rb
|
182
|
+
- lib/google/cloud/resourcesettings/v1/resource_settings_services_pb.rb
|
183
|
+
- proto_docs/README.md
|
184
|
+
- proto_docs/google/api/field_behavior.rb
|
185
|
+
- proto_docs/google/api/resource.rb
|
186
|
+
- proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb
|
187
|
+
homepage: https://github.com/googleapis/google-cloud-ruby
|
188
|
+
licenses:
|
189
|
+
- Apache-2.0
|
190
|
+
metadata: {}
|
191
|
+
post_install_message:
|
192
|
+
rdoc_options: []
|
193
|
+
require_paths:
|
194
|
+
- lib
|
195
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
196
|
+
requirements:
|
197
|
+
- - ">="
|
198
|
+
- !ruby/object:Gem::Version
|
199
|
+
version: '2.5'
|
200
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
201
|
+
requirements:
|
202
|
+
- - ">="
|
203
|
+
- !ruby/object:Gem::Version
|
204
|
+
version: '0'
|
205
|
+
requirements: []
|
206
|
+
rubygems_version: 3.2.17
|
207
|
+
signing_key:
|
208
|
+
specification_version: 4
|
209
|
+
summary: API Client library for the Resource Settings V1 API
|
210
|
+
test_files: []
|