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, seeScheduling patch
jobs.
Generated from protobuf messagegoogle.cloud.osconfig.v1.PatchDeployment
Namespace
Google \ Cloud \ OsConfig \ V1
Methods
__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:projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.
↳ description
string
Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud OsConfig V1 Client - Class PatchDeployment (2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/php/docs/reference/cloud-osconfig/latest/V1.PatchDeployment)\n- [2.0.5](/php/docs/reference/cloud-osconfig/2.0.5/V1.PatchDeployment)\n- [1.3.5](/php/docs/reference/cloud-osconfig/1.3.5/V1.PatchDeployment)\n- [1.2.2](/php/docs/reference/cloud-osconfig/1.2.2/V1.PatchDeployment)\n- [1.1.1](/php/docs/reference/cloud-osconfig/1.1.1/V1.PatchDeployment)\n- [1.0.5](/php/docs/reference/cloud-osconfig/1.0.5/V1.PatchDeployment) \nReference documentation and code samples for the Google Cloud OsConfig V1 Client class PatchDeployment.\n\nPatch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).\n\nGenerated from protobuf message `google.cloud.osconfig.v1.PatchDeployment`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ OsConfig \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nUnique name for the patch deployment resource in a project. The patch\ndeployment name is in the form:\n`projects/{project_id}/patchDeployments/{patch_deployment_id}`.\n\nThis field is ignored when you create a new patch deployment.\n\n### setName\n\nUnique name for the patch deployment resource in a project. The patch\ndeployment name is in the form:\n`projects/{project_id}/patchDeployments/{patch_deployment_id}`.\n\nThis field is ignored when you create a new patch deployment.\n\n### getDescription\n\nOptional. Description of the patch deployment. Length of the description is\nlimited to 1024 characters.\n\n### setDescription\n\nOptional. Description of the patch deployment. Length of the description is\nlimited to 1024 characters.\n\n### getInstanceFilter\n\nRequired. VM instances to patch.\n\n### hasInstanceFilter\n\n### clearInstanceFilter\n\n### setInstanceFilter\n\nRequired. VM instances to patch.\n\n### getPatchConfig\n\nOptional. Patch configuration that is applied.\n\n### hasPatchConfig\n\n### clearPatchConfig\n\n### setPatchConfig\n\nOptional. Patch configuration that is applied.\n\n### getDuration\n\nOptional. Duration of the patch. After the duration ends, the patch times\nout.\n\n### hasDuration\n\n### clearDuration\n\n### setDuration\n\nOptional. Duration of the patch. After the duration ends, the patch times\nout.\n\n### getOneTimeSchedule\n\nRequired. Schedule a one-time execution.\n\n### hasOneTimeSchedule\n\n### setOneTimeSchedule\n\nRequired. Schedule a one-time execution.\n\n### getRecurringSchedule\n\nRequired. Schedule recurring executions.\n\n### hasRecurringSchedule\n\n### setRecurringSchedule\n\nRequired. Schedule recurring executions.\n\n### getCreateTime\n\nOutput only. Time the patch deployment was created. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Time the patch deployment was created. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.\n\n### getUpdateTime\n\nOutput only. Time the patch deployment was last updated. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Time the patch deployment was last updated. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.\n\n### getLastExecuteTime\n\nOutput only. The last time a patch job was started by this deployment.\n\nTimestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text\nformat.\n\n### hasLastExecuteTime\n\n### clearLastExecuteTime\n\n### setLastExecuteTime\n\nOutput only. The last time a patch job was started by this deployment.\n\nTimestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text\nformat.\n\n### getRollout\n\nOptional. Rollout strategy of the patch job.\n\n### hasRollout\n\n### clearRollout\n\n### setRollout\n\nOptional. Rollout strategy of the patch job.\n\n### getState\n\nOutput only. Current state of the patch deployment.\n\n### setState\n\nOutput only. Current state of the patch deployment.\n\n### getSchedule"]]
