Google Cloud OsConfig V1 Client - Class ExecutePatchJobRequest (1.0.5)

Reference documentation and code samples for the Google Cloud OsConfig V1 Client class ExecutePatchJobRequest.

A request message to initiate patching across Compute Engine instances.

Generated from protobuf message google.cloud.osconfig.v1.ExecutePatchJobRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The project in which to run this patch in the form projects/*

↳ description string

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

↳ instance_filter Google\Cloud\OsConfig\V1\PatchInstanceFilter

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

↳ patch_config Google\Cloud\OsConfig\V1\PatchConfig

Patch configuration being applied. If omitted, instances are patched using the default configurations.

↳ duration Google\Protobuf\Duration

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

↳ dry_run bool

If this patch is a dry-run only, instances are contacted but will do nothing.

↳ display_name string

Display name for this patch job. This does not have to be unique.

↳ rollout Google\Cloud\OsConfig\V1\PatchRollout

Rollout strategy of the patch job.

getParent

Required. The project in which to run this patch in the form projects/*

Returns
TypeDescription
string

setParent

Required. The project in which to run this patch in the form projects/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

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

Returns
TypeDescription
string

setDescription

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceFilter

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

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

hasInstanceFilter

clearInstanceFilter

setInstanceFilter

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

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

getPatchConfig

Patch configuration being applied. If omitted, instances are patched using the default configurations.

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

hasPatchConfig

clearPatchConfig

setPatchConfig

Patch configuration being applied. If omitted, instances are patched using the default configurations.

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

getDuration

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

Returns
TypeDescription
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

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

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

getDryRun

If this patch is a dry-run only, instances are contacted but will do nothing.

Returns
TypeDescription
bool

setDryRun

If this patch is a dry-run only, instances are contacted but will do nothing.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDisplayName

Display name for this patch job. This does not have to be unique.

Returns
TypeDescription
string

setDisplayName

Display name for this patch job. This does not have to be unique.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRollout

Rollout strategy of the patch job.

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

hasRollout

clearRollout

setRollout

Rollout strategy of the patch job.

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