Package com.google.cloud.osconfig.v1alpha (2.3.2)

Version 2.3.2

• 2.55.0 (latest)
• 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

Alpha

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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:

 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

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

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 as retrieved from the Windows Registry. For more information about these fields, see Windows Installer Properties for the Uninstall Registry{: class="external" }

Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsApplication

Inventory.WindowsApplication.Builder

Contains information about a Windows application as retrieved from the Windows Registry. For more information about these fields, see Windows Installer Properties for the Uninstall Registry{: class="external" }

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

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

ListVulnerabilityReportsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsRequest

ListVulnerabilityReportsRequest.Builder

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsRequest

ListVulnerabilityReportsResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsResponse

ListVulnerabilityReportsResponse.Builder

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OSPolicy

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy

OSPolicy.Builder

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy

OSPolicy.OSFilter

The OSFilter is used to specify the OS filtering criteria for the resource group.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.OSFilter

OSPolicy.OSFilter.Builder

The OSFilter is used to specify the OS filtering criteria for the resource group.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.OSFilter

OSPolicy.Resource

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. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource

OSPolicy.Resource.Builder

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. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource

OSPolicy.Resource.ExecResource

A resource that allows executing scripts on the VM. The ExecResource has 2 stages: validate and enforce and both stages accept a script as an argument to execute. When the ExecResource is applied by the agent, it first executes the script in the validate stage. The validate stage can signal that the ExecResource is already in the desired state by returning an exit code of 100. If the ExecResource is not in the desired state, it should return an exit code of 101. Any other exit code returned by this stage is considered an error. If the ExecResource is not in the desired state based on the exit code from the validate stage, the agent proceeds to execute the script from the enforce stage. If the ExecResource is already in the desired state, the enforce stage will not be run. Similar to validate stage, the enforce stage should return an exit code of 100 to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to have an explicit indicator of in desired state, not in desired state and errors. Because, for example, Powershell will always return an exit code of 0 unless an exit statement is provided in the script. So, for reasons of consistency and being explicit, exit codes 100 and 101 were chosen.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource

OSPolicy.Resource.ExecResource.Builder

A resource that allows executing scripts on the VM. The ExecResource has 2 stages: validate and enforce and both stages accept a script as an argument to execute. When the ExecResource is applied by the agent, it first executes the script in the validate stage. The validate stage can signal that the ExecResource is already in the desired state by returning an exit code of 100. If the ExecResource is not in the desired state, it should return an exit code of 101. Any other exit code returned by this stage is considered an error. If the ExecResource is not in the desired state based on the exit code from the validate stage, the agent proceeds to execute the script from the enforce stage. If the ExecResource is already in the desired state, the enforce stage will not be run. Similar to validate stage, the enforce stage should return an exit code of 100 to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to have an explicit indicator of in desired state, not in desired state and errors. Because, for example, Powershell will always return an exit code of 0 unless an exit statement is provided in the script. So, for reasons of consistency and being explicit, exit codes 100 and 101 were chosen.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource

OSPolicy.Resource.ExecResource.Exec

A file or script to execute.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec

OSPolicy.Resource.ExecResource.Exec.Builder

A file or script to execute.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec

OSPolicy.Resource.File

A remote or local file.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File

OSPolicy.Resource.File.Builder

A remote or local file.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File

OSPolicy.Resource.File.Gcs

Specifies a file available as a Cloud Storage Object.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File.Gcs

OSPolicy.Resource.File.Gcs.Builder

Specifies a file available as a Cloud Storage Object.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File.Gcs

OSPolicy.Resource.File.Remote

Specifies a file available via some URI.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File.Remote

OSPolicy.Resource.File.Remote.Builder

Specifies a file available via some URI.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.File.Remote

OSPolicy.Resource.FileResource

A resource that manages the state of a file.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource

OSPolicy.Resource.FileResource.Builder

A resource that manages the state of a file.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource

OSPolicy.Resource.PackageResource

A resource that manages a system package.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource

OSPolicy.Resource.PackageResource.APT

A package managed by APT.

• install: apt-get update && apt-get -y install [name]
• remove: apt-get -y remove [name]

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.APT

OSPolicy.Resource.PackageResource.APT.Builder

A package managed by APT.

• install: apt-get update && apt-get -y install [name]
• remove: apt-get -y remove [name]

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.APT

OSPolicy.Resource.PackageResource.Builder

A resource that manages a system package.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource

OSPolicy.Resource.PackageResource.Deb

A deb package file. dpkg packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.Deb

OSPolicy.Resource.PackageResource.Deb.Builder

A deb package file. dpkg packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.Deb

OSPolicy.Resource.PackageResource.GooGet

A package managed by GooGet.

• install: googet -noconfirm install package
• remove: googet -noconfirm remove package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.GooGet

OSPolicy.Resource.PackageResource.GooGet.Builder

A package managed by GooGet.

• install: googet -noconfirm install package
• remove: googet -noconfirm remove package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.GooGet

OSPolicy.Resource.PackageResource.MSI

An MSI package. MSI packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.MSI

OSPolicy.Resource.PackageResource.MSI.Builder

An MSI package. MSI packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.MSI

OSPolicy.Resource.PackageResource.RPM

An RPM package file. RPM packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.RPM

OSPolicy.Resource.PackageResource.RPM.Builder

An RPM package file. RPM packages only support INSTALLED state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.RPM

OSPolicy.Resource.PackageResource.YUM

A package managed by YUM.

• install: yum -y install package
• remove: yum -y remove package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.YUM

OSPolicy.Resource.PackageResource.YUM.Builder

A package managed by YUM.

• install: yum -y install package
• remove: yum -y remove package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.YUM

OSPolicy.Resource.PackageResource.Zypper

A package managed by Zypper.

• install: zypper -y install package
• remove: zypper -y rm package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.Zypper

OSPolicy.Resource.PackageResource.Zypper.Builder

A package managed by Zypper.

• install: zypper -y install package
• remove: zypper -y rm package

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.Zypper

OSPolicy.Resource.RepositoryResource

A resource that manages a package repository.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource

OSPolicy.Resource.RepositoryResource.AptRepository

Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.AptRepository

OSPolicy.Resource.RepositoryResource.AptRepository.Builder

Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.AptRepository

OSPolicy.Resource.RepositoryResource.Builder

A resource that manages a package repository.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource

OSPolicy.Resource.RepositoryResource.GooRepository

Represents a Goo package repository. These are added to a repo file that is managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.GooRepository

OSPolicy.Resource.RepositoryResource.GooRepository.Builder

Represents a Goo package repository. These are added to a repo file that is managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.GooRepository

OSPolicy.Resource.RepositoryResource.YumRepository

Represents a single yum package repository. These are added to a repo file that is managed at /etc/yum.repos.d/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.YumRepository

OSPolicy.Resource.RepositoryResource.YumRepository.Builder

Represents a single yum package repository. These are added to a repo file that is managed at /etc/yum.repos.d/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.YumRepository

OSPolicy.Resource.RepositoryResource.ZypperRepository

Represents a single zypper package repository. These are added to a repo file that is managed at /etc/zypp/repos.d/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.ZypperRepository

OSPolicy.Resource.RepositoryResource.ZypperRepository.Builder

Represents a single zypper package repository. These are added to a repo file that is managed at /etc/zypp/repos.d/google_osconfig.repo.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.ZypperRepository

OSPolicy.ResourceGroup

Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the OSFilter specified within the resource group.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup

OSPolicy.ResourceGroup.Builder

Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the OSFilter specified within the resource group.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup

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.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment

OSPolicyAssignment.Builder

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.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment

OSPolicyAssignment.InstanceFilter

Message to represent the filters to select VMs for an assignment

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.InstanceFilter

OSPolicyAssignment.InstanceFilter.Builder

Message to represent the filters to select VMs for an assignment

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.InstanceFilter

OSPolicyAssignment.LabelSet

Message representing label set.

• A label is a key value pair set for a VM.
• A LabelSet is a set of labels.
• Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet.
• Example: A LabelSet with 2 labels: env=prod and type=webserver will only be applicable for those VMs with both labels present.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.LabelSet

OSPolicyAssignment.LabelSet.Builder

Message representing label set.

• A label is a key value pair set for a VM.
• A LabelSet is a set of labels.
• Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet.
• Example: A LabelSet with 2 labels: env=prod and type=webserver will only be applicable for those VMs with both labels present.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.LabelSet

OSPolicyAssignment.Rollout

Message to configure the rollout at the zonal level for the OS policy assignment.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.Rollout

OSPolicyAssignment.Rollout.Builder

Message to configure the rollout at the zonal level for the OS policy assignment.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignment.Rollout

OSPolicyAssignmentName

OSPolicyAssignmentName.Builder

Builder for projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

OSPolicyAssignmentOperationMetadata

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata

OSPolicyAssignmentOperationMetadata.Builder

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata

OSPolicyAssignments

OSPolicyProto

OSPolicyResourceCompliance

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance

OSPolicyResourceCompliance.Builder

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance

OSPolicyResourceCompliance.ExecResourceOutput

ExecResource specific output.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance.ExecResourceOutput

OSPolicyResourceCompliance.ExecResourceOutput.Builder

ExecResource specific output.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance.ExecResourceOutput

OSPolicyResourceConfigStep

Step performed by the OS Config agent for configuring an OSPolicyResource to its desired state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep.Builder

Step performed by the OS Config agent for configuring an OSPolicyResource to its desired state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create()) {
   OSPolicyAssignmentName name =
       OSPolicyAssignmentName.of("[PROJECT]", "[LOCATION]", "[OS_POLICY_ASSIGNMENT]");
   OSPolicyAssignment response = osConfigZonalServiceClient.getOSPolicyAssignment(name);
 }
 

Note: close() needs to be called on the OsConfigZonalServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of OsConfigZonalServiceSettings to create(). For example:

To customize credentials:

 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     OsConfigZonalServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create(osConfigZonalServiceSettings);
 

To customize the endpoint:

 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     OsConfigZonalServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create(osConfigZonalServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesFixedSizeCollection

OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPage

OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPagedResponse

OsConfigZonalServiceClient.ListInventoriesFixedSizeCollection

OsConfigZonalServiceClient.ListInventoriesPage

OsConfigZonalServiceClient.ListInventoriesPagedResponse

OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsFixedSizeCollection

OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPage

OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse

OsConfigZonalServiceClient.ListOSPolicyAssignmentsFixedSizeCollection

OsConfigZonalServiceClient.ListOSPolicyAssignmentsPage

OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse

OsConfigZonalServiceClient.ListVulnerabilityReportsFixedSizeCollection

OsConfigZonalServiceClient.ListVulnerabilityReportsPage

OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse

OsConfigZonalServiceGrpc

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.

OsConfigZonalServiceGrpc.OsConfigZonalServiceBlockingStub

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.

OsConfigZonalServiceGrpc.OsConfigZonalServiceFutureStub

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.

OsConfigZonalServiceGrpc.OsConfigZonalServiceImplBase

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.

OsConfigZonalServiceGrpc.OsConfigZonalServiceStub

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.

OsConfigZonalServiceProto

OsConfigZonalServiceSettings

Settings class to configure an instance of OsConfigZonalServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (osconfig.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getOSPolicyAssignment to 30 seconds:

 OsConfigZonalServiceSettings.Builder osConfigZonalServiceSettingsBuilder =
     OsConfigZonalServiceSettings.newBuilder();
 osConfigZonalServiceSettingsBuilder
     .getOSPolicyAssignmentSettings()
     .setRetrySettings(
         osConfigZonalServiceSettingsBuilder
             .getOSPolicyAssignmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     osConfigZonalServiceSettingsBuilder.build();
 

OsConfigZonalServiceSettings.Builder

Builder for OsConfigZonalServiceSettings.

UpdateOSPolicyAssignmentRequest

A request message to update an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.UpdateOSPolicyAssignmentRequest

UpdateOSPolicyAssignmentRequest.Builder

A request message to update an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.UpdateOSPolicyAssignmentRequest

VulnerabilityProto

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.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport

VulnerabilityReport.Builder

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.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport

VulnerabilityReport.Vulnerability

A vulnerability affecting the VM instance.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability

VulnerabilityReport.Vulnerability.Builder

A vulnerability affecting the VM instance.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability

VulnerabilityReport.Vulnerability.Details

Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability.Details

VulnerabilityReport.Vulnerability.Details.Builder

Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability.Details

VulnerabilityReport.Vulnerability.Details.Reference

A reference for this vulnerability.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability.Details.Reference

VulnerabilityReport.Vulnerability.Details.Reference.Builder

A reference for this vulnerability.

Protobuf type google.cloud.osconfig.v1alpha.VulnerabilityReport.Vulnerability.Details.Reference

VulnerabilityReportName

VulnerabilityReportName.Builder

Builder for projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

Interfaces

CVSSv3OrBuilder

CreateOSPolicyAssignmentRequestOrBuilder

DeleteOSPolicyAssignmentRequestOrBuilder

FixedOrPercentOrBuilder

GetInstanceOSPoliciesComplianceRequestOrBuilder

GetInventoryRequestOrBuilder

GetOSPolicyAssignmentRequestOrBuilder

GetVulnerabilityReportRequestOrBuilder

InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder

InstanceOSPoliciesComplianceOrBuilder

Inventory.ItemOrBuilder

Inventory.OsInfoOrBuilder

Inventory.SoftwarePackageOrBuilder

Inventory.VersionedPackageOrBuilder

Inventory.WindowsApplicationOrBuilder

Inventory.WindowsQuickFixEngineeringPackageOrBuilder

Inventory.WindowsUpdatePackage.WindowsUpdateCategoryOrBuilder

Inventory.WindowsUpdatePackageOrBuilder

Inventory.ZypperPatchOrBuilder

InventoryOrBuilder

ListInstanceOSPoliciesCompliancesRequestOrBuilder

ListInstanceOSPoliciesCompliancesResponseOrBuilder

ListInventoriesRequestOrBuilder

ListInventoriesResponseOrBuilder

ListOSPolicyAssignmentRevisionsRequestOrBuilder

ListOSPolicyAssignmentRevisionsResponseOrBuilder

ListOSPolicyAssignmentsRequestOrBuilder

ListOSPolicyAssignmentsResponseOrBuilder

ListVulnerabilityReportsRequestOrBuilder

ListVulnerabilityReportsResponseOrBuilder

OSPolicy.OSFilterOrBuilder

OSPolicy.Resource.ExecResource.ExecOrBuilder

OSPolicy.Resource.ExecResourceOrBuilder

OSPolicy.Resource.File.GcsOrBuilder

OSPolicy.Resource.File.RemoteOrBuilder

OSPolicy.Resource.FileOrBuilder

OSPolicy.Resource.FileResourceOrBuilder

OSPolicy.Resource.PackageResource.APTOrBuilder

OSPolicy.Resource.PackageResource.DebOrBuilder

OSPolicy.Resource.PackageResource.GooGetOrBuilder

OSPolicy.Resource.PackageResource.MSIOrBuilder

OSPolicy.Resource.PackageResource.RPMOrBuilder

OSPolicy.Resource.PackageResource.YUMOrBuilder

OSPolicy.Resource.PackageResource.ZypperOrBuilder

OSPolicy.Resource.PackageResourceOrBuilder

OSPolicy.Resource.RepositoryResource.AptRepositoryOrBuilder

OSPolicy.Resource.RepositoryResource.GooRepositoryOrBuilder

OSPolicy.Resource.RepositoryResource.YumRepositoryOrBuilder

OSPolicy.Resource.RepositoryResource.ZypperRepositoryOrBuilder

OSPolicy.Resource.RepositoryResourceOrBuilder

OSPolicy.ResourceGroupOrBuilder

OSPolicy.ResourceOrBuilder

OSPolicyAssignment.InstanceFilterOrBuilder

OSPolicyAssignment.LabelSetOrBuilder

OSPolicyAssignment.RolloutOrBuilder

OSPolicyAssignmentOperationMetadataOrBuilder

OSPolicyAssignmentOrBuilder

OSPolicyOrBuilder

OSPolicyResourceCompliance.ExecResourceOutputOrBuilder

OSPolicyResourceComplianceOrBuilder

OSPolicyResourceConfigStepOrBuilder

UpdateOSPolicyAssignmentRequestOrBuilder

VulnerabilityReport.Vulnerability.Details.ReferenceOrBuilder

VulnerabilityReport.Vulnerability.DetailsOrBuilder

VulnerabilityReport.VulnerabilityOrBuilder

VulnerabilityReportOrBuilder

Enums

CVSSv3.AttackComplexity

This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.AttackComplexity

CVSSv3.AttackVector

This metric reflects the context by which vulnerability exploitation is possible.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.AttackVector

CVSSv3.Impact

The Impact metrics capture the effects of a successfully exploited vulnerability on the component that suffers the worst outcome that is most directly and predictably associated with the attack.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.Impact

CVSSv3.PrivilegesRequired

This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.PrivilegesRequired

CVSSv3.Scope

The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.Scope

CVSSv3.UserInteraction

This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.

Protobuf enum google.cloud.osconfig.v1alpha.CVSSv3.UserInteraction

FixedOrPercent.ModeCase

Inventory.Item.DetailsCase

Inventory.Item.OriginType

The origin of a specific inventory item.

Protobuf enum google.cloud.osconfig.v1alpha.Inventory.Item.OriginType

Inventory.Item.Type

The different types of inventory that are tracked on a VM.

Protobuf enum google.cloud.osconfig.v1alpha.Inventory.Item.Type

Inventory.SoftwarePackage.DetailsCase

InventoryView

The view for inventory objects.

Protobuf enum google.cloud.osconfig.v1alpha.InventoryView

OSPolicy.Mode

Policy mode

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicy.Mode

OSPolicy.Resource.ExecResource.Exec.Interpreter

The interpreter to use.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec.Interpreter

OSPolicy.Resource.ExecResource.Exec.SourceCase

OSPolicy.Resource.File.TypeCase

OSPolicy.Resource.FileResource.DesiredState

Desired state of the file.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource.DesiredState

OSPolicy.Resource.FileResource.SourceCase

OSPolicy.Resource.PackageResource.DesiredState

The desired state that the OS Config agent maintains on the VM.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource.DesiredState

OSPolicy.Resource.PackageResource.SystemPackageCase

OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType

Type of archive.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType

OSPolicy.Resource.RepositoryResource.RepositoryCase

OSPolicy.Resource.ResourceTypeCase

OSPolicyAssignment.RolloutState

OS policy assignment rollout state

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignment.RolloutState

OSPolicyAssignmentOperationMetadata.APIMethod

The OS policy assignment API method.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata.APIMethod

OSPolicyAssignmentOperationMetadata.RolloutState

State of the rollout

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata.RolloutState

OSPolicyComplianceState

Supported OSPolicy compliance states.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyComplianceState

OSPolicyResourceCompliance.OutputCase

OSPolicyResourceConfigStep.Outcome

Supported outcomes for a configuration step.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Outcome

OSPolicyResourceConfigStep.Type

Supported configuration step types

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Type