API documentation for osconfig_v1.types package.
Classes
AptSettings
Apt patching is completed by executing
apt-get update && apt-get upgrade. Additional options can be set
to control how this is executed.
CancelPatchJobRequest
Message for canceling a patch job. .. attribute:: name
Required. Name of the patch in the form
projects/*/patchJobs/*
:type: str
CreatePatchDeploymentRequest
A request message for creating a patch deployment. .. attribute:: parent
Required. The project to apply this patch deployment to in
the form projects/*.
:type: str
DeletePatchDeploymentRequest
A request message for deleting a patch deployment. .. attribute:: name
Required. The resource name of the patch deployment in the
form projects/*/patchDeployments/*.
:type: str
ExecStep
A step that runs an executable for a PatchJob. .. attribute:: linux_exec_step_config
The ExecStepConfig for all Linux VMs targeted by the PatchJob.
ExecStepConfig
Common configurations for an ExecStep. .. attribute:: local_path
An absolute path to the executable on the VM.
:type: str
ExecutePatchJobRequest
A request message to initiate patching across Compute Engine instances.
FixedOrPercent
Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
GcsObject
Cloud Storage object representation. .. attribute:: bucket
Required. Bucket of the Cloud Storage object.
:type: str
GetPatchDeploymentRequest
A request message for retrieving a patch deployment. .. attribute:: name
Required. The resource name of the patch deployment in the
form projects/*/patchDeployments/*.
:type: str
GetPatchJobRequest
Request to get an active or completed patch job. .. attribute:: name
Required. Name of the patch in the form
projects/*/patchJobs/*
:type: str
GooSettings
Googet patching is performed by running googet update.
Instance
Namespace for instance state enums.
Inventory
The inventory details of a VM. .. attribute:: os_info
Base level operating system information for the VM.
ListPatchDeploymentsRequest
A request message for listing patch deployments. .. attribute:: parent
Required. The resource name of the parent in the form
projects/*.
:type: str
ListPatchDeploymentsResponse
A response message for listing patch deployments. .. attribute:: patch_deployments
The list of patch deployments.
:type: Sequence[google.cloud.osconfig_v1.types.PatchDeployment]
ListPatchJobInstanceDetailsRequest
Request to list details for all instances that are part of a patch job.
ListPatchJobInstanceDetailsResponse
A response message for listing the instances details for a patch job.
ListPatchJobsRequest
A request message for listing patch jobs. .. attribute:: parent
Required. In the form of projects/*
:type: str
ListPatchJobsResponse
A response message for listing patch jobs. .. attribute:: patch_jobs
The list of patch jobs.
:type: Sequence[google.cloud.osconfig_v1.types.PatchJob]
MonthlySchedule
Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".
OneTimeSchedule
Sets the time for a one time patch deployment. Timestamp is in
RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.
PatchConfig
Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.
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 <https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs>__.
PatchInstanceFilter
A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.
PatchJob
A high level representation of a patch job that is either in progress or has completed.
Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails.
For more information about patch jobs, see Creating patch
jobs <https://cloud.google.com/compute/docs/os-patch-management/create-patch-job>__.
PatchJobInstanceDetails
Patch details for a VM instance. For more information about
reviewing VM instance details, see Listing all VM instance details
for a specific patch
job <https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details>__.
PatchRollout
Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.
RecurringSchedule
Sets the time for recurring patch deployments. .. attribute:: time_zone
Required. Defines the time zone that time_of_day is
relative to. The rules for daylight saving time are
determined by the chosen time zone.
:type: google.type.datetime_pb2.TimeZone
WeekDayOfMonth
Represents one week day in a month. An example is "the 4th Sunday".
WeeklySchedule
Represents a weekly schedule. .. attribute:: day_of_week
Required. Day of the week.
:type: google.type.dayofweek_pb2.DayOfWeek
WindowsUpdateSettings
Windows patching is performed using the Windows Update Agent. .. attribute:: classifications
Only apply updates of these windows update classifications. If empty, all updates are applied.
:type: Sequence[google.cloud.osconfig_v1.types.WindowsUpdateSettings.Classification]
YumSettings
Yum patching is performed by executing yum update. Additional
options can be set to control how this is executed.
Note that not all settings are supported on all platforms.
ZypperSettings
Zypper patching is performed by running zypper patch. See also
https://en.opensuse.org/SDB:Zypper_manual.