Class: Google::Apis::OsconfigV1::ExecutePatchJobRequest

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

Overview

A request message to initiate patching across Compute Engine instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExecutePatchJobRequest

Returns a new instance of ExecutePatchJobRequest.



201
202
203
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 201

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) 


164
165
166
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 164

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) 


169
170
171
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 169

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) 


174
175
176
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 174

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) 


180
181
182
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 180

def duration
  @duration
end

#instance_filter ⇒ Google::Apis::OsconfigV1::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:



187
188
189
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 187

def instance_filter
  @instance_filter
end

#patch_config ⇒ Google::Apis::OsconfigV1::PatchConfig

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

Returns:



193
194
195
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 193

def patch_config
  @patch_config
end

#rollout ⇒ Google::Apis::OsconfigV1::PatchRollout

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. Corresponds to the JSON property rollout

Returns:



199
200
201
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 199

def rollout
  @rollout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



206
207
208
209
210
211
212
213
214
 
# File 'generated/google/apis/osconfig_v1/classes.rb', line 206

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)
  @rollout = args[:rollout] if args.key?(:rollout)
end