Reference documentation and code samples for the Google Cloud OsConfig V1 Client class 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 .
Generated from protobuf message google.cloud.osconfig.v1.PatchJob
Namespace
Google \ Cloud \ OsConfig \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Unique identifier for this patch job in the form projects/*/patchJobs/*
↳ display_name
string
Display name for this patch job. This is not a unique identifier.
↳ description
string
Description of the patch job. Length of the description is limited to 1024 characters.
↳ create_time
↳ update_time
↳ state
int
The current state of the PatchJob.
↳ instance_filter
↳ patch_config
↳ duration
Google\Protobuf\Duration
Duration of the patch job. After the duration ends, the patch job times out.
↳ instance_details_summary
↳ dry_run
bool
If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
↳ error_message
string
If this patch job failed, this message provides information about the failure.
↳ 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.
↳ patch_deployment
string
Output only. Name of the patch deployment that created this patch job.
↳ rollout
getName
Unique identifier for this patch job in the form projects/*/patchJobs/*
string
setName
Unique identifier for this patch job in the form projects/*/patchJobs/*
var
string
$this
getDisplayName
Display name for this patch job. This is not a unique identifier.
string
setDisplayName
Display name for this patch job. This is not a unique identifier.
var
string
$this
getDescription
Description of the patch job. Length of the description is limited to 1024 characters.
string
setDescription
Description of the patch job. Length of the description is limited to 1024 characters.
var
string
$this
getCreateTime
Time this patch job was created.
hasCreateTime
clearCreateTime
setCreateTime
Time this patch job was created.
$this
getUpdateTime
Last time this patch job was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Last time this patch job was updated.
$this
getState
The current state of the PatchJob.
int
setState
The current state of the PatchJob.
var
int
$this
getInstanceFilter
Instances to patch.
hasInstanceFilter
clearInstanceFilter
setInstanceFilter
Instances to patch.
$this
getPatchConfig
Patch configuration being applied.
hasPatchConfig
clearPatchConfig
setPatchConfig
Patch configuration being applied.
$this
getDuration
Duration of the patch job. After the duration ends, the patch job times out.
hasDuration
clearDuration
setDuration
Duration of the patch job. After the duration ends, the patch job times out.
$this
getInstanceDetailsSummary
Summary of instance details.
hasInstanceDetailsSummary
clearInstanceDetailsSummary
setInstanceDetailsSummary
Summary of instance details.
$this
getDryRun
If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
bool
setDryRun
If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
var
bool
$this
getErrorMessage
If this patch job failed, this message provides information about the failure.
string
setErrorMessage
If this patch job failed, this message provides information about the failure.
var
string
$this
getPercentComplete
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
float
setPercentComplete
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
var
float
$this
getPatchDeployment
Output only. Name of the patch deployment that created this patch job.
string
setPatchDeployment
Output only. Name of the patch deployment that created this patch job.
var
string
$this
getRollout
Rollout strategy being applied.
hasRollout
clearRollout
setRollout
Rollout strategy being applied.
$this
