Class: Google::Apis::OsconfigV1beta::PatchJob

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

Overview

A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see Creating patch jobs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PatchJob

Returns a new instance of PatchJob.



1544
1545
1546
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1544

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

Instance Attribute Details

#create_time ⇒ String

Time this patch job was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1461
1462
1463
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1461

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1467
1468
1469
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1467

def description
  @description
end

#display_name ⇒ String

Display name for this patch job. This is not a unique identifier. Corresponds to the JSON property displayName

Returns:

  • (String) 


1472
1473
1474
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1472

def display_name
  @display_name
end

#dry_run ⇒ Boolean Also known as: dry_run?

If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. Corresponds to the JSON property dryRun

Returns:

  • (Boolean) 


1478
1479
1480
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1478

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) 


1484
1485
1486
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1484

def duration
  @duration
end

#error_message ⇒ String

If this patch job failed, this message provides information about the failure. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


1489
1490
1491
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1489

def error_message
  @error_message
end

#instance_details_summary ⇒ Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary

A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to InstancePatchState. List patch job instance details to see the specific states of each instance. Corresponds to the JSON property instanceDetailsSummary

Returns:



1497
1498
1499
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1497

def instance_details_summary
  @instance_details_summary
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:



1504
1505
1506
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1504

def instance_filter
  @instance_filter
end

#name ⇒ String

Unique identifier for this patch job in the form projects/*/patchJobs/* Corresponds to the JSON property name

Returns:

  • (String) 


1509
1510
1511
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1509

def name
  @name
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:



1515
1516
1517
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1515

def patch_config
  @patch_config
end

#patch_deployment ⇒ String

Output only. Name of the patch deployment that created this patch job. Corresponds to the JSON property patchDeployment

Returns:

  • (String) 


1520
1521
1522
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1520

def patch_deployment
  @patch_deployment
end

#percent_complete ⇒ Float

Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. Corresponds to the JSON property percentComplete

Returns:

  • (Float) 


1526
1527
1528
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1526

def percent_complete
  @percent_complete
end

#rollout ⇒ Google::Apis::OsconfigV1beta::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:



1532
1533
1534
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1532

def rollout
  @rollout
end

#state ⇒ String

The current state of the PatchJob. Corresponds to the JSON property state

Returns:

  • (String) 


1537
1538
1539
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1537

def state
  @state
end

#update_time ⇒ String

Last time this patch job was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1542
1543
1544
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1542

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1549

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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)
  @error_message = args[:error_message] if args.key?(:error_message)
  @instance_details_summary = args[:instance_details_summary] if args.key?(:instance_details_summary)
  @instance_filter = args[:instance_filter] if args.key?(:instance_filter)
  @name = args[:name] if args.key?(:name)
  @patch_config = args[:patch_config] if args.key?(:patch_config)
  @patch_deployment = args[:patch_deployment] if args.key?(:patch_deployment)
  @percent_complete = args[:percent_complete] if args.key?(:percent_complete)
  @rollout = args[:rollout] if args.key?(:rollout)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end