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

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

Protobuf type google.cloud.osconfig.v1alpha.CVSSv3

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

Protobuf type google.cloud.osconfig.v1alpha.CVSSv3

A request message to create an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.CreateOSPolicyAssignmentRequest

A request message to create an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.CreateOSPolicyAssignmentRequest

A request message for deleting a OS policy assignment.

Protobuf type google.cloud.osconfig.v1alpha.DeleteOSPolicyAssignmentRequest

A request message for deleting a OS policy assignment.

Protobuf type google.cloud.osconfig.v1alpha.DeleteOSPolicyAssignmentRequest

Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.

Protobuf type google.cloud.osconfig.v1alpha.FixedOrPercent

Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.

Protobuf type google.cloud.osconfig.v1alpha.FixedOrPercent

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

Protobuf type google.cloud.osconfig.v1alpha.GetInstanceOSPoliciesComplianceRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetInstanceOSPoliciesComplianceRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetInventoryRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetInventoryRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentReportRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentReportRequest

A request message to get an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentRequest

A request message to get an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.GetOSPolicyAssignmentRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetVulnerabilityReportRequest

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

Protobuf type google.cloud.osconfig.v1alpha.GetVulnerabilityReportRequest

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

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

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

Compliance data for an OS policy

Protobuf type google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance

Compliance data for an OS policy

Protobuf type google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance

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

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

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

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

A single piece of inventory on a VM.

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

A single piece of inventory on a VM.

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

Operating system information for the VM.

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

Operating system information for the VM.

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

Software package information of the operating system.

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

Software package information of the operating system.

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

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

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

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

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

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

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

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

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

Categories specified by the Windows Update.

Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage.WindowsUpdateCategory

Categories specified by the Windows Update.

Protobuf type google.cloud.osconfig.v1alpha.Inventory.WindowsUpdatePackage.WindowsUpdateCategory

Details related to a Zypper Patch.

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

Details related to a Zypper Patch.

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

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

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

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

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

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

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

Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListInventoriesResponse

List the OS policy assignment reports for VM instances.

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsRequest

List the OS policy assignment reports for VM instances.

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentReportsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.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

A request message to list revisions for a OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsRequest

A request message to list revisions for a OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentRevisionsResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsRequest

A response message for listing all assignments under given parent.

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsResponse

A response message for listing all assignments under given parent.

Protobuf type google.cloud.osconfig.v1alpha.ListOSPolicyAssignmentsResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsRequest

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsResponse

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

Protobuf type google.cloud.osconfig.v1alpha.ListVulnerabilityReportsResponse

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

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy

Filtering criteria to select VMs based on inventory details.

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

Filtering criteria to select VMs based on inventory details.

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

Filtering criteria to select VMs based on OS details.

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

Filtering criteria to select VMs based on OS details.

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

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

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

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

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

A file or script to execute.

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

A file or script to execute.

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

A remote or local file.

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

A remote or local file.

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

Specifies a file available as a Cloud Storage Object.

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

Specifies a file available as a Cloud Storage Object.

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

Specifies a file available via some URI.

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

Specifies a file available via some URI.

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

A resource that manages the state of a file.

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

A resource that manages the state of a file.

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

A resource that manages a system package.

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

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

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

A resource that manages a system package.

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

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

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

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

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

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

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

An MSI package. MSI packages only support INSTALLED state.

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

An MSI package. MSI packages only support INSTALLED state.

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

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

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

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

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

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

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

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

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

A resource that manages a package repository.

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

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

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

A resource that manages a package repository.

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

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

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

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

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

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

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

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

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

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

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

Filters to select target VMs for an assignment.

If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

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

Filters to select target VMs for an assignment.

If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

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

VM inventory details.

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

VM inventory details.

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

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

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

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

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

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

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

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

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

Protobuf type google.cloud.osconfig.v1alpha.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

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport

Compliance data for an OS policy

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance

Compliance data for an OS policy

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

ExecResource specific output.

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

ExecResource specific output.

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

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep

Builder for projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance

Compliance data for an OS policy resource.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceCompliance

ExecResource specific output.

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

ExecResource specific output.

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

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

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

Protobuf type google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

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:

 // 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);
 }
 

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:

 // 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
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     OsConfigZonalServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create(osConfigZonalServiceSettings);
 

To customize the endpoint:

 // 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
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     OsConfigZonalServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create(osConfigZonalServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     OsConfigZonalServiceSettings.newHttpJsonBuilder().build();
 OsConfigZonalServiceClient osConfigZonalServiceClient =
     OsConfigZonalServiceClient.create(osConfigZonalServiceSettings);
 

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

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.

A stub to allow clients to do synchronous rpc calls to service OsConfigZonalService.

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.

A stub to allow clients to do ListenableFuture-style rpc calls to service OsConfigZonalService.

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.

Base class for the server implementation of the service OsConfigZonalService.

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.

A stub to allow clients to do asynchronous rpc calls to service OsConfigZonalService.

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.

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:

 // 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
 OsConfigZonalServiceSettings.Builder osConfigZonalServiceSettingsBuilder =
     OsConfigZonalServiceSettings.newBuilder();
 osConfigZonalServiceSettingsBuilder
     .getOSPolicyAssignmentSettings()
     .setRetrySettings(
         osConfigZonalServiceSettingsBuilder
             .getOSPolicyAssignmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     osConfigZonalServiceSettingsBuilder.build();
 

Builder for OsConfigZonalServiceSettings.

A request message to update an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.UpdateOSPolicyAssignmentRequest

A request message to update an OS policy assignment

Protobuf type google.cloud.osconfig.v1alpha.UpdateOSPolicyAssignmentRequest

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

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

A vulnerability affecting the VM instance.

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

A vulnerability affecting the VM instance.

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

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

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

A reference for this vulnerability.

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

A reference for this vulnerability.

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

OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

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

OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

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

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

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

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

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

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

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

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

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

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

The origin of a specific inventory item.

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

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

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

The view for inventory objects.

Protobuf enum google.cloud.osconfig.v1alpha.InventoryView

Policy mode

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

The interpreter to use.

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

Desired state of the file.

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

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

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

Type of archive.

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

OS policy assignment rollout state

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

The OS policy assignment API method.

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

State of the rollout

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

Possible compliance states for an os policy.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState

Possible compliance states for a resource.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ComplianceState

Supported configuration step types

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep.Type

Supported OSPolicy compliance states.

Protobuf enum google.cloud.osconfig.v1alpha.OSPolicyComplianceState

Supported outcomes for a configuration step.

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

Supported configuration step types

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