Reference documentation and code samples for the Google Cloud OsConfig V1 Client class PatchDeployment.
Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs.
Generated from protobuf message google.cloud.osconfig.v1.PatchDeployment
Namespace
Google \ Cloud \ OsConfig \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Unique name for the patch deployment resource in a project. The patch deployment name is in the form: |
↳ description |
string
Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. |
↳ instance_filter |
PatchInstanceFilter
Required. VM instances to patch. |
↳ patch_config |
PatchConfig
Optional. Patch configuration that is applied. |
↳ duration |
Google\Protobuf\Duration
Optional. Duration of the patch. After the duration ends, the patch times out. |
↳ one_time_schedule |
OneTimeSchedule
Required. Schedule a one-time execution. |
↳ recurring_schedule |
RecurringSchedule
Required. Schedule recurring executions. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format. |
↳ last_execute_time |
Google\Protobuf\Timestamp
Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format. |
↳ rollout |
PatchRollout
Optional. Rollout strategy of the patch job. |
↳ state |
int
Output only. Current state of the patch deployment. |
getName
Unique name for the patch deployment resource in a project. The patch
deployment name is in the form:
projects/{project_id}/patchDeployments/{patch_deployment_id}.
This field is ignored when you create a new patch deployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Unique name for the patch deployment resource in a project. The patch
deployment name is in the form:
projects/{project_id}/patchDeployments/{patch_deployment_id}.
This field is ignored when you create a new patch deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstanceFilter
Required. VM instances to patch.
| Returns | |
|---|---|
| Type | Description |
PatchInstanceFilter|null |
|
hasInstanceFilter
clearInstanceFilter
setInstanceFilter
Required. VM instances to patch.
| Parameter | |
|---|---|
| Name | Description |
var |
PatchInstanceFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPatchConfig
Optional. Patch configuration that is applied.
| Returns | |
|---|---|
| Type | Description |
PatchConfig|null |
|
hasPatchConfig
clearPatchConfig
setPatchConfig
Optional. Patch configuration that is applied.
| Parameter | |
|---|---|
| Name | Description |
var |
PatchConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDuration
Optional. Duration of the patch. After the duration ends, the patch times out.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasDuration
clearDuration
setDuration
Optional. Duration of the patch. After the duration ends, the patch times out.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOneTimeSchedule
Required. Schedule a one-time execution.
| Returns | |
|---|---|
| Type | Description |
OneTimeSchedule|null |
|
hasOneTimeSchedule
setOneTimeSchedule
Required. Schedule a one-time execution.
| Parameter | |
|---|---|
| Name | Description |
var |
OneTimeSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecurringSchedule
Required. Schedule recurring executions.
| Returns | |
|---|---|
| Type | Description |
RecurringSchedule|null |
|
hasRecurringSchedule
setRecurringSchedule
Required. Schedule recurring executions.
| Parameter | |
|---|---|
| Name | Description |
var |
RecurringSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastExecuteTime
Output only. The last time a patch job was started by this deployment.
Timestamp is in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastExecuteTime
clearLastExecuteTime
setLastExecuteTime
Output only. The last time a patch job was started by this deployment.
Timestamp is in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRollout
Optional. Rollout strategy of the patch job.
| Returns | |
|---|---|
| Type | Description |
PatchRollout|null |
|
hasRollout
clearRollout
setRollout
Optional. Rollout strategy of the patch job.
| Parameter | |
|---|---|
| Name | Description |
var |
PatchRollout
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the patch deployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. Current state of the patch deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchedule
| Returns | |
|---|---|
| Type | Description |
string |
|