Cloud OS Config V1 API - Class Google::Cloud::OsConfig::V1::PatchJob (v0.11.0)

Reference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::PatchJob.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — Description of the patch job. Length of the description is limited to 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Description of the patch job. Length of the description is limited to 1024 characters.
Returns
  • (::String) — Description of the patch job. Length of the description is limited to 1024 characters.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Display name for this patch job. This is not a unique identifier.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Display name for this patch job. This is not a unique identifier.
Returns
  • (::String) — Display name for this patch job. This is not a unique identifier.

#dry_run

def dry_run() -> ::Boolean
Returns
  • (::Boolean) — If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.

#dry_run=

def dry_run=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
Returns
  • (::Boolean) — If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.

#duration

def duration() -> ::Google::Protobuf::Duration
Returns

#duration=

def duration=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#error_message

def error_message() -> ::String
Returns
  • (::String) — If this patch job failed, this message provides information about the failure.

#error_message=

def error_message=(value) -> ::String
Parameter
  • value (::String) — If this patch job failed, this message provides information about the failure.
Returns
  • (::String) — If this patch job failed, this message provides information about the failure.

#instance_details_summary

def instance_details_summary() -> ::Google::Cloud::OsConfig::V1::PatchJob::InstanceDetailsSummary
Returns

#instance_details_summary=

def instance_details_summary=(value) -> ::Google::Cloud::OsConfig::V1::PatchJob::InstanceDetailsSummary
Parameter
Returns

#instance_filter

def instance_filter() -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Returns

#instance_filter=

def instance_filter=(value) -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Unique identifier for this patch job in the form projects/*/patchJobs/*

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Unique identifier for this patch job in the form projects/*/patchJobs/*
Returns
  • (::String) — Unique identifier for this patch job in the form projects/*/patchJobs/*

#patch_config

def patch_config() -> ::Google::Cloud::OsConfig::V1::PatchConfig
Returns

#patch_config=

def patch_config=(value) -> ::Google::Cloud::OsConfig::V1::PatchConfig
Parameter
Returns

#patch_deployment

def patch_deployment() -> ::String
Returns
  • (::String) — Output only. Name of the patch deployment that created this patch job.

#percent_complete

def percent_complete() -> ::Float
Returns
  • (::Float) — Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.

#percent_complete=

def percent_complete=(value) -> ::Float
Parameter
  • value (::Float) — Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
Returns
  • (::Float) — Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.

#rollout

def rollout() -> ::Google::Cloud::OsConfig::V1::PatchRollout
Returns

#rollout=

def rollout=(value) -> ::Google::Cloud::OsConfig::V1::PatchRollout
Parameter
Returns

#state

def state() -> ::Google::Cloud::OsConfig::V1::PatchJob::State
Returns

#state=

def state=(value) -> ::Google::Cloud::OsConfig::V1::PatchJob::State
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns