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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Unique identifier for this patch job in the form |
↳ 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 |
Google\Protobuf\Timestamp
Time this patch job was created. |
↳ update_time |
Google\Protobuf\Timestamp
Last time this patch job was updated. |
↳ state |
int
The current state of the PatchJob. |
↳ instance_filter |
Google\Cloud\OsConfig\V1\PatchInstanceFilter
Instances to patch. |
↳ patch_config |
Google\Cloud\OsConfig\V1\PatchConfig
Patch configuration being applied. |
↳ duration |
Google\Protobuf\Duration
Duration of the patch job. After the duration ends, the patch job times out. |
↳ instance_details_summary |
Google\Cloud\OsConfig\V1\PatchJob\InstanceDetailsSummary
Summary of instance details. |
↳ 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 |
Google\Cloud\OsConfig\V1\PatchRollout
Rollout strategy being applied. |
getName
Unique identifier for this patch job in the form
projects/*/patchJobs/*
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Unique identifier for this patch job in the form
projects/*/patchJobs/*
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Display name for this patch job. This is not a unique identifier.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Display name for this patch job. This is not a unique identifier.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the patch job. Length of the description is limited to 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the patch job. Length of the description is limited to 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Time this patch job was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Time this patch job was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Last time this patch job was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Last time this patch job was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The current state of the PatchJob.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The current state of the PatchJob.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceFilter
Instances to patch.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsConfig\V1\PatchInstanceFilter|null | |
hasInstanceFilter
clearInstanceFilter
setInstanceFilter
Instances to patch.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsConfig\V1\PatchInstanceFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPatchConfig
Patch configuration being applied.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsConfig\V1\PatchConfig|null | |
hasPatchConfig
clearPatchConfig
setPatchConfig
Patch configuration being applied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsConfig\V1\PatchConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDuration
Duration of the patch job. After the duration ends, the patch job times out.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasDuration
clearDuration
setDuration
Duration of the patch job. After the duration ends, the patch job times out.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceDetailsSummary
Summary of instance details.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsConfig\V1\PatchJob\InstanceDetailsSummary|null | |
hasInstanceDetailsSummary
clearInstanceDetailsSummary
setInstanceDetailsSummary
Summary of instance details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsConfig\V1\PatchJob\InstanceDetailsSummary
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrorMessage
If this patch job failed, this message provides information about the failure.
| Returns | |
|---|---|
| Type | Description |
string | |
setErrorMessage
If this patch job failed, this message provides information about the failure.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPercentComplete
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
| Returns | |
|---|---|
| Type | Description |
float | |
setPercentComplete
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPatchDeployment
Output only. Name of the patch deployment that created this patch job.
| Returns | |
|---|---|
| Type | Description |
string | |
setPatchDeployment
Output only. Name of the patch deployment that created this patch job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRollout
Rollout strategy being applied.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsConfig\V1\PatchRollout|null | |
hasRollout
clearRollout
setRollout
Rollout strategy being applied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsConfig\V1\PatchRollout
|
| Returns | |
|---|---|
| Type | Description |
$this | |