Package types (1.9.0)

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.

CVSSv3

Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification- document

CancelPatchJobRequest

Message for canceling a patch job.

CreateOSPolicyAssignmentRequest

A request message to create an OS policy assignment

CreatePatchDeploymentRequest

A request message for creating a patch deployment.

DeleteOSPolicyAssignmentRequest

A request message for deleting a OS policy assignment.

DeletePatchDeploymentRequest

A request message for deleting a patch deployment.

ExecStep

A step that runs an executable for a PatchJob.

ExecStepConfig

Common configurations for an ExecStep.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GcsObject

Cloud Storage object representation.

GetInventoryRequest

A request message for getting inventory data for the specified VM.

GetOSPolicyAssignmentReportRequest

Get a report of the OS policy assignment for a VM instance.

GetOSPolicyAssignmentRequest

A request message to get an OS policy assignment

GetPatchDeploymentRequest

A request message for retrieving a patch deployment.

GetPatchJobRequest

Request to get an active or completed patch job.

GetVulnerabilityReportRequest

A request message for getting the vulnerability report for the specified VM.

GooSettings

Googet patching is performed by running googet update.

Instance

Namespace for instance state enums.

Inventory

This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time.

You can use this API resource to determine the inventory data of your VM.

For more information, see Information provided by OS inventory management <https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected>__.

InventoryView

The view for inventory objects.

ListInventoriesRequest

A request message for listing inventory data for all VMs in the specified location.

ListInventoriesResponse

A response message for listing inventory data for all VMs in a specified location.

ListOSPolicyAssignmentReportsRequest

List the OS policy assignment reports for VM instances.

ListOSPolicyAssignmentReportsResponse

A response message for listing OS Policy assignment reports including the page of results and page token.

ListOSPolicyAssignmentRevisionsRequest

A request message to list revisions for a OS policy assignment

ListOSPolicyAssignmentRevisionsResponse

A response message for listing all revisions for a OS policy assignment.

ListOSPolicyAssignmentsRequest

A request message to list OS policy assignments for a parent resource

ListOSPolicyAssignmentsResponse

A response message for listing all assignments under given parent.

ListPatchDeploymentsRequest

A request message for listing patch deployments.

ListPatchDeploymentsResponse

A response message for listing patch deployments.

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.

ListPatchJobsResponse

A response message for listing patch jobs.

ListVulnerabilityReportsRequest

A request message for listing vulnerability reports for all VM instances in the specified location.

ListVulnerabilityReportsResponse

A response message for listing vulnerability reports for all VM instances in the specified location.

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".

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OSPolicy

An OS policy defines the desired state configuration for a VM.

OSPolicyAssignment

OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see OS policy and OS policy assignment <https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies>__.

OSPolicyAssignmentOperationMetadata

OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

OSPolicyAssignmentReport

A report of the OS policy assignment status for a given instance.

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>__.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateOSPolicyAssignmentRequest

A request message to update an OS policy assignment

VulnerabilityReport

This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time.

For more information, see Vulnerability reports <https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports>__.

WeekDayOfMonth

Represents one week day in a month. An example is "the 4th Sunday".

WeeklySchedule

Represents a weekly schedule.

WindowsUpdateSettings

Windows patching is performed using the Windows Update Agent.

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.