- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.3
- 2.3.2
A client to OS Config API
The interfaces provided are listed below, along with usage samples.
OsConfigZonalServiceClient
Service Description: Zonal OS Config API
The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.
Sample for OsConfigZonalServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (OsConfigZonalServiceClient osConfigZonalServiceClient =
OsConfigZonalServiceClient.create()) {
OSPolicyAssignmentName name =
OSPolicyAssignmentName.of("[PROJECT]", "[LOCATION]", "[OS_POLICY_ASSIGNMENT]");
OSPolicyAssignment response = osConfigZonalServiceClient.getOSPolicyAssignment(name);
}
Classes
CVSSv3
Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document
Protobuf type google.cloud.osconfig.v1alpha.CVSSv3
CVSSv3.Builder
Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document
Protobuf type google.cloud.osconfig.v1alpha.CVSSv3
Common
ConfigCommonProto
CreateOSPolicyAssignmentRequest
A request message to create an OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.CreateOSPolicyAssignmentRequest
CreateOSPolicyAssignmentRequest.Builder
A request message to create an OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.CreateOSPolicyAssignmentRequest
DeleteOSPolicyAssignmentRequest
A request message for deleting a OS policy assignment.
Protobuf type google.cloud.osconfig.v1alpha.DeleteOSPolicyAssignmentRequest
DeleteOSPolicyAssignmentRequest.Builder
A request message for deleting a OS policy assignment.
Protobuf type google.cloud.osconfig.v1alpha.DeleteOSPolicyAssignmentRequest
FixedOrPercent
Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
Protobuf type google.cloud.osconfig.v1alpha.FixedOrPercent
FixedOrPercent.Builder
Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
Protobuf type google.cloud.osconfig.v1alpha.FixedOrPercent
GetInstanceOSPoliciesComplianceRequest
A request message for getting OS policies compliance data for the given Compute Engine VM instance.
Protobuf type google.cloud.osconfig.v1alpha.GetInstanceOSPoliciesComplianceRequest
GetInstanceOSPoliciesComplianceRequest.Builder
A request message for getting OS policies compliance data for the given Compute Engine VM instance.
Protobuf type google.cloud.osconfig.v1alpha.GetInstanceOSPoliciesComplianceRequest
GetInventoryRequest
A request message for getting inventory data for the specified VM.
Protobuf type google.cloud.osconfig.v1alpha.GetInventoryRequest
GetInventoryRequest.Builder
A request message for getting inventory data for the specified VM.
Protobuf type google.cloud.osconfig.v1alpha.GetInventoryRequest
GetOSPolicyAssignmentReportRequest
Get a report of the OS policy assignment for a VM instance.
Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentReportRequest
GetOSPolicyAssignmentReportRequest.Builder
Get a report of the OS policy assignment for a VM instance.
Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentReportRequest
GetOSPolicyAssignmentRequest
A request message to get an OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentRequest
GetOSPolicyAssignmentRequest.Builder
A request message to get an OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentRequest
GetVulnerabilityReportRequest
A request message for getting the vulnerability report for the specified VM.
Protobuf type google.cloud.osconfig.v1alpha.GetVulnerabilityReportRequest
GetVulnerabilityReportRequest.Builder
A request message for getting the vulnerability report for the specified VM.
Protobuf type google.cloud.osconfig.v1alpha.GetVulnerabilityReportRequest
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}.
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.
Protobuf type google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance
InstanceOSPoliciesCompliance.Builder
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.
Protobuf type google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance
InstanceOSPoliciesCompliance.OSPolicyCompliance
Compliance data for an OS policy
Protobuf type
google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance
InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder
Compliance data for an OS policy
Protobuf type
google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance
InstanceOSPoliciesComplianceName
InstanceOSPoliciesComplianceName.Builder
Builder for projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.
InstanceOSPoliciesComplianceProto
InstanceOSPolicyAssignmentName
InstanceOSPolicyAssignmentName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}.
Inventories
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.
Protobuf type google.cloud.osconfig.v1alpha.Inventory
Inventory.Builder
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.
Protobuf type google.cloud.osconfig.v1alpha.Inventory
Inventory.Item
A single piece of inventory on a VM.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.Item
Inventory.Item.Builder
A single piece of inventory on a VM.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.Item
Inventory.OsInfo
Operating system information for the VM.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.OsInfo
Inventory.OsInfo.Builder
Operating system information for the VM.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.OsInfo
Inventory.SoftwarePackage
Software package information of the operating system.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.SoftwarePackage
Inventory.SoftwarePackage.Builder
Software package information of the operating system.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.SoftwarePackage
Inventory.VersionedPackage
Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.VersionedPackage
Inventory.VersionedPackage.Builder
Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.VersionedPackage
Inventory.WindowsApplication
Contains information about a Windows application that is retrieved from the Windows Registry. For more information about these fields, see: https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key
Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsApplication
Inventory.WindowsApplication.Builder
Contains information about a Windows application that is retrieved from the Windows Registry. For more information about these fields, see: https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key
Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsApplication
Inventory.WindowsQuickFixEngineeringPackage
Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering
Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsQuickFixEngineeringPackage
Inventory.WindowsQuickFixEngineeringPackage.Builder
Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering
Protobuf type
google.cloud.osconfig.v1alpha.Inventory.WindowsQuickFixEngineeringPackage
Inventory.WindowsUpdatePackage
Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage
Inventory.WindowsUpdatePackage.Builder
Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage
Inventory.WindowsUpdatePackage.WindowsUpdateCategory
Categories specified by the Windows Update.
Protobuf type
google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage.WindowsUpdateCategory
Inventory.WindowsUpdatePackage.WindowsUpdateCategory.Builder
Categories specified by the Windows Update.
Protobuf type
google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage.WindowsUpdateCategory
Inventory.ZypperPatch
Details related to a Zypper Patch.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.ZypperPatch
Inventory.ZypperPatch.Builder
Details related to a Zypper Patch.
Protobuf type google.cloud.osconfig.v1alpha.Inventory.ZypperPatch
InventoryName
InventoryName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}/inventory.
ListInstanceOSPoliciesCompliancesRequest
A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.
Protobuf type google.cloud.osconfig.v1alpha.ListInstanceOSPoliciesCompliancesRequest
ListInstanceOSPoliciesCompliancesRequest.Builder
A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.
Protobuf type google.cloud.osconfig.v1alpha.ListInstanceOSPoliciesCompliancesRequest
ListInstanceOSPoliciesCompliancesResponse
A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.
Protobuf type google.cloud.osconfig.v1alpha.ListInstanceOSPoliciesCompliancesResponse
ListInstanceOSPoliciesCompliancesResponse.Builder
A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.
Protobuf type google.cloud.osconfig.v1alpha.ListInstanceOSPoliciesCompliancesResponse
ListInventoriesRequest
A request message for listing inventory data for all VMs in the specified location.
Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesRequest
ListInventoriesRequest.Builder
A request message for listing inventory data for all VMs in the specified location.
Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesRequest
ListInventoriesResponse
A response message for listing inventory data for all VMs in a specified location.
Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesResponse
ListInventoriesResponse.Builder
A response message for listing inventory data for all VMs in a specified location.
Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesResponse
ListOSPolicyAssignmentReportsRequest
List the OS policy assignment reports for VM instances.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsRequest
ListOSPolicyAssignmentReportsRequest.Builder
List the OS policy assignment reports for VM instances.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsRequest
ListOSPolicyAssignmentReportsResponse
A response message for listing OS Policy assignment reports including the page of results and page token.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsResponse
ListOSPolicyAssignmentReportsResponse.Builder
A response message for listing OS Policy assignment reports including the page of results and page token.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsResponse
ListOSPolicyAssignmentRevisionsRequest
A request message to list revisions for a OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsRequest
ListOSPolicyAssignmentRevisionsRequest.Builder
A request message to list revisions for a OS policy assignment
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsRequest
ListOSPolicyAssignmentRevisionsResponse
A response message for listing all revisions for a OS policy assignment.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsResponse
ListOSPolicyAssignmentRevisionsResponse.Builder
A response message for listing all revisions for a OS policy assignment.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsResponse
ListOSPolicyAssignmentsRequest
A request message to list OS policy assignments for a parent resource
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsRequest
ListOSPolicyAssignmentsRequest.Builder
A request message to list OS policy assignments for a parent resource
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsRequest
ListOSPolicyAssignmentsResponse
A response message for listing all assignments under given parent.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsResponse
ListOSPolicyAssignmentsResponse.Builder
A response message for listing all assignments under given parent.
Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsResponse