Class: Google::Apis::OsconfigV1beta::ExecutePatchJobRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/osconfig_v1beta/classes.rb,
generated/google/apis/osconfig_v1beta/representations.rb,
generated/google/apis/osconfig_v1beta/representations.rb

Overview

A request message to initiate patching across Google Compute Engine instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ExecutePatchJobRequest

Returns a new instance of ExecutePatchJobRequest.



507
508
509
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 507

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Description of the patch job. Length of the description is limited to 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


473
474
475
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 473

def description
  @description
end

#display_name ⇒ String

Display name for this patch job. This does not have to be unique. Corresponds to the JSON property displayName

Returns:

  • (String) 


478
479
480
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 478

def display_name
  @display_name
end

#dry_run ⇒ Boolean Also known as: dry_run?

If this patch is a dry-run only, instances are contacted but will do nothing. Corresponds to the JSON property dryRun

Returns:

  • (Boolean) 


484
485
486
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 484

def dry_run
  @dry_run
end

#duration ⇒ String

Duration of the patch job. After the duration ends, the patch job times out. Corresponds to the JSON property duration

Returns:

  • (String) 


491
492
493
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 491

def duration
  @duration
end

#instance_filter ⇒ Google::Apis::OsconfigV1beta::PatchInstanceFilter

A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. Corresponds to the JSON property instanceFilter

Returns:



499
500
501
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 499

def instance_filter
  @instance_filter
end

#patch_config ⇒ Google::Apis::OsconfigV1beta::PatchConfig

Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. Corresponds to the JSON property patchConfig

Returns:



505
506
507
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 505

def patch_config
  @patch_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



512
513
514
515
516
517
518
519
 
# File 'generated/google/apis/osconfig_v1beta/classes.rb', line 512

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @duration = args[:duration] if args.key?(:duration)
  @instance_filter = args[:instance_filter] if args.key?(:instance_filter)
  @patch_config = args[:patch_config] if args.key?(:patch_config)
end