Package types (1.16.0rc0)

API documentation for osconfig_v1alpha.types package.

Classes

CVSSv3

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

CreateOSPolicyAssignmentRequest

A request message to create an OS policy assignment

DeleteOSPolicyAssignmentRequest

A request message for deleting a OS policy assignment.

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

GetInstanceOSPoliciesComplianceRequest

A request message for getting OS policies compliance data for the given Compute Engine VM instance.

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

GetVulnerabilityReportRequest

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

InstanceOSPoliciesCompliance

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

A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM.

You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy.

For more information, see View compliance <https://cloud.google.com/compute/docs/os-configuration-management/view-compliance>__.

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.

Values: INVENTORY_VIEW_UNSPECIFIED (0): The default value. The API defaults to the BASIC view. BASIC (1): Returns the basic inventory information that includes os_info. FULL (2): Returns all fields.

ListInstanceOSPoliciesCompliancesRequest

A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.

ListInstanceOSPoliciesCompliancesResponse

A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.

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.

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.

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.

OSPolicyComplianceState

Supported OSPolicy compliance states.

Values: OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED (0): Default value. This value is unused. COMPLIANT (1): Compliant state. NON_COMPLIANT (2): Non-compliant state UNKNOWN (3): Unknown compliance state. NO_OS_POLICIES_APPLICABLE (4): No applicable OS policies were found for the instance. This state is only applicable to the instance.