1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module OsconfigV1
# OS Config API
#
# OS management tools that can be used for patch management, patch compliance,
# and configuration management on VM instances.
#
# @example
# require 'google/apis/osconfig_v1'
#
# Osconfig = Google::Apis::OsconfigV1 # Alias the module
# service = Osconfig::OSConfigService.new
#
# @see https://cloud.google.com/compute/docs/manage-os
class OSConfigService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://osconfig.googleapis.com/', '')
@batch_path = 'batch'
end
# Create an OS Config patch deployment.
# @param [String] parent
# Required. The project to apply this patch deployment to in the form `projects/*
# `.
# @param [Google::Apis::OsconfigV1::PatchDeployment] patch_deployment_object
# @param [String] patch_deployment_id
# Required. A name for the patch deployment in the project. When creating a name
# the following rules apply: * Must contain only lowercase letters, numbers, and
# hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must
# end with a number or a letter. * Must be unique within the project.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::PatchDeployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::PatchDeployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_patch_deployment(parent, patch_deployment_object = nil, patch_deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/patchDeployments', options)
command.request_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation
command.request_object = patch_deployment_object
command.response_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation
command.response_class = Google::Apis::OsconfigV1::PatchDeployment
command.params['parent'] = parent unless parent.nil?
command.query['patchDeploymentId'] = patch_deployment_id unless patch_deployment_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete an OS Config patch deployment.
# @param [String] name
# Required. The resource name of the patch deployment in the form `projects/*/
# patchDeployments/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::OsconfigV1::Empty::Representation
command.response_class = Google::Apis::OsconfigV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get an OS Config patch deployment.
# @param [String] name
# Required. The resource name of the patch deployment in the form `projects/*/
# patchDeployments/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::PatchDeployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::PatchDeployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation
command.response_class = Google::Apis::OsconfigV1::PatchDeployment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a page of OS Config patch deployments.
# @param [String] parent
# Required. The resource name of the parent in the form `projects/*`.
# @param [Fixnum] page_size
# Optional. The maximum number of patch deployments to return. Default is 100.
# @param [String] page_token
# Optional. A pagination token returned from a previous call to
# ListPatchDeployments that indicates where this listing should continue from.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::ListPatchDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::ListPatchDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_patch_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/patchDeployments', options)
command.response_representation = Google::Apis::OsconfigV1::ListPatchDeploymentsResponse::Representation
command.response_class = Google::Apis::OsconfigV1::ListPatchDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancel a patch job. The patch job must be active. Canceled patch jobs cannot
# be restarted.
# @param [String] name
# Required. Name of the patch in the form `projects/*/patchJobs/*`
# @param [Google::Apis::OsconfigV1::CancelPatchJobRequest] cancel_patch_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::PatchJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::OsconfigV1::CancelPatchJobRequest::Representation
command.request_object = cancel_patch_job_request_object
command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation
command.response_class = Google::Apis::OsconfigV1::PatchJob
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Patch VM instances by creating and running a patch job.
# @param [String] parent
# Required. The project in which to run this patch in the form `projects/*`
# @param [Google::Apis::OsconfigV1::ExecutePatchJobRequest] execute_patch_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::PatchJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/patchJobs:execute', options)
command.request_representation = Google::Apis::OsconfigV1::ExecutePatchJobRequest::Representation
command.request_object = execute_patch_job_request_object
command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation
command.response_class = Google::Apis::OsconfigV1::PatchJob
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the patch job. This can be used to track the progress of an ongoing patch
# job or review the details of completed jobs.
# @param [String] name
# Required. Name of the patch in the form `projects/*/patchJobs/*`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::PatchJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_patch_job(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation
command.response_class = Google::Apis::OsconfigV1::PatchJob
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a list of patch jobs.
# @param [String] parent
# Required. In the form of `projects/*`
# @param [String] filter
# If provided, this field specifies the criteria that must be met by patch jobs
# to be included in the response. Currently, filtering is only available on the
# patch_deployment field.
# @param [Fixnum] page_size
# The maximum number of instance status to return.
# @param [String] page_token
# A pagination token returned from a previous call that indicates where this
# listing should continue from.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::ListPatchJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::ListPatchJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_patch_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/patchJobs', options)
command.response_representation = Google::Apis::OsconfigV1::ListPatchJobsResponse::Representation
command.response_class = Google::Apis::OsconfigV1::ListPatchJobsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a list of instance details for a given patch job.
# @param [String] parent
# Required. The parent for the instances are in the form of `projects/*/
# patchJobs/*`.
# @param [String] filter
# A filter expression that filters results listed in the response. This field
# supports filtering results by instance zone, name, state, or `failure_reason`.
# @param [Fixnum] page_size
# The maximum number of instance details records to return. Default is 100.
# @param [String] page_token
# A pagination token returned from a previous call that indicates where this
# listing should continue from.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_patch_job_instance_details(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/instanceDetails', options)
command.response_representation = Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse::Representation
command.response_class = Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
