Reference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::ExecutePatchJobRequest.
A request message to initiate patching across Compute Engine instances.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
Returns
- (::String) — Description of the patch job. Length of the description is limited to 1024 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Description of the patch job. Length of the description is limited to 1024 characters.
Returns
- (::String) — Description of the patch job. Length of the description is limited to 1024 characters.
#display_name
def display_name() -> ::String
Returns
- (::String) — Display name for this patch job. This does not have to be unique.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Display name for this patch job. This does not have to be unique.
Returns
- (::String) — Display name for this patch job. This does not have to be unique.
#dry_run
def dry_run() -> ::Boolean
Returns
- (::Boolean) — If this patch is a dry-run only, instances are contacted but will do nothing.
#dry_run=
def dry_run=(value) -> ::Boolean
Parameter
- value (::Boolean) — If this patch is a dry-run only, instances are contacted but will do nothing.
Returns
- (::Boolean) — If this patch is a dry-run only, instances are contacted but will do nothing.
#duration
def duration() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Duration of the patch job. After the duration ends, the patch job times out.
#duration=
def duration=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Duration of the patch job. After the duration ends, the patch job times out.
Returns
- (::Google::Protobuf::Duration) — Duration of the patch job. After the duration ends, the patch job times out.
#instance_filter
def instance_filter() -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Returns
- (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
#instance_filter=
def instance_filter=(value) -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
Returns
- (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The project in which to run this patch in the form
projects/*
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required. The project in which to run this patch in the form
projects/*
Returns
-
(::String) — Required. The project in which to run this patch in the form
projects/*
#patch_config
def patch_config() -> ::Google::Cloud::OsConfig::V1::PatchConfig
Returns
- (::Google::Cloud::OsConfig::V1::PatchConfig) — Patch configuration being applied. If omitted, instances are patched using the default configurations.
#patch_config=
def patch_config=(value) -> ::Google::Cloud::OsConfig::V1::PatchConfig
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchConfig) — Patch configuration being applied. If omitted, instances are patched using the default configurations.
Returns
- (::Google::Cloud::OsConfig::V1::PatchConfig) — Patch configuration being applied. If omitted, instances are patched using the default configurations.
#rollout
def rollout() -> ::Google::Cloud::OsConfig::V1::PatchRollout
Returns
- (::Google::Cloud::OsConfig::V1::PatchRollout) — Rollout strategy of the patch job.
#rollout=
def rollout=(value) -> ::Google::Cloud::OsConfig::V1::PatchRollout
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchRollout) — Rollout strategy of the patch job.
Returns
- (::Google::Cloud::OsConfig::V1::PatchRollout) — Rollout strategy of the patch job.