google-apis-serviceusage_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-serviceusage_v1.rb +15 -0
- data/lib/google/apis/serviceusage_v1.rb +44 -0
- data/lib/google/apis/serviceusage_v1/classes.rb +3644 -0
- data/lib/google/apis/serviceusage_v1/gem_version.rb +28 -0
- data/lib/google/apis/serviceusage_v1/representations.rb +1328 -0
- data/lib/google/apis/serviceusage_v1/service.rb +450 -0
- metadata +76 -0
@@ -0,0 +1,450 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module ServiceusageV1
|
23
|
+
# Service Usage API
|
24
|
+
#
|
25
|
+
# Enables services that service consumers want to use on Google Cloud Platform,
|
26
|
+
# lists the available or enabled services, or disables services that service
|
27
|
+
# consumers no longer use.
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
# require 'google/apis/serviceusage_v1'
|
31
|
+
#
|
32
|
+
# Serviceusage = Google::Apis::ServiceusageV1 # Alias the module
|
33
|
+
# service = Serviceusage::ServiceUsageService.new
|
34
|
+
#
|
35
|
+
# @see https://cloud.google.com/service-usage/
|
36
|
+
class ServiceUsageService < Google::Apis::Core::BaseService
|
37
|
+
# @return [String]
|
38
|
+
# API key. Your API key identifies your project and provides you with API access,
|
39
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
40
|
+
attr_accessor :key
|
41
|
+
|
42
|
+
# @return [String]
|
43
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
44
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
45
|
+
attr_accessor :quota_user
|
46
|
+
|
47
|
+
def initialize
|
48
|
+
super('https://serviceusage.googleapis.com/', '',
|
49
|
+
client_name: 'google-apis-serviceusage_v1',
|
50
|
+
client_version: Google::Apis::ServiceusageV1::GEM_VERSION)
|
51
|
+
@batch_path = 'batch'
|
52
|
+
end
|
53
|
+
|
54
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
55
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
56
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
57
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
58
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
59
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
60
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
61
|
+
# corresponding to `Code.CANCELLED`.
|
62
|
+
# @param [String] name
|
63
|
+
# The name of the operation resource to be cancelled.
|
64
|
+
# @param [Google::Apis::ServiceusageV1::CancelOperationRequest] cancel_operation_request_object
|
65
|
+
# @param [String] fields
|
66
|
+
# Selector specifying which fields to include in a partial response.
|
67
|
+
# @param [String] quota_user
|
68
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
69
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
70
|
+
# @param [Google::Apis::RequestOptions] options
|
71
|
+
# Request-specific options
|
72
|
+
#
|
73
|
+
# @yield [result, err] Result & error if block supplied
|
74
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Empty] parsed result object
|
75
|
+
# @yieldparam err [StandardError] error object if request failed
|
76
|
+
#
|
77
|
+
# @return [Google::Apis::ServiceusageV1::Empty]
|
78
|
+
#
|
79
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
80
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
81
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
82
|
+
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
83
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
84
|
+
command.request_representation = Google::Apis::ServiceusageV1::CancelOperationRequest::Representation
|
85
|
+
command.request_object = cancel_operation_request_object
|
86
|
+
command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation
|
87
|
+
command.response_class = Google::Apis::ServiceusageV1::Empty
|
88
|
+
command.params['name'] = name unless name.nil?
|
89
|
+
command.query['fields'] = fields unless fields.nil?
|
90
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
91
|
+
execute_or_queue_command(command, &block)
|
92
|
+
end
|
93
|
+
|
94
|
+
# Deletes a long-running operation. This method indicates that the client is no
|
95
|
+
# longer interested in the operation result. It does not cancel the operation.
|
96
|
+
# If the server doesn't support this method, it returns `google.rpc.Code.
|
97
|
+
# UNIMPLEMENTED`.
|
98
|
+
# @param [String] name
|
99
|
+
# The name of the operation resource to be deleted.
|
100
|
+
# @param [String] fields
|
101
|
+
# Selector specifying which fields to include in a partial response.
|
102
|
+
# @param [String] quota_user
|
103
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
104
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
105
|
+
# @param [Google::Apis::RequestOptions] options
|
106
|
+
# Request-specific options
|
107
|
+
#
|
108
|
+
# @yield [result, err] Result & error if block supplied
|
109
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Empty] parsed result object
|
110
|
+
# @yieldparam err [StandardError] error object if request failed
|
111
|
+
#
|
112
|
+
# @return [Google::Apis::ServiceusageV1::Empty]
|
113
|
+
#
|
114
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
115
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
116
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
117
|
+
def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
118
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
119
|
+
command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation
|
120
|
+
command.response_class = Google::Apis::ServiceusageV1::Empty
|
121
|
+
command.params['name'] = name unless name.nil?
|
122
|
+
command.query['fields'] = fields unless fields.nil?
|
123
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
124
|
+
execute_or_queue_command(command, &block)
|
125
|
+
end
|
126
|
+
|
127
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
128
|
+
# to poll the operation result at intervals as recommended by the API service.
|
129
|
+
# @param [String] name
|
130
|
+
# The name of the operation resource.
|
131
|
+
# @param [String] fields
|
132
|
+
# Selector specifying which fields to include in a partial response.
|
133
|
+
# @param [String] quota_user
|
134
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
135
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
136
|
+
# @param [Google::Apis::RequestOptions] options
|
137
|
+
# Request-specific options
|
138
|
+
#
|
139
|
+
# @yield [result, err] Result & error if block supplied
|
140
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object
|
141
|
+
# @yieldparam err [StandardError] error object if request failed
|
142
|
+
#
|
143
|
+
# @return [Google::Apis::ServiceusageV1::Operation]
|
144
|
+
#
|
145
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
146
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
147
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
148
|
+
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
149
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
150
|
+
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
|
151
|
+
command.response_class = Google::Apis::ServiceusageV1::Operation
|
152
|
+
command.params['name'] = name unless name.nil?
|
153
|
+
command.query['fields'] = fields unless fields.nil?
|
154
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
155
|
+
execute_or_queue_command(command, &block)
|
156
|
+
end
|
157
|
+
|
158
|
+
# Lists operations that match the specified filter in the request. If the server
|
159
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
160
|
+
# binding allows API services to override the binding to use different resource
|
161
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
162
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
163
|
+
# service configuration. For backwards compatibility, the default name includes
|
164
|
+
# the operations collection id, however overriding users must ensure the name
|
165
|
+
# binding is the parent resource, without the operations collection id.
|
166
|
+
# @param [String] filter
|
167
|
+
# The standard list filter.
|
168
|
+
# @param [String] name
|
169
|
+
# The name of the operation's parent resource.
|
170
|
+
# @param [Fixnum] page_size
|
171
|
+
# The standard list page size.
|
172
|
+
# @param [String] page_token
|
173
|
+
# The standard list page token.
|
174
|
+
# @param [String] fields
|
175
|
+
# Selector specifying which fields to include in a partial response.
|
176
|
+
# @param [String] quota_user
|
177
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
178
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
179
|
+
# @param [Google::Apis::RequestOptions] options
|
180
|
+
# Request-specific options
|
181
|
+
#
|
182
|
+
# @yield [result, err] Result & error if block supplied
|
183
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::ListOperationsResponse] parsed result object
|
184
|
+
# @yieldparam err [StandardError] error object if request failed
|
185
|
+
#
|
186
|
+
# @return [Google::Apis::ServiceusageV1::ListOperationsResponse]
|
187
|
+
#
|
188
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
189
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
190
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
191
|
+
def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
192
|
+
command = make_simple_command(:get, 'v1/operations', options)
|
193
|
+
command.response_representation = Google::Apis::ServiceusageV1::ListOperationsResponse::Representation
|
194
|
+
command.response_class = Google::Apis::ServiceusageV1::ListOperationsResponse
|
195
|
+
command.query['filter'] = filter unless filter.nil?
|
196
|
+
command.query['name'] = name unless name.nil?
|
197
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
198
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
199
|
+
command.query['fields'] = fields unless fields.nil?
|
200
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
201
|
+
execute_or_queue_command(command, &block)
|
202
|
+
end
|
203
|
+
|
204
|
+
# Enable multiple services on a project. The operation is atomic: if enabling
|
205
|
+
# any service fails, then the entire batch fails, and no state changes occur. To
|
206
|
+
# enable a single service, use the `EnableService` method instead.
|
207
|
+
# @param [String] parent
|
208
|
+
# Parent to enable services on. An example name would be: `projects/123` where `
|
209
|
+
# 123` is the project number. The `BatchEnableServices` method currently only
|
210
|
+
# supports projects.
|
211
|
+
# @param [Google::Apis::ServiceusageV1::BatchEnableServicesRequest] batch_enable_services_request_object
|
212
|
+
# @param [String] fields
|
213
|
+
# Selector specifying which fields to include in a partial response.
|
214
|
+
# @param [String] quota_user
|
215
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
216
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
217
|
+
# @param [Google::Apis::RequestOptions] options
|
218
|
+
# Request-specific options
|
219
|
+
#
|
220
|
+
# @yield [result, err] Result & error if block supplied
|
221
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object
|
222
|
+
# @yieldparam err [StandardError] error object if request failed
|
223
|
+
#
|
224
|
+
# @return [Google::Apis::ServiceusageV1::Operation]
|
225
|
+
#
|
226
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
227
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
228
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
229
|
+
def batch_enable_services(parent, batch_enable_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
230
|
+
command = make_simple_command(:post, 'v1/{+parent}/services:batchEnable', options)
|
231
|
+
command.request_representation = Google::Apis::ServiceusageV1::BatchEnableServicesRequest::Representation
|
232
|
+
command.request_object = batch_enable_services_request_object
|
233
|
+
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
|
234
|
+
command.response_class = Google::Apis::ServiceusageV1::Operation
|
235
|
+
command.params['parent'] = parent unless parent.nil?
|
236
|
+
command.query['fields'] = fields unless fields.nil?
|
237
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
238
|
+
execute_or_queue_command(command, &block)
|
239
|
+
end
|
240
|
+
|
241
|
+
# Returns the service configurations and enabled states for a given list of
|
242
|
+
# services.
|
243
|
+
# @param [String] parent
|
244
|
+
# Parent to retrieve services from. If this is set, the parent of all of the
|
245
|
+
# services specified in `names` must match this field. An example name would be:
|
246
|
+
# `projects/123` where `123` is the project number. The `BatchGetServices`
|
247
|
+
# method currently only supports projects.
|
248
|
+
# @param [Array<String>, String] names
|
249
|
+
# Names of the services to retrieve. An example name would be: `projects/123/
|
250
|
+
# services/serviceusage.googleapis.com` where `123` is the project number. A
|
251
|
+
# single request can get a maximum of 30 services at a time.
|
252
|
+
# @param [String] fields
|
253
|
+
# Selector specifying which fields to include in a partial response.
|
254
|
+
# @param [String] quota_user
|
255
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
256
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
257
|
+
# @param [Google::Apis::RequestOptions] options
|
258
|
+
# Request-specific options
|
259
|
+
#
|
260
|
+
# @yield [result, err] Result & error if block supplied
|
261
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::BatchGetServicesResponse] parsed result object
|
262
|
+
# @yieldparam err [StandardError] error object if request failed
|
263
|
+
#
|
264
|
+
# @return [Google::Apis::ServiceusageV1::BatchGetServicesResponse]
|
265
|
+
#
|
266
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
267
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
268
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
269
|
+
def batch_service_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
270
|
+
command = make_simple_command(:get, 'v1/{+parent}/services:batchGet', options)
|
271
|
+
command.response_representation = Google::Apis::ServiceusageV1::BatchGetServicesResponse::Representation
|
272
|
+
command.response_class = Google::Apis::ServiceusageV1::BatchGetServicesResponse
|
273
|
+
command.params['parent'] = parent unless parent.nil?
|
274
|
+
command.query['names'] = names unless names.nil?
|
275
|
+
command.query['fields'] = fields unless fields.nil?
|
276
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
277
|
+
execute_or_queue_command(command, &block)
|
278
|
+
end
|
279
|
+
|
280
|
+
# Disable a service so that it can no longer be used with a project. This
|
281
|
+
# prevents unintended usage that may cause unexpected billing charges or
|
282
|
+
# security leaks. It is not valid to call the disable method on a service that
|
283
|
+
# is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status
|
284
|
+
# if the target service is not currently enabled.
|
285
|
+
# @param [String] name
|
286
|
+
# Name of the consumer and service to disable the service on. The enable and
|
287
|
+
# disable methods currently only support projects. An example name would be: `
|
288
|
+
# projects/123/services/serviceusage.googleapis.com` where `123` is the project
|
289
|
+
# number.
|
290
|
+
# @param [Google::Apis::ServiceusageV1::DisableServiceRequest] disable_service_request_object
|
291
|
+
# @param [String] fields
|
292
|
+
# Selector specifying which fields to include in a partial response.
|
293
|
+
# @param [String] quota_user
|
294
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
295
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
296
|
+
# @param [Google::Apis::RequestOptions] options
|
297
|
+
# Request-specific options
|
298
|
+
#
|
299
|
+
# @yield [result, err] Result & error if block supplied
|
300
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object
|
301
|
+
# @yieldparam err [StandardError] error object if request failed
|
302
|
+
#
|
303
|
+
# @return [Google::Apis::ServiceusageV1::Operation]
|
304
|
+
#
|
305
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
306
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
307
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
308
|
+
def disable_service(name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
309
|
+
command = make_simple_command(:post, 'v1/{+name}:disable', options)
|
310
|
+
command.request_representation = Google::Apis::ServiceusageV1::DisableServiceRequest::Representation
|
311
|
+
command.request_object = disable_service_request_object
|
312
|
+
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
|
313
|
+
command.response_class = Google::Apis::ServiceusageV1::Operation
|
314
|
+
command.params['name'] = name unless name.nil?
|
315
|
+
command.query['fields'] = fields unless fields.nil?
|
316
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
317
|
+
execute_or_queue_command(command, &block)
|
318
|
+
end
|
319
|
+
|
320
|
+
# Enable a service so that it can be used with a project.
|
321
|
+
# @param [String] name
|
322
|
+
# Name of the consumer and service to enable the service on. The `EnableService`
|
323
|
+
# and `DisableService` methods currently only support projects. Enabling a
|
324
|
+
# service requires that the service is public or is shared with the user
|
325
|
+
# enabling the service. An example name would be: `projects/123/services/
|
326
|
+
# serviceusage.googleapis.com` where `123` is the project number.
|
327
|
+
# @param [Google::Apis::ServiceusageV1::EnableServiceRequest] enable_service_request_object
|
328
|
+
# @param [String] fields
|
329
|
+
# Selector specifying which fields to include in a partial response.
|
330
|
+
# @param [String] quota_user
|
331
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
332
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
333
|
+
# @param [Google::Apis::RequestOptions] options
|
334
|
+
# Request-specific options
|
335
|
+
#
|
336
|
+
# @yield [result, err] Result & error if block supplied
|
337
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object
|
338
|
+
# @yieldparam err [StandardError] error object if request failed
|
339
|
+
#
|
340
|
+
# @return [Google::Apis::ServiceusageV1::Operation]
|
341
|
+
#
|
342
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
343
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
344
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
345
|
+
def enable_service(name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
346
|
+
command = make_simple_command(:post, 'v1/{+name}:enable', options)
|
347
|
+
command.request_representation = Google::Apis::ServiceusageV1::EnableServiceRequest::Representation
|
348
|
+
command.request_object = enable_service_request_object
|
349
|
+
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
|
350
|
+
command.response_class = Google::Apis::ServiceusageV1::Operation
|
351
|
+
command.params['name'] = name unless name.nil?
|
352
|
+
command.query['fields'] = fields unless fields.nil?
|
353
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
354
|
+
execute_or_queue_command(command, &block)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Returns the service configuration and enabled state for a given service.
|
358
|
+
# @param [String] name
|
359
|
+
# Name of the consumer and service to get the `ConsumerState` for. An example
|
360
|
+
# name would be: `projects/123/services/serviceusage.googleapis.com` where `123`
|
361
|
+
# is the project number.
|
362
|
+
# @param [String] fields
|
363
|
+
# Selector specifying which fields to include in a partial response.
|
364
|
+
# @param [String] quota_user
|
365
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
366
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
367
|
+
# @param [Google::Apis::RequestOptions] options
|
368
|
+
# Request-specific options
|
369
|
+
#
|
370
|
+
# @yield [result, err] Result & error if block supplied
|
371
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service] parsed result object
|
372
|
+
# @yieldparam err [StandardError] error object if request failed
|
373
|
+
#
|
374
|
+
# @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service]
|
375
|
+
#
|
376
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
377
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
378
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
379
|
+
def get_service(name, fields: nil, quota_user: nil, options: nil, &block)
|
380
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
381
|
+
command.response_representation = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation
|
382
|
+
command.response_class = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service
|
383
|
+
command.params['name'] = name unless name.nil?
|
384
|
+
command.query['fields'] = fields unless fields.nil?
|
385
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
386
|
+
execute_or_queue_command(command, &block)
|
387
|
+
end
|
388
|
+
|
389
|
+
# List all services available to the specified project, and the current state of
|
390
|
+
# those services with respect to the project. The list includes all public
|
391
|
+
# services, all services for which the calling user has the `servicemanagement.
|
392
|
+
# services.bind` permission, and all services that have already been enabled on
|
393
|
+
# the project. The list can be filtered to only include services in a specific
|
394
|
+
# state, for example to only include services enabled on the project. WARNING:
|
395
|
+
# If you need to query enabled services frequently or across an organization,
|
396
|
+
# you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-
|
397
|
+
# inventory/docs/apis), which provides higher throughput and richer filtering
|
398
|
+
# capability.
|
399
|
+
# @param [String] parent
|
400
|
+
# Parent to search for services on. An example name would be: `projects/123`
|
401
|
+
# where `123` is the project number.
|
402
|
+
# @param [String] filter
|
403
|
+
# Only list services that conform to the given filter. The allowed filter
|
404
|
+
# strings are `state:ENABLED` and `state:DISABLED`.
|
405
|
+
# @param [Fixnum] page_size
|
406
|
+
# Requested size of the next page of data. Requested page size cannot exceed 200.
|
407
|
+
# If not set, the default page size is 50.
|
408
|
+
# @param [String] page_token
|
409
|
+
# Token identifying which result to start with, which is returned by a previous
|
410
|
+
# list call.
|
411
|
+
# @param [String] fields
|
412
|
+
# Selector specifying which fields to include in a partial response.
|
413
|
+
# @param [String] quota_user
|
414
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
415
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
416
|
+
# @param [Google::Apis::RequestOptions] options
|
417
|
+
# Request-specific options
|
418
|
+
#
|
419
|
+
# @yield [result, err] Result & error if block supplied
|
420
|
+
# @yieldparam result [Google::Apis::ServiceusageV1::ListServicesResponse] parsed result object
|
421
|
+
# @yieldparam err [StandardError] error object if request failed
|
422
|
+
#
|
423
|
+
# @return [Google::Apis::ServiceusageV1::ListServicesResponse]
|
424
|
+
#
|
425
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
426
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
427
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
428
|
+
def list_services(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
429
|
+
command = make_simple_command(:get, 'v1/{+parent}/services', options)
|
430
|
+
command.response_representation = Google::Apis::ServiceusageV1::ListServicesResponse::Representation
|
431
|
+
command.response_class = Google::Apis::ServiceusageV1::ListServicesResponse
|
432
|
+
command.params['parent'] = parent unless parent.nil?
|
433
|
+
command.query['filter'] = filter unless filter.nil?
|
434
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
435
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
436
|
+
command.query['fields'] = fields unless fields.nil?
|
437
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
438
|
+
execute_or_queue_command(command, &block)
|
439
|
+
end
|
440
|
+
|
441
|
+
protected
|
442
|
+
|
443
|
+
def apply_command_defaults(command)
|
444
|
+
command.query['key'] = key unless key.nil?
|
445
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
446
|
+
end
|
447
|
+
end
|
448
|
+
end
|
449
|
+
end
|
450
|
+
end
|
metadata
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-apis-serviceusage_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-01-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-apis-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.1'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.1'
|
27
|
+
description: This is the simple REST client for Service Usage API V1. Simple REST
|
28
|
+
clients are Ruby client libraries that provide access to Google services via their
|
29
|
+
HTTP REST API endpoints. These libraries are generated and updated automatically
|
30
|
+
based on the discovery documents published by the service, and they handle most
|
31
|
+
concerns such as authentication, pagination, retry, timeouts, and logging. You can
|
32
|
+
use this client to access the Service Usage API, but note that some services may
|
33
|
+
provide a separate modern client that is easier to use.
|
34
|
+
email: googleapis-packages@google.com
|
35
|
+
executables: []
|
36
|
+
extensions: []
|
37
|
+
extra_rdoc_files: []
|
38
|
+
files:
|
39
|
+
- ".yardopts"
|
40
|
+
- CHANGELOG.md
|
41
|
+
- LICENSE.md
|
42
|
+
- OVERVIEW.md
|
43
|
+
- lib/google-apis-serviceusage_v1.rb
|
44
|
+
- lib/google/apis/serviceusage_v1.rb
|
45
|
+
- lib/google/apis/serviceusage_v1/classes.rb
|
46
|
+
- lib/google/apis/serviceusage_v1/gem_version.rb
|
47
|
+
- lib/google/apis/serviceusage_v1/representations.rb
|
48
|
+
- lib/google/apis/serviceusage_v1/service.rb
|
49
|
+
homepage: https://github.com/google/google-api-ruby-client
|
50
|
+
licenses:
|
51
|
+
- Apache-2.0
|
52
|
+
metadata:
|
53
|
+
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-serviceusage_v1/CHANGELOG.md
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-serviceusage_v1/v0.1.0
|
56
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-serviceusage_v1
|
57
|
+
post_install_message:
|
58
|
+
rdoc_options: []
|
59
|
+
require_paths:
|
60
|
+
- lib
|
61
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
62
|
+
requirements:
|
63
|
+
- - ">="
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: '2.4'
|
66
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
requirements: []
|
72
|
+
rubygems_version: 3.1.4
|
73
|
+
signing_key:
|
74
|
+
specification_version: 4
|
75
|
+
summary: Simple REST client for Service Usage API V1
|
76
|
+
test_files: []
|