osconfig.v1 library Null safety

OS Config API - v1

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

For more information, see cloud.google.com/compute/docs/osconfig/rest

Create an instance of OSConfigApi to access these resources:

Classes

AptSettings
Apt patching is completed by executing apt-get update && apt-get upgrade. [...]
CVSSv3
Common Vulnerability Scoring System version 3. [...]
ExecStep
A step that runs an executable for a PatchJob.
ExecStepConfig
Common configurations for an ExecStep.
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.
Inventory
This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. [...]
InventoryItem
A single piece of inventory on a VM.
InventorySoftwarePackage
Software package information of the operating system.
InventoryWindowsApplication
Contains information about a Windows application that is retrieved from the Windows Registry. [...]
InventoryWindowsUpdatePackage
Details related to a Windows Update package. [...]
ListInventoriesResponse
A response message for listing inventory data for all VMs in a specified location.
ListOSPolicyAssignmentReportsResponse
A response message for listing OS Policy assignment reports including the page of results and page token.
ListOSPolicyAssignmentRevisionsResponse
A response message for listing all revisions for a OS policy assignment.
ListOSPolicyAssignmentsResponse
A response message for listing all assignments under given parent.
ListPatchDeploymentsResponse
A response message for listing patch deployments.
ListPatchJobInstanceDetailsResponse
A response message for listing the instances details for a patch job.
ListPatchJobsResponse
A response message for listing patch jobs.
ListVulnerabilityReportsResponse
A response message for listing vulnerability reports for all VM instances in the specified location.
MonthlySchedule
Represents a monthly schedule. [...]
OneTimeSchedule
Sets the time for a one time patch deployment. [...]
Operation
This resource represents a long-running operation that is the result of a network API call.
OSConfigApi
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
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. [...]
OSPolicyAssignmentInstanceFilter
Filters to select target VMs for an assignment. [...]
OSPolicyAssignmentLabelSet
Message representing label set. [...]
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.
OSPolicyAssignmentReportOSPolicyCompliance
Compliance data for an OS policy
OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance
Compliance data for an OS policy resource.
OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput
ExecResource specific output.
OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep
Step performed by the OS Config agent for configuring an OSPolicy resource to its desired state.
OSPolicyAssignmentRollout
Message to configure the rollout at the zonal level for the OS policy assignment.
OSPolicyResource
An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. [...]
OSPolicyResourceExecResource
A resource that allows executing scripts on the VM. [...]
OSPolicyResourceExecResourceExec
A file or script to execute.
OSPolicyResourceFile
A remote or local file.
OSPolicyResourceFileGcs
Specifies a file available as a Cloud Storage Object.
OSPolicyResourceFileRemote
Specifies a file available via some URI.
OSPolicyResourceFileResource
A resource that manages the state of a file.
OSPolicyResourceGroup
Resource groups provide a mechanism to group OS policy resources. [...]
OSPolicyResourcePackageResource
A resource that manages a system package.
OSPolicyResourcePackageResourceDeb
A deb package file. [...]
OSPolicyResourcePackageResourceMSI
An MSI package. [...]
OSPolicyResourcePackageResourceRPM
An RPM package file. [...]
OSPolicyResourceRepositoryResource
A resource that manages a package repository.
OSPolicyResourceRepositoryResourceAptRepository
Represents a single apt package repository. [...]
OSPolicyResourceRepositoryResourceGooRepository
Represents a Goo package repository. [...]
OSPolicyResourceRepositoryResourceYumRepository
Represents a single yum package repository. [...]
OSPolicyResourceRepositoryResourceZypperRepository
Represents a single zypper package repository. [...]
PatchConfig
Patch configuration specifications. [...]
PatchDeployment
Patch deployments are configurations that individual patch jobs use to complete a patch. [...]
PatchInstanceFilter
A filter to target VM instances for patching. [...]
PatchInstanceFilterGroupLabel
Targets a group of VM instances by using their assigned labels. [...]
PatchJob
A high level representation of a patch job that is either in progress or has completed. [...]
PatchJobInstanceDetails
Patch details for a VM instance. [...]
PatchJobInstanceDetailsSummary
A summary of the current patch state across all instances that this patch job affects. [...]
PatchRollout
Patch rollout configuration specifications. [...]
ProjectsLocationsInstancesInventoriesResource
ProjectsLocationsInstancesOsPolicyAssignmentsReportsResource
ProjectsLocationsInstancesOsPolicyAssignmentsResource
ProjectsLocationsInstancesResource
ProjectsLocationsInstancesVulnerabilityReportsResource
ProjectsLocationsOsPolicyAssignmentsOperationsResource
ProjectsLocationsOsPolicyAssignmentsResource
ProjectsLocationsResource
ProjectsPatchDeploymentsResource
ProjectsPatchJobsInstanceDetailsResource
ProjectsPatchJobsResource
ProjectsResource
RecurringSchedule
Sets the time for recurring patch deployments.
VulnerabilityReport
This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. [...]
VulnerabilityReportVulnerability
A vulnerability affecting the VM instance.
VulnerabilityReportVulnerabilityDetails
Contains metadata information for the vulnerability. [...]
VulnerabilityReportVulnerabilityDetailsReference
A reference for this vulnerability.
WeekDayOfMonth
Represents one week day in a month. [...]
WeeklySchedule
Represents a weekly schedule.
WindowsUpdateSettings
Windows patching is performed using the Windows Update Agent.
YumSettings
Yum patching is performed by executing yum update. [...]
ZypperSettings
Zypper patching is performed by running zypper patch. [...]

Typedefs

CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
CancelPatchJobRequest = $Empty
Message for canceling a patch job.
Date = $Date
Represents a whole or partial calendar date, such as a birthday. [...]
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GooSettings = $Empty
Googet patching is performed by running googet update.
InventoryOsInfo = $OsInfo
Operating system information for the VM.
InventoryVersionedPackage = $VersionedPackage
Information related to the a standard versioned package. [...]
InventoryWindowsQuickFixEngineeringPackage = $WindowsQuickFixEngineeringPackage
Information related to a Quick Fix Engineering package. [...]
InventoryWindowsUpdatePackageWindowsUpdateCategory = $WindowsUpdateCategory
Categories specified by the Windows Update.
InventoryZypperPatch = $ZypperPatch
Details related to a Zypper Patch.
OSPolicyAssignmentInstanceFilterInventory = $Shared10
VM inventory details.
OSPolicyInventoryFilter = $Shared10
Filtering criteria to select VMs based on inventory details.
OSPolicyResourcePackageResourceAPT = $Shared02
A package managed by APT. [...]
OSPolicyResourcePackageResourceGooGet = $Shared02
A package managed by GooGet. [...]
OSPolicyResourcePackageResourceYUM = $Shared02
A package managed by YUM. [...]
OSPolicyResourcePackageResourceZypper = $Shared02
A package managed by Zypper. [...]
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
TimeOfDay = $TimeOfDay
Represents a time of day. [...]
TimeZone = $TimeZone
Represents a time zone from the IANA Time Zone Database.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.