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



613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 613

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_location_os_policy_assignment(parent, os_policy_assignment_object = nil, os_policy_assignment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::Operation

Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations. osPolicyAssignments.operations.cancel.

Parameters:

  • parent (String) —

    Required. The parent resource name in the form: projects/project/locations/ location

  • os_policy_assignment_object (Google::Apis::OsconfigV1::OsPolicyAssignment) (defaults to: nil)
  • os_policy_assignment_id (String) (defaults to: nil) —

    Required. The logical name of the OS policy assignment in the project with the following restrictions: * 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



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

def create_project_location_os_policy_assignment(parent, os_policy_assignment_object = nil, os_policy_assignment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/osPolicyAssignments', options)
  command.request_representation = Google::Apis::OsconfigV1::OsPolicyAssignment::Representation
  command.request_object = os_policy_assignment_object
  command.response_representation = Google::Apis::OsconfigV1::Operation::Representation
  command.response_class = Google::Apis::OsconfigV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['osPolicyAssignmentId'] = os_policy_assignment_id unless os_policy_assignment_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

#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



479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 479

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

Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters:

  • name (String) —

    Required. The name of the OS policy assignment to be deleted

  • 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



288
289
290
291
292
293
294
295
296
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 288

def delete_project_location_os_policy_assignment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsconfigV1::Operation::Representation
  command.response_class = Google::Apis::OsconfigV1::Operation
  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

#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



513
514
515
516
517
518
519
520
521
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 513

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



646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 646

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

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters:

  • name (String) —

    Required. API resource name for inventory resource. Format: projects/project /locations/location/instances/instance/inventory For project, either project-number or project-id can be provided. For instance, either Compute Engine instance-id or instance-name can be provided.

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

    Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

  • 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
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 80

def get_project_location_instance_inventory(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsconfigV1::Inventory::Representation
  command.response_class = Google::Apis::OsconfigV1::Inventory
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.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_location_instance_vulnerability_report(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::VulnerabilityReport

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters:

  • name (String) —

    Required. API resource name for vulnerability resource. Format: projects/ project/locations/location/instances/instance/vulnerabilityReport For project, either project-number or project-id can be provided. For instance, either Compute Engine instance-id or instance-name can be provided.

  • 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



163
164
165
166
167
168
169
170
171
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 163

def get_project_location_instance_vulnerability_report(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsconfigV1::VulnerabilityReport::Representation
  command.response_class = Google::Apis::OsconfigV1::VulnerabilityReport
  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_location_os_policy_assignment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::OsPolicyAssignment

Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters:

  • name (String) —

    Required. The resource name of OS policy assignment. Format: projects/ project/locations/location/osPolicyAssignments/os_policy_assignment@ revisionId``

  • 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



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

def get_project_location_os_policy_assignment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsconfigV1::OsPolicyAssignment::Representation
  command.response_class = Google::Apis::OsconfigV1::OsPolicyAssignment
  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_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



544
545
546
547
548
549
550
551
552
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 544

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



679
680
681
682
683
684
685
686
687
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 679

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_location_instance_inventories(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListInventoriesResponse

List inventory data for all VM instances in the specified zone.

Parameters:

  • parent (String) —

    Required. The parent resource name. Format: projects/project/locations/ location/instances/- For project, either project-number or project-id can be provided.

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

    If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.

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

    The maximum number of results to return.

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

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

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

    Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

  • 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



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 124

def list_project_location_instance_inventories(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/inventories', options)
  command.response_representation = Google::Apis::OsconfigV1::ListInventoriesResponse::Representation
  command.response_class = Google::Apis::OsconfigV1::ListInventoriesResponse
  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['view'] = view unless view.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_location_instance_vulnerability_reports(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListVulnerabilityReportsResponse

List vulnerability reports for all VM instances in the specified zone.

Parameters:

  • parent (String) —

    Required. The parent resource name. Format: projects/project/locations/ location/instances/- For project, either project-number or project-id can be provided.

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

    If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.

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

    The maximum number of results to return.

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

    A pagination token returned from a previous call to ListVulnerabilityReports 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



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 203

def list_project_location_instance_vulnerability_reports(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/vulnerabilityReports', options)
  command.response_representation = Google::Apis::OsconfigV1::ListVulnerabilityReportsResponse::Representation
  command.response_class = Google::Apis::OsconfigV1::ListVulnerabilityReportsResponse
  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_location_os_policy_assignment_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListOsPolicyAssignmentRevisionsResponse

List the OS policy assignment revisions for a given OS policy assignment.

Parameters:

  • name (String) —

    Required. The name of the OS policy assignment to list revisions for.

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

    The maximum number of revisions to return.

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

    A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions 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



396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 396

def list_project_location_os_policy_assignment_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
  command.response_representation = Google::Apis::OsconfigV1::ListOsPolicyAssignmentRevisionsResponse::Representation
  command.response_class = Google::Apis::OsconfigV1::ListOsPolicyAssignmentRevisionsResponse
  command.params['name'] = name unless name.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_location_os_policy_assignments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::ListOsPolicyAssignmentsResponse

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

Parameters:

  • parent (String) —

    Required. The parent resource name.

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

    The maximum number of assignments to return.

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

    A pagination token returned from a previous call to ListOSPolicyAssignments 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



358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 358

def list_project_location_os_policy_assignments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/osPolicyAssignments', options)
  command.response_representation = Google::Apis::OsconfigV1::ListOsPolicyAssignmentsResponse::Representation
  command.response_class = Google::Apis::OsconfigV1::ListOsPolicyAssignmentsResponse
  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_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



579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 579

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



760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 760

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



718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 718

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

#patch_project_location_os_policy_assignment(name, os_policy_assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1::Operation

Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations. osPolicyAssignments.operations.cancel.

Parameters:

  • name (String) —

    Resource name. Format: projects/project_number/locations/location/ osPolicyAssignments/os_policy_assignment_id`` This field is ignored when you create an OS policy assignment.

  • os_policy_assignment_object (Google::Apis::OsconfigV1::OsPolicyAssignment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. Field mask that controls which fields of the assignment should be updated.

  • 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



439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/apis/osconfig_v1/service.rb', line 439

def patch_project_location_os_policy_assignment(name, os_policy_assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::OsconfigV1::OsPolicyAssignment::Representation
  command.request_object = os_policy_assignment_object
  command.response_representation = Google::Apis::OsconfigV1::Operation::Representation
  command.response_class = Google::Apis::OsconfigV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end