Google Cloud OsConfig V1 Client - Class PatchDeployment (1.2.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ instance_filter Google\Cloud\OsConfig\V1\PatchInstanceFilter

Required. VM instances to patch.

↳ patch_config Google\Cloud\OsConfig\V1\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 Google\Cloud\OsConfig\V1\OneTimeSchedule

Required. Schedule a one-time execution.

↳ recurring_schedule Google\Cloud\OsConfig\V1\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 Google\Cloud\OsConfig\V1\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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.

Returns
TypeDescription
string

setDescription

Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceFilter

Required. VM instances to patch.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\PatchInstanceFilter|null

hasInstanceFilter

clearInstanceFilter

setInstanceFilter

Required. VM instances to patch.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\PatchInstanceFilter
Returns
TypeDescription
$this

getPatchConfig

Optional. Patch configuration that is applied.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\PatchConfig|null

hasPatchConfig

clearPatchConfig

setPatchConfig

Optional. Patch configuration that is applied.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\PatchConfig
Returns
TypeDescription
$this

getDuration

Optional. Duration of the patch. After the duration ends, the patch times out.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

Optional. Duration of the patch. After the duration ends, the patch times out.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getOneTimeSchedule

Required. Schedule a one-time execution.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\OneTimeSchedule|null

hasOneTimeSchedule

setOneTimeSchedule

Required. Schedule a one-time execution.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\OneTimeSchedule
Returns
TypeDescription
$this

getRecurringSchedule

Required. Schedule recurring executions.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\RecurringSchedule|null

hasRecurringSchedule

setRecurringSchedule

Required. Schedule recurring executions.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\RecurringSchedule
Returns
TypeDescription
$this

getCreateTime

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLastExecuteTime

Output only. The last time a patch job was started by this deployment.

Timestamp is in RFC3339 text format.

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getRollout

Optional. Rollout strategy of the patch job.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\PatchRollout|null

hasRollout

clearRollout

setRollout

Optional. Rollout strategy of the patch job.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\PatchRollout
Returns
TypeDescription
$this

getState

Output only. Current state of the patch deployment.

Returns
TypeDescription
int

setState

Output only. Current state of the patch deployment.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSchedule

Returns
TypeDescription
string