Class: Google::Apis::OsconfigV1::OSConfigService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/osconfig_v1/service.rb

Overview

OS Config API

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

Examples:

require 'google/apis/osconfig_v1'

Osconfig = Google::Apis::OsconfigV1 # Alias the module
service = Osconfig::OSConfigService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ OSConfigService

Returns a new instance of OSConfigService.



46
47
48
49
50
51
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 46

def initialize
  super('https://osconfig.googleapis.com/', '',
        client_name: 'google-apis-osconfig_v1',
        client_version: Google::Apis::OsconfigV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



39
40
41
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



44
45
46
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::PatchJob

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters:

  • name (String) —

    Required. Name of the patch in the form projects/*/patchJobs/*

  • cancel_patch_job_request_object (Google::Apis::OsconfigV1::CancelPatchJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 214

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

#create_project_patch_deployment(parent, patch_deployment_object = nil, patch_deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::PatchDeployment

Create an OS Config patch deployment.

Parameters:

  • parent (String) —

    Required. The project to apply this patch deployment to in the form projects/* .

  • patch_deployment_object (Google::Apis::OsconfigV1::PatchDeployment) (defaults to: nil)
  • patch_deployment_id (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 80

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_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::Empty

Delete an OS Config patch deployment.

Parameters:

  • name (String) —

    Required. The resource name of the patch deployment in the form projects/*/ patchDeployments/*.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



114
115
116
117
118
119
120
121
122
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 114

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

#execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::PatchJob

Patch VM instances by creating and running a patch job.

Parameters:

  • parent (String) —

    Required. The project in which to run this patch in the form projects/*

  • execute_patch_job_request_object (Google::Apis::OsconfigV1::ExecutePatchJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 247

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_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::PatchDeployment

Get an OS Config patch deployment.

Parameters:

  • name (String) —

    Required. The resource name of the patch deployment in the form projects/*/ patchDeployments/*.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



145
146
147
148
149
150
151
152
153
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 145

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_project_patch_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::PatchJob

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters:

  • name (String) —

    Required. Name of the patch in the form projects/*/patchJobs/*

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



280
281
282
283
284
285
286
287
288
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 280

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

#list_project_patch_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListPatchDeploymentsResponse

Get a page of OS Config patch deployments.

Parameters:

  • parent (String) —

    Required. The resource name of the parent in the form projects/*.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of patch deployments to return. Default is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 180

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

#list_project_patch_job_instance_details(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse

Get a list of instance details for a given patch job.

Parameters:

  • parent (String) —

    Required. The parent for the instances are in the form of projects/*/ patchJobs/*.

  • filter (String) (defaults to: nil) —

    A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of instance details records to return. Default is 100.

  • page_token (String) (defaults to: nil) —

    A pagination token returned from a previous call that indicates where this listing should continue from.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 361

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

#list_project_patch_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListPatchJobsResponse

Get a list of patch jobs.

Parameters:

  • parent (String) —

    Required. In the form of projects/*

  • filter (String) (defaults to: nil) —

    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.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of instance status to return.

  • page_token (String) (defaults to: nil) —

    A pagination token returned from a previous call that indicates where this listing should continue from.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 319

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