google-cloud-service_management-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 +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-service_management-v1.rb +21 -0
- data/lib/google/api/servicemanagement/v1/resources_pb.rb +123 -0
- data/lib/google/api/servicemanagement/v1/servicemanager_pb.rb +146 -0
- data/lib/google/api/servicemanagement/v1/servicemanager_services_pb.rb +148 -0
- data/lib/google/cloud/service_management/v1.rb +35 -0
- data/lib/google/cloud/service_management/v1/service_manager.rb +49 -0
- data/lib/google/cloud/service_management/v1/service_manager/client.rb +1563 -0
- data/lib/google/cloud/service_management/v1/service_manager/credentials.rb +54 -0
- data/lib/google/cloud/service_management/v1/service_manager/operations.rb +570 -0
- data/lib/google/cloud/service_management/v1/version.rb +28 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/auth.rb +192 -0
- data/proto_docs/google/api/backend.rb +55 -0
- data/proto_docs/google/api/billing.rb +69 -0
- data/proto_docs/google/api/config_change.rb +89 -0
- data/proto_docs/google/api/context.rb +67 -0
- data/proto_docs/google/api/control.rb +34 -0
- data/proto_docs/google/api/documentation.rb +164 -0
- data/proto_docs/google/api/endpoint.rb +70 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/label.rb +49 -0
- data/proto_docs/google/api/log.rb +54 -0
- data/proto_docs/google/api/logging.rb +85 -0
- data/proto_docs/google/api/metric.rb +203 -0
- data/proto_docs/google/api/monitored_resource.rb +137 -0
- data/proto_docs/google/api/monitoring.rb +91 -0
- data/proto_docs/google/api/quota.rb +281 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/api/service.rb +151 -0
- data/proto_docs/google/api/servicemanagement/v1/resources.rb +326 -0
- data/proto_docs/google/api/servicemanagement/v1/servicemanager.rb +370 -0
- data/proto_docs/google/api/source_info.rb +31 -0
- data/proto_docs/google/api/system_parameter.rb +103 -0
- data/proto_docs/google/api/usage.rb +94 -0
- data/proto_docs/google/longrunning/operations.rb +150 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/api.rb +194 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/source_context.rb +33 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/protobuf/type.rb +223 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +232 -0
@@ -0,0 +1,370 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 ServiceManagement
|
23
|
+
module V1
|
24
|
+
# Request message for `ListServices` method.
|
25
|
+
# @!attribute [rw] producer_project_id
|
26
|
+
# @return [::String]
|
27
|
+
# Include services produced by the specified project.
|
28
|
+
# @!attribute [rw] page_size
|
29
|
+
# @return [::Integer]
|
30
|
+
# The max number of items to include in the response list. Page size is 50
|
31
|
+
# if not specified. Maximum value is 100.
|
32
|
+
# @!attribute [rw] page_token
|
33
|
+
# @return [::String]
|
34
|
+
# Token identifying which result to start with; returned by a previous list
|
35
|
+
# call.
|
36
|
+
# @!attribute [rw] consumer_id
|
37
|
+
# @return [::String]
|
38
|
+
# Include services consumed by the specified consumer.
|
39
|
+
#
|
40
|
+
# The Google Service Management implementation accepts the following
|
41
|
+
# forms:
|
42
|
+
# - project:<project_id>
|
43
|
+
class ListServicesRequest
|
44
|
+
include ::Google::Protobuf::MessageExts
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
46
|
+
end
|
47
|
+
|
48
|
+
# Response message for `ListServices` method.
|
49
|
+
# @!attribute [rw] services
|
50
|
+
# @return [::Array<::Google::Cloud::ServiceManagement::V1::ManagedService>]
|
51
|
+
# The returned services will only have the name field set.
|
52
|
+
# @!attribute [rw] next_page_token
|
53
|
+
# @return [::String]
|
54
|
+
# Token that can be passed to `ListServices` to resume a paginated query.
|
55
|
+
class ListServicesResponse
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
end
|
59
|
+
|
60
|
+
# Request message for `GetService` method.
|
61
|
+
# @!attribute [rw] service_name
|
62
|
+
# @return [::String]
|
63
|
+
# Required. The name of the service. See the `ServiceManager` overview for naming
|
64
|
+
# requirements. For example: `example.googleapis.com`.
|
65
|
+
class GetServiceRequest
|
66
|
+
include ::Google::Protobuf::MessageExts
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
end
|
69
|
+
|
70
|
+
# Request message for CreateService method.
|
71
|
+
# @!attribute [rw] service
|
72
|
+
# @return [::Google::Cloud::ServiceManagement::V1::ManagedService]
|
73
|
+
# Required. Initial values for the service resource.
|
74
|
+
class CreateServiceRequest
|
75
|
+
include ::Google::Protobuf::MessageExts
|
76
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
77
|
+
end
|
78
|
+
|
79
|
+
# Request message for DeleteService method.
|
80
|
+
# @!attribute [rw] service_name
|
81
|
+
# @return [::String]
|
82
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
83
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
84
|
+
class DeleteServiceRequest
|
85
|
+
include ::Google::Protobuf::MessageExts
|
86
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
87
|
+
end
|
88
|
+
|
89
|
+
# Request message for UndeleteService method.
|
90
|
+
# @!attribute [rw] service_name
|
91
|
+
# @return [::String]
|
92
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
93
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
94
|
+
class UndeleteServiceRequest
|
95
|
+
include ::Google::Protobuf::MessageExts
|
96
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
97
|
+
end
|
98
|
+
|
99
|
+
# Response message for UndeleteService method.
|
100
|
+
# @!attribute [rw] service
|
101
|
+
# @return [::Google::Cloud::ServiceManagement::V1::ManagedService]
|
102
|
+
# Revived service resource.
|
103
|
+
class UndeleteServiceResponse
|
104
|
+
include ::Google::Protobuf::MessageExts
|
105
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
106
|
+
end
|
107
|
+
|
108
|
+
# Request message for GetServiceConfig method.
|
109
|
+
# @!attribute [rw] service_name
|
110
|
+
# @return [::String]
|
111
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
112
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
113
|
+
# @!attribute [rw] config_id
|
114
|
+
# @return [::String]
|
115
|
+
# Required. The id of the service configuration resource.
|
116
|
+
#
|
117
|
+
# This field must be specified for the server to return all fields, including
|
118
|
+
# `SourceInfo`.
|
119
|
+
# @!attribute [rw] view
|
120
|
+
# @return [::Google::Cloud::ServiceManagement::V1::GetServiceConfigRequest::ConfigView]
|
121
|
+
# Specifies which parts of the Service Config should be returned in the
|
122
|
+
# response.
|
123
|
+
class GetServiceConfigRequest
|
124
|
+
include ::Google::Protobuf::MessageExts
|
125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
126
|
+
|
127
|
+
module ConfigView
|
128
|
+
# Server response includes all fields except SourceInfo.
|
129
|
+
BASIC = 0
|
130
|
+
|
131
|
+
# Server response includes all fields including SourceInfo.
|
132
|
+
# SourceFiles are of type 'google.api.servicemanagement.v1.ConfigFile'
|
133
|
+
# and are only available for configs created using the
|
134
|
+
# SubmitConfigSource method.
|
135
|
+
FULL = 1
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
# Request message for ListServiceConfigs method.
|
140
|
+
# @!attribute [rw] service_name
|
141
|
+
# @return [::String]
|
142
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
143
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
144
|
+
# @!attribute [rw] page_token
|
145
|
+
# @return [::String]
|
146
|
+
# The token of the page to retrieve.
|
147
|
+
# @!attribute [rw] page_size
|
148
|
+
# @return [::Integer]
|
149
|
+
# The max number of items to include in the response list. Page size is 50
|
150
|
+
# if not specified. Maximum value is 100.
|
151
|
+
class ListServiceConfigsRequest
|
152
|
+
include ::Google::Protobuf::MessageExts
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
end
|
155
|
+
|
156
|
+
# Response message for ListServiceConfigs method.
|
157
|
+
# @!attribute [rw] service_configs
|
158
|
+
# @return [::Array<::Google::Api::Service>]
|
159
|
+
# The list of service configuration resources.
|
160
|
+
# @!attribute [rw] next_page_token
|
161
|
+
# @return [::String]
|
162
|
+
# The token of the next page of results.
|
163
|
+
class ListServiceConfigsResponse
|
164
|
+
include ::Google::Protobuf::MessageExts
|
165
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
166
|
+
end
|
167
|
+
|
168
|
+
# Request message for CreateServiceConfig method.
|
169
|
+
# @!attribute [rw] service_name
|
170
|
+
# @return [::String]
|
171
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
172
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
173
|
+
# @!attribute [rw] service_config
|
174
|
+
# @return [::Google::Api::Service]
|
175
|
+
# Required. The service configuration resource.
|
176
|
+
class CreateServiceConfigRequest
|
177
|
+
include ::Google::Protobuf::MessageExts
|
178
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
179
|
+
end
|
180
|
+
|
181
|
+
# Request message for SubmitConfigSource method.
|
182
|
+
# @!attribute [rw] service_name
|
183
|
+
# @return [::String]
|
184
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
185
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
186
|
+
# @!attribute [rw] config_source
|
187
|
+
# @return [::Google::Cloud::ServiceManagement::V1::ConfigSource]
|
188
|
+
# Required. The source configuration for the service.
|
189
|
+
# @!attribute [rw] validate_only
|
190
|
+
# @return [::Boolean]
|
191
|
+
# Optional. If set, this will result in the generation of a
|
192
|
+
# `google.api.Service` configuration based on the `ConfigSource` provided,
|
193
|
+
# but the generated config and the sources will NOT be persisted.
|
194
|
+
class SubmitConfigSourceRequest
|
195
|
+
include ::Google::Protobuf::MessageExts
|
196
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
197
|
+
end
|
198
|
+
|
199
|
+
# Response message for SubmitConfigSource method.
|
200
|
+
# @!attribute [rw] service_config
|
201
|
+
# @return [::Google::Api::Service]
|
202
|
+
# The generated service configuration.
|
203
|
+
class SubmitConfigSourceResponse
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
|
208
|
+
# Request message for 'CreateServiceRollout'
|
209
|
+
# @!attribute [rw] service_name
|
210
|
+
# @return [::String]
|
211
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
212
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
213
|
+
# @!attribute [rw] rollout
|
214
|
+
# @return [::Google::Cloud::ServiceManagement::V1::Rollout]
|
215
|
+
# Required. The rollout resource. The `service_name` field is output only.
|
216
|
+
class CreateServiceRolloutRequest
|
217
|
+
include ::Google::Protobuf::MessageExts
|
218
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
219
|
+
end
|
220
|
+
|
221
|
+
# Request message for 'ListServiceRollouts'
|
222
|
+
# @!attribute [rw] service_name
|
223
|
+
# @return [::String]
|
224
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
225
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
226
|
+
# @!attribute [rw] page_token
|
227
|
+
# @return [::String]
|
228
|
+
# The token of the page to retrieve.
|
229
|
+
# @!attribute [rw] page_size
|
230
|
+
# @return [::Integer]
|
231
|
+
# The max number of items to include in the response list. Page size is 50
|
232
|
+
# if not specified. Maximum value is 100.
|
233
|
+
# @!attribute [rw] filter
|
234
|
+
# @return [::String]
|
235
|
+
# Required. Use `filter` to return subset of rollouts.
|
236
|
+
# The following filters are supported:
|
237
|
+
# -- To limit the results to only those in
|
238
|
+
# [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
|
239
|
+
# use filter='status=SUCCESS'
|
240
|
+
# -- To limit the results to those in
|
241
|
+
# [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
|
242
|
+
# or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
|
243
|
+
class ListServiceRolloutsRequest
|
244
|
+
include ::Google::Protobuf::MessageExts
|
245
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
246
|
+
end
|
247
|
+
|
248
|
+
# Response message for ListServiceRollouts method.
|
249
|
+
# @!attribute [rw] rollouts
|
250
|
+
# @return [::Array<::Google::Cloud::ServiceManagement::V1::Rollout>]
|
251
|
+
# The list of rollout resources.
|
252
|
+
# @!attribute [rw] next_page_token
|
253
|
+
# @return [::String]
|
254
|
+
# The token of the next page of results.
|
255
|
+
class ListServiceRolloutsResponse
|
256
|
+
include ::Google::Protobuf::MessageExts
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
258
|
+
end
|
259
|
+
|
260
|
+
# Request message for GetServiceRollout method.
|
261
|
+
# @!attribute [rw] service_name
|
262
|
+
# @return [::String]
|
263
|
+
# Required. The name of the service. See the [overview](/service-management/overview)
|
264
|
+
# for naming requirements. For example: `example.googleapis.com`.
|
265
|
+
# @!attribute [rw] rollout_id
|
266
|
+
# @return [::String]
|
267
|
+
# Required. The id of the rollout resource.
|
268
|
+
class GetServiceRolloutRequest
|
269
|
+
include ::Google::Protobuf::MessageExts
|
270
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
271
|
+
end
|
272
|
+
|
273
|
+
# Request message for EnableService method.
|
274
|
+
# @!attribute [rw] service_name
|
275
|
+
# @return [::String]
|
276
|
+
# Required. Name of the service to enable. Specifying an unknown service name will
|
277
|
+
# cause the request to fail.
|
278
|
+
# @!attribute [rw] consumer_id
|
279
|
+
# @return [::String]
|
280
|
+
# Required. The identity of consumer resource which service enablement will be
|
281
|
+
# applied to.
|
282
|
+
#
|
283
|
+
# The Google Service Management implementation accepts the following
|
284
|
+
# forms:
|
285
|
+
# - "project:<project_id>"
|
286
|
+
#
|
287
|
+
# Note: this is made compatible with
|
288
|
+
# google.api.servicecontrol.v1.Operation.consumer_id.
|
289
|
+
class EnableServiceRequest
|
290
|
+
include ::Google::Protobuf::MessageExts
|
291
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
292
|
+
end
|
293
|
+
|
294
|
+
# Operation payload for EnableService method.
|
295
|
+
class EnableServiceResponse
|
296
|
+
include ::Google::Protobuf::MessageExts
|
297
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
298
|
+
end
|
299
|
+
|
300
|
+
# Request message for DisableService method.
|
301
|
+
# @!attribute [rw] service_name
|
302
|
+
# @return [::String]
|
303
|
+
# Required. Name of the service to disable. Specifying an unknown service name
|
304
|
+
# will cause the request to fail.
|
305
|
+
# @!attribute [rw] consumer_id
|
306
|
+
# @return [::String]
|
307
|
+
# Required. The identity of consumer resource which service disablement will be
|
308
|
+
# applied to.
|
309
|
+
#
|
310
|
+
# The Google Service Management implementation accepts the following
|
311
|
+
# forms:
|
312
|
+
# - "project:<project_id>"
|
313
|
+
#
|
314
|
+
# Note: this is made compatible with
|
315
|
+
# google.api.servicecontrol.v1.Operation.consumer_id.
|
316
|
+
class DisableServiceRequest
|
317
|
+
include ::Google::Protobuf::MessageExts
|
318
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
319
|
+
end
|
320
|
+
|
321
|
+
# Operation payload for DisableService method.
|
322
|
+
class DisableServiceResponse
|
323
|
+
include ::Google::Protobuf::MessageExts
|
324
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
325
|
+
end
|
326
|
+
|
327
|
+
# Request message for GenerateConfigReport method.
|
328
|
+
# @!attribute [rw] new_config
|
329
|
+
# @return [::Google::Protobuf::Any]
|
330
|
+
# Required. Service configuration for which we want to generate the report.
|
331
|
+
# For this version of API, the supported types are
|
332
|
+
# {::Google::Cloud::ServiceManagement::V1::ConfigRef google.api.servicemanagement.v1.ConfigRef},
|
333
|
+
# {::Google::Cloud::ServiceManagement::V1::ConfigSource google.api.servicemanagement.v1.ConfigSource},
|
334
|
+
# and {::Google::Api::Service google.api.Service}
|
335
|
+
# @!attribute [rw] old_config
|
336
|
+
# @return [::Google::Protobuf::Any]
|
337
|
+
# Optional. Service configuration against which the comparison will be done.
|
338
|
+
# For this version of API, the supported types are
|
339
|
+
# {::Google::Cloud::ServiceManagement::V1::ConfigRef google.api.servicemanagement.v1.ConfigRef},
|
340
|
+
# {::Google::Cloud::ServiceManagement::V1::ConfigSource google.api.servicemanagement.v1.ConfigSource},
|
341
|
+
# and {::Google::Api::Service google.api.Service}
|
342
|
+
class GenerateConfigReportRequest
|
343
|
+
include ::Google::Protobuf::MessageExts
|
344
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
345
|
+
end
|
346
|
+
|
347
|
+
# Response message for GenerateConfigReport method.
|
348
|
+
# @!attribute [rw] service_name
|
349
|
+
# @return [::String]
|
350
|
+
# Name of the service this report belongs to.
|
351
|
+
# @!attribute [rw] id
|
352
|
+
# @return [::String]
|
353
|
+
# ID of the service configuration this report belongs to.
|
354
|
+
# @!attribute [rw] change_reports
|
355
|
+
# @return [::Array<::Google::Cloud::ServiceManagement::V1::ChangeReport>]
|
356
|
+
# list of ChangeReport, each corresponding to comparison between two
|
357
|
+
# service configurations.
|
358
|
+
# @!attribute [rw] diagnostics
|
359
|
+
# @return [::Array<::Google::Cloud::ServiceManagement::V1::Diagnostic>]
|
360
|
+
# Errors / Linter warnings associated with the service definition this
|
361
|
+
# report
|
362
|
+
# belongs to.
|
363
|
+
class GenerateConfigReportResponse
|
364
|
+
include ::Google::Protobuf::MessageExts
|
365
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
366
|
+
end
|
367
|
+
end
|
368
|
+
end
|
369
|
+
end
|
370
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Api
|
22
|
+
# Source information used to create a Service Config
|
23
|
+
# @!attribute [rw] source_files
|
24
|
+
# @return [::Array<::Google::Protobuf::Any>]
|
25
|
+
# All files used during config generation.
|
26
|
+
class SourceInfo
|
27
|
+
include ::Google::Protobuf::MessageExts
|
28
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Api
|
22
|
+
# ### System parameter configuration
|
23
|
+
#
|
24
|
+
# A system parameter is a special kind of parameter defined by the API
|
25
|
+
# system, not by an individual API. It is typically mapped to an HTTP header
|
26
|
+
# and/or a URL query parameter. This configuration specifies which methods
|
27
|
+
# change the names of the system parameters.
|
28
|
+
# @!attribute [rw] rules
|
29
|
+
# @return [::Array<::Google::Api::SystemParameterRule>]
|
30
|
+
# Define system parameters.
|
31
|
+
#
|
32
|
+
# The parameters defined here will override the default parameters
|
33
|
+
# implemented by the system. If this field is missing from the service
|
34
|
+
# config, default system parameters will be used. Default system parameters
|
35
|
+
# and names is implementation-dependent.
|
36
|
+
#
|
37
|
+
# Example: define api key for all methods
|
38
|
+
#
|
39
|
+
# system_parameters
|
40
|
+
# rules:
|
41
|
+
# - selector: "*"
|
42
|
+
# parameters:
|
43
|
+
# - name: api_key
|
44
|
+
# url_query_parameter: api_key
|
45
|
+
#
|
46
|
+
#
|
47
|
+
# Example: define 2 api key names for a specific method.
|
48
|
+
#
|
49
|
+
# system_parameters
|
50
|
+
# rules:
|
51
|
+
# - selector: "/ListShelves"
|
52
|
+
# parameters:
|
53
|
+
# - name: api_key
|
54
|
+
# http_header: Api-Key1
|
55
|
+
# - name: api_key
|
56
|
+
# http_header: Api-Key2
|
57
|
+
#
|
58
|
+
# **NOTE:** All service configuration rules follow "last one wins" order.
|
59
|
+
class SystemParameters
|
60
|
+
include ::Google::Protobuf::MessageExts
|
61
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
62
|
+
end
|
63
|
+
|
64
|
+
# Define a system parameter rule mapping system parameter definitions to
|
65
|
+
# methods.
|
66
|
+
# @!attribute [rw] selector
|
67
|
+
# @return [::String]
|
68
|
+
# Selects the methods to which this rule applies. Use '*' to indicate all
|
69
|
+
# methods in all APIs.
|
70
|
+
#
|
71
|
+
# Refer to {::Google::Api::DocumentationRule#selector selector} for syntax details.
|
72
|
+
# @!attribute [rw] parameters
|
73
|
+
# @return [::Array<::Google::Api::SystemParameter>]
|
74
|
+
# Define parameters. Multiple names may be defined for a parameter.
|
75
|
+
# For a given method call, only one of them should be used. If multiple
|
76
|
+
# names are used the behavior is implementation-dependent.
|
77
|
+
# If none of the specified names are present the behavior is
|
78
|
+
# parameter-dependent.
|
79
|
+
class SystemParameterRule
|
80
|
+
include ::Google::Protobuf::MessageExts
|
81
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
82
|
+
end
|
83
|
+
|
84
|
+
# Define a parameter's name and location. The parameter may be passed as either
|
85
|
+
# an HTTP header or a URL query parameter, and if both are passed the behavior
|
86
|
+
# is implementation-dependent.
|
87
|
+
# @!attribute [rw] name
|
88
|
+
# @return [::String]
|
89
|
+
# Define the name of the parameter, such as "api_key" . It is case sensitive.
|
90
|
+
# @!attribute [rw] http_header
|
91
|
+
# @return [::String]
|
92
|
+
# Define the HTTP header name to use for the parameter. It is case
|
93
|
+
# insensitive.
|
94
|
+
# @!attribute [rw] url_query_parameter
|
95
|
+
# @return [::String]
|
96
|
+
# Define the URL query parameter name to use for the parameter. It is case
|
97
|
+
# sensitive.
|
98
|
+
class SystemParameter
|
99
|
+
include ::Google::Protobuf::MessageExts
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|