Reference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
Returns
- (::String) — Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
#duration
def duration() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Optional. Duration of the patch. After the duration ends, the patch times out.
#duration=
def duration=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Optional. Duration of the patch. After the duration ends, the patch times out.
Returns
- (::Google::Protobuf::Duration) — Optional. Duration of the patch. After the duration ends, the patch times out.
#instance_filter
def instance_filter() -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Returns
- (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. VM instances to patch.
#instance_filter=
def instance_filter=(value) -> ::Google::Cloud::OsConfig::V1::PatchInstanceFilter
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. VM instances to patch.
Returns
- (::Google::Cloud::OsConfig::V1::PatchInstanceFilter) — Required. VM instances to patch.
#last_execute_time
def last_execute_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format.
#name
def name() -> ::String
Returns
-
(::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.
#name=
def name=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#one_time_schedule
def one_time_schedule() -> ::Google::Cloud::OsConfig::V1::OneTimeSchedule
Returns
- (::Google::Cloud::OsConfig::V1::OneTimeSchedule) — Required. Schedule a one-time execution.
#one_time_schedule=
def one_time_schedule=(value) -> ::Google::Cloud::OsConfig::V1::OneTimeSchedule
Parameter
- value (::Google::Cloud::OsConfig::V1::OneTimeSchedule) — Required. Schedule a one-time execution.
Returns
- (::Google::Cloud::OsConfig::V1::OneTimeSchedule) — Required. Schedule a one-time execution.
#patch_config
def patch_config() -> ::Google::Cloud::OsConfig::V1::PatchConfig
Returns
- (::Google::Cloud::OsConfig::V1::PatchConfig) — Optional. Patch configuration that is applied.
#patch_config=
def patch_config=(value) -> ::Google::Cloud::OsConfig::V1::PatchConfig
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchConfig) — Optional. Patch configuration that is applied.
Returns
- (::Google::Cloud::OsConfig::V1::PatchConfig) — Optional. Patch configuration that is applied.
#recurring_schedule
def recurring_schedule() -> ::Google::Cloud::OsConfig::V1::RecurringSchedule
Returns
- (::Google::Cloud::OsConfig::V1::RecurringSchedule) — Required. Schedule recurring executions.
#recurring_schedule=
def recurring_schedule=(value) -> ::Google::Cloud::OsConfig::V1::RecurringSchedule
Parameter
- value (::Google::Cloud::OsConfig::V1::RecurringSchedule) — Required. Schedule recurring executions.
Returns
- (::Google::Cloud::OsConfig::V1::RecurringSchedule) — Required. Schedule recurring executions.
#rollout
def rollout() -> ::Google::Cloud::OsConfig::V1::PatchRollout
Returns
- (::Google::Cloud::OsConfig::V1::PatchRollout) — Optional. Rollout strategy of the patch job.
#rollout=
def rollout=(value) -> ::Google::Cloud::OsConfig::V1::PatchRollout
Parameter
- value (::Google::Cloud::OsConfig::V1::PatchRollout) — Optional. Rollout strategy of the patch job.
Returns
- (::Google::Cloud::OsConfig::V1::PatchRollout) — Optional. Rollout strategy of the patch job.
#state
def state() -> ::Google::Cloud::OsConfig::V1::PatchDeployment::State
Returns
- (::Google::Cloud::OsConfig::V1::PatchDeployment::State) — Output only. Current state of the patch deployment.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.