Class: Google::Apis::OsconfigV1beta::SystemsManagementService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::OsconfigV1beta::SystemsManagementService
- Defined in:
- generated/google/apis/osconfig_v1beta/service.rb
Overview
Cloud OS Config API
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::PatchJob
Cancel a patch job.
-
#create_project_guest_policy(parent, guest_policy_object = nil, guest_policy_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Create an OS Config guest policy.
-
#create_project_patch_deployment(parent, patch_deployment_object = nil, patch_deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::PatchDeployment
Create an OS Config patch deployment.
-
#delete_project_guest_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::Empty
Delete an OS Config guest policy.
-
#delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::Empty
Delete an OS Config patch deployment.
-
#execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::PatchJob
Patch VM instances by creating and running a patch job.
-
#get_project_guest_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Get an OS Config guest policy.
-
#get_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::PatchDeployment
Get an OS Config patch deployment.
-
#get_project_patch_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::PatchJob
Get the patch job.
-
#initialize ⇒ SystemsManagementService
constructor
A new instance of SystemsManagementService.
-
#list_project_guest_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse
Get a page of OS Config guest policies.
-
#list_project_patch_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse
Get a page of OS Config patch deployments.
-
#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::OsconfigV1beta::ListPatchJobInstanceDetailsResponse
Get a list of instance details for a given patch job.
-
#list_project_patch_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::ListPatchJobsResponse
Get a list of patch jobs.
-
#lookup_instance_effective_guest_policy(instance, lookup_effective_guest_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::EffectiveGuestPolicy
Lookup the effective guest policy that applies to a VM instance.
-
#patch_project_guest_policy(name, guest_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Update an OS Config guest policy.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ SystemsManagementService
Returns a new instance of SystemsManagementService.
46 47 48 49 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 46 def initialize super('https://osconfig.googleapis.com/', '') @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.
39 40 41 |
# File 'generated/google/apis/osconfig_v1beta/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.
44 45 46 |
# File 'generated/google/apis/osconfig_v1beta/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::OsconfigV1beta::PatchJob
Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
401 402 403 404 405 406 407 408 409 410 411 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 401 def cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+name}:cancel', ) command.request_representation = Google::Apis::OsconfigV1beta::CancelPatchJobRequest::Representation command.request_object = cancel_patch_job_request_object command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation command.response_class = Google::Apis::OsconfigV1beta::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_guest_policy(parent, guest_policy_object = nil, guest_policy_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Create an OS Config guest policy.
81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 81 def create_project_guest_policy(parent, guest_policy_object = nil, guest_policy_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}/guestPolicies', ) command.request_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation command.request_object = guest_policy_object command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy command.params['parent'] = parent unless parent.nil? command.query['guestPolicyId'] = guest_policy_id unless guest_policy_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::OsconfigV1beta::PatchDeployment
Create an OS Config patch deployment.
266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 266 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, 'v1beta/{+parent}/patchDeployments', ) command.request_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation command.request_object = patch_deployment_object command.response_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation command.response_class = Google::Apis::OsconfigV1beta::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_guest_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::Empty
Delete an OS Config guest policy.
116 117 118 119 120 121 122 123 124 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 116 def delete_project_guest_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', ) command.response_representation = Google::Apis::OsconfigV1beta::Empty::Representation command.response_class = Google::Apis::OsconfigV1beta::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 |
#delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::Empty
Delete an OS Config patch deployment.
300 301 302 303 304 305 306 307 308 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 300 def delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', ) command.response_representation = Google::Apis::OsconfigV1beta::Empty::Representation command.response_class = Google::Apis::OsconfigV1beta::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::OsconfigV1beta::PatchJob
Patch VM instances by creating and running a patch job.
434 435 436 437 438 439 440 441 442 443 444 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 434 def execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}/patchJobs:execute', ) command.request_representation = Google::Apis::OsconfigV1beta::ExecutePatchJobRequest::Representation command.request_object = execute_patch_job_request_object command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation command.response_class = Google::Apis::OsconfigV1beta::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_guest_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Get an OS Config guest policy.
148 149 150 151 152 153 154 155 156 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 148 def get_project_guest_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy 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::OsconfigV1beta::PatchDeployment
Get an OS Config patch deployment.
331 332 333 334 335 336 337 338 339 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 331 def get_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::OsconfigV1beta::PatchDeployment::Representation command.response_class = Google::Apis::OsconfigV1beta::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::OsconfigV1beta::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.
467 468 469 470 471 472 473 474 475 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 467 def get_project_patch_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::OsconfigV1beta::PatchJob::Representation command.response_class = Google::Apis::OsconfigV1beta::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_guest_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse
Get a page of OS Config guest policies.
184 185 186 187 188 189 190 191 192 193 194 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 184 def list_project_guest_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+parent}/guestPolicies', ) command.response_representation = Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse::Representation command.response_class = Google::Apis::OsconfigV1beta::ListGuestPoliciesResponse 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::OsconfigV1beta::ListPatchDeploymentsResponse
Get a page of OS Config patch deployments.
367 368 369 370 371 372 373 374 375 376 377 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 367 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, 'v1beta/{+parent}/patchDeployments', ) command.response_representation = Google::Apis::OsconfigV1beta::ListPatchDeploymentsResponse::Representation command.response_class = Google::Apis::OsconfigV1beta::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::OsconfigV1beta::ListPatchJobInstanceDetailsResponse
Get a list of instance details for a given patch job.
549 550 551 552 553 554 555 556 557 558 559 560 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 549 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, 'v1beta/{+parent}/instanceDetails', ) command.response_representation = Google::Apis::OsconfigV1beta::ListPatchJobInstanceDetailsResponse::Representation command.response_class = Google::Apis::OsconfigV1beta::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::OsconfigV1beta::ListPatchJobsResponse
Get a list of patch jobs.
506 507 508 509 510 511 512 513 514 515 516 517 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 506 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, 'v1beta/{+parent}/patchJobs', ) command.response_representation = Google::Apis::OsconfigV1beta::ListPatchJobsResponse::Representation command.response_class = Google::Apis::OsconfigV1beta::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 |
#lookup_instance_effective_guest_policy(instance, lookup_effective_guest_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::EffectiveGuestPolicy
Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.
584 585 586 587 588 589 590 591 592 593 594 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 584 def lookup_instance_effective_guest_policy(instance, lookup_effective_guest_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+instance}:lookupEffectiveGuestPolicy', ) command.request_representation = Google::Apis::OsconfigV1beta::LookupEffectiveGuestPolicyRequest::Representation command.request_object = lookup_effective_guest_policy_request_object command.response_representation = Google::Apis::OsconfigV1beta::EffectiveGuestPolicy::Representation command.response_class = Google::Apis::OsconfigV1beta::EffectiveGuestPolicy command.params['instance'] = instance unless instance.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_guest_policy(name, guest_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsconfigV1beta::GuestPolicy
Update an OS Config guest policy.
223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'generated/google/apis/osconfig_v1beta/service.rb', line 223 def patch_project_guest_policy(name, guest_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta/{+name}', ) command.request_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation command.request_object = guest_policy_object command.response_representation = Google::Apis::OsconfigV1beta::GuestPolicy::Representation command.response_class = Google::Apis::OsconfigV1beta::GuestPolicy 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 |