Package com.google.cloud.osconfig.v1 (2.4.0)

A client to OS Config API

The interfaces provided are listed below, along with usage samples.

OsConfigServiceClient

Service Description: OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Sample for OsConfigServiceClient:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ExecutePatchJobRequest request =
       PatchJobs.ExecutePatchJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDescription("description-1724546052")
           .setInstanceFilter(PatchJobs.PatchInstanceFilter.newBuilder().build())
           .setPatchConfig(PatchJobs.PatchConfig.newBuilder().build())
           .setDuration(Duration.newBuilder().build())
           .setDryRun(true)
           .setDisplayName("displayName1714148973")
           .setRollout(PatchJobs.PatchRollout.newBuilder().build())
           .build();
   PatchJobs.PatchJob response = osConfigServiceClient.executePatchJob(request);
 }

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.v1.CVSSv3

CVSSv3.Builder

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

Protobuf type google.cloud.osconfig.v1.CVSSv3

Common

Common.FixedOrPercent

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

Protobuf type google.cloud.osconfig.v1.FixedOrPercent

Common.FixedOrPercent.Builder

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

Protobuf type google.cloud.osconfig.v1.FixedOrPercent

CreateOSPolicyAssignmentRequest

A request message to create an OS policy assignment

Protobuf type google.cloud.osconfig.v1.CreateOSPolicyAssignmentRequest

CreateOSPolicyAssignmentRequest.Builder

A request message to create an OS policy assignment

Protobuf type google.cloud.osconfig.v1.CreateOSPolicyAssignmentRequest

DeleteOSPolicyAssignmentRequest

A request message for deleting a OS policy assignment.

Protobuf type google.cloud.osconfig.v1.DeleteOSPolicyAssignmentRequest

DeleteOSPolicyAssignmentRequest.Builder

A request message for deleting a OS policy assignment.

Protobuf type google.cloud.osconfig.v1.DeleteOSPolicyAssignmentRequest

GetInventoryRequest

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

Protobuf type google.cloud.osconfig.v1.GetInventoryRequest

GetInventoryRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.GetInventoryRequest

GetOSPolicyAssignmentReportRequest

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

Protobuf type google.cloud.osconfig.v1.GetOSPolicyAssignmentReportRequest

GetOSPolicyAssignmentReportRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.GetOSPolicyAssignmentReportRequest

GetOSPolicyAssignmentRequest

A request message to get an OS policy assignment

Protobuf type google.cloud.osconfig.v1.GetOSPolicyAssignmentRequest

GetOSPolicyAssignmentRequest.Builder

A request message to get an OS policy assignment

Protobuf type google.cloud.osconfig.v1.GetOSPolicyAssignmentRequest

GetVulnerabilityReportRequest

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

Protobuf type google.cloud.osconfig.v1.GetVulnerabilityReportRequest

GetVulnerabilityReportRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.GetVulnerabilityReportRequest

InstanceName

InstanceName.Builder

Builder for projects/{project}/zones/{zone}/instances/{instance}.

InstanceName.ProjectLocationInstanceBuilder

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

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.v1.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.v1.Inventory

Inventory.Item

A single piece of inventory on a VM.

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

Inventory.Item.Builder

A single piece of inventory on a VM.

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

Inventory.OsInfo

Operating system information for the VM.

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

Inventory.OsInfo.Builder

Operating system information for the VM.

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

Inventory.SoftwarePackage

Software package information of the operating system.

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

Inventory.SoftwarePackage.Builder

Software package information of the operating system.

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Inventory.WindowsUpdatePackage

Inventory.WindowsUpdatePackage.WindowsUpdateCategory

Categories specified by the Windows Update.

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

Inventory.WindowsUpdatePackage.WindowsUpdateCategory.Builder

Categories specified by the Windows Update.

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

Inventory.ZypperPatch

Details related to a Zypper Patch.

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

Inventory.ZypperPatch.Builder

Details related to a Zypper Patch.

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

InventoryName

InventoryName.Builder

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

ListInventoriesRequest

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

Protobuf type google.cloud.osconfig.v1.ListInventoriesRequest

ListInventoriesRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.ListInventoriesRequest

ListInventoriesResponse

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

Protobuf type google.cloud.osconfig.v1.ListInventoriesResponse

ListInventoriesResponse.Builder

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

Protobuf type google.cloud.osconfig.v1.ListInventoriesResponse

ListOSPolicyAssignmentReportsRequest

List the OS policy assignment reports for VM instances.

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsRequest

ListOSPolicyAssignmentReportsRequest.Builder

List the OS policy assignment reports for VM instances.

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsRequest

ListOSPolicyAssignmentReportsResponse

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

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

ListOSPolicyAssignmentRevisionsRequest

A request message to list revisions for a OS policy assignment

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsRequest

ListOSPolicyAssignmentRevisionsRequest.Builder

A request message to list revisions for a OS policy assignment

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsRequest

ListOSPolicyAssignmentRevisionsResponse

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

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsResponse

ListOSPolicyAssignmentRevisionsResponse.Builder

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

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsResponse

ListOSPolicyAssignmentsRequest

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

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentsRequest

ListOSPolicyAssignmentsRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentsRequest

ListOSPolicyAssignmentsResponse

A response message for listing all assignments under given parent.

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentsResponse

ListOSPolicyAssignmentsResponse.Builder

A response message for listing all assignments under given parent.

Protobuf type google.cloud.osconfig.v1.ListOSPolicyAssignmentsResponse

ListVulnerabilityReportsRequest

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

Protobuf type google.cloud.osconfig.v1.ListVulnerabilityReportsRequest

ListVulnerabilityReportsRequest.Builder

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

Protobuf type google.cloud.osconfig.v1.ListVulnerabilityReportsRequest

ListVulnerabilityReportsResponse

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

Protobuf type google.cloud.osconfig.v1.ListVulnerabilityReportsResponse

ListVulnerabilityReportsResponse.Builder

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

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

OSPolicy.Builder

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

Protobuf type google.cloud.osconfig.v1.OSPolicy

OSPolicy.InventoryFilter

Filtering criteria to select VMs based on inventory details.

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

OSPolicy.InventoryFilter.Builder

Filtering criteria to select VMs based on inventory details.

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

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.v1.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.v1.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.v1.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.v1.OSPolicy.Resource.ExecResource

OSPolicy.Resource.ExecResource.Exec

A file or script to execute.

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

OSPolicy.Resource.ExecResource.Exec.Builder

A file or script to execute.

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

OSPolicy.Resource.File

A remote or local file.

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

OSPolicy.Resource.File.Builder

A remote or local file.

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

OSPolicy.Resource.File.Gcs

Specifies a file available as a Cloud Storage Object.

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

OSPolicy.Resource.File.Gcs.Builder

Specifies a file available as a Cloud Storage Object.

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

OSPolicy.Resource.File.Remote

Specifies a file available via some URI.

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

OSPolicy.Resource.File.Remote.Builder

Specifies a file available via some URI.

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

OSPolicy.Resource.FileResource

A resource that manages the state of a file.

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

OSPolicy.Resource.FileResource.Builder

A resource that manages the state of a file.

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

OSPolicy.Resource.PackageResource

A resource that manages a system package.

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.OSPolicy.Resource.PackageResource.APT

OSPolicy.Resource.PackageResource.Builder

A resource that manages a system package.

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

OSPolicy.Resource.PackageResource.Deb

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

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

OSPolicy.Resource.PackageResource.Deb.Builder

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

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.OSPolicy.Resource.PackageResource.GooGet

OSPolicy.Resource.PackageResource.MSI

An MSI package. MSI packages only support INSTALLED state.

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

OSPolicy.Resource.PackageResource.MSI.Builder

An MSI package. MSI packages only support INSTALLED state.

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

OSPolicy.Resource.PackageResource.RPM

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

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

OSPolicy.Resource.PackageResource.RPM.Builder

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

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.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.v1.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.v1.OSPolicy.Resource.PackageResource.Zypper

OSPolicy.Resource.RepositoryResource

A resource that manages a package repository.

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.OSPolicy.Resource.RepositoryResource.AptRepository

OSPolicy.Resource.RepositoryResource.Builder

A resource that manages a package repository.

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

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.v1.OSPolicyAssignment.InstanceFilter

OSPolicyAssignment.InstanceFilter.Builder

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.v1.OSPolicyAssignment.InstanceFilter

OSPolicyAssignment.InstanceFilter.Inventory

VM inventory details.

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

OSPolicyAssignment.InstanceFilter.Inventory.Builder

VM inventory details.

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

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.v1.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.v1.OSPolicyAssignment.LabelSet

OSPolicyAssignment.Rollout

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

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

OSPolicyAssignment.Rollout.Builder

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

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

OSPolicyAssignmentReport

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

Protobuf type google.cloud.osconfig.v1.OSPolicyAssignmentReport

OSPolicyAssignmentReport.Builder

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

Protobuf type google.cloud.osconfig.v1.OSPolicyAssignmentReport

OSPolicyAssignmentReport.OSPolicyCompliance

Compliance data for an OS policy

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

OSPolicyAssignmentReport.OSPolicyCompliance.Builder

Compliance data for an OS policy

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

Compliance data for an OS policy resource.

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder

Compliance data for an OS policy resource.

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ExecResourceOutput

ExecResource specific output.

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ExecResourceOutput.Builder

ExecResource specific output.

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

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.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep.Builder

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

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

OSPolicyAssignmentReportName

OSPolicyAssignmentReportName.Builder

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

OSPolicyAssignmentReportsProto

OsConfigProto

OsConfigServiceClient

Service Description: OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine 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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ExecutePatchJobRequest request =
       PatchJobs.ExecutePatchJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDescription("description-1724546052")
           .setInstanceFilter(PatchJobs.PatchInstanceFilter.newBuilder().build())
           .setPatchConfig(PatchJobs.PatchConfig.newBuilder().build())
           .setDuration(Duration.newBuilder().build())
           .setDryRun(true)
           .setDisplayName("displayName1714148973")
           .setRollout(PatchJobs.PatchRollout.newBuilder().build())
           .build();
   PatchJobs.PatchJob response = osConfigServiceClient.executePatchJob(request);
 }

Note: close() needs to be called on the OsConfigServiceClient 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 OsConfigServiceSettings to create(). For example:

To customize credentials:


 OsConfigServiceSettings osConfigServiceSettings =
     OsConfigServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OsConfigServiceClient osConfigServiceClient =
     OsConfigServiceClient.create(osConfigServiceSettings);

To customize the endpoint:


 OsConfigServiceSettings osConfigServiceSettings =
     OsConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OsConfigServiceClient osConfigServiceClient =
     OsConfigServiceClient.create(osConfigServiceSettings);

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

OsConfigServiceClient.ListPatchDeploymentsFixedSizeCollection

OsConfigServiceClient.ListPatchDeploymentsPage

OsConfigServiceClient.ListPatchDeploymentsPagedResponse

OsConfigServiceClient.ListPatchJobInstanceDetailsFixedSizeCollection

OsConfigServiceClient.ListPatchJobInstanceDetailsPage

OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse

OsConfigServiceClient.ListPatchJobsFixedSizeCollection

OsConfigServiceClient.ListPatchJobsPage

OsConfigServiceClient.ListPatchJobsPagedResponse

OsConfigServiceGrpc

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OsConfigServiceGrpc.OsConfigServiceBlockingStub

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OsConfigServiceGrpc.OsConfigServiceFutureStub

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OsConfigServiceGrpc.OsConfigServiceImplBase

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OsConfigServiceGrpc.OsConfigServiceStub

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OsConfigServiceSettings

Settings class to configure an instance of OsConfigServiceClient.

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 executePatchJob to 30 seconds:


 OsConfigServiceSettings.Builder osConfigServiceSettingsBuilder =
     OsConfigServiceSettings.newBuilder();
 osConfigServiceSettingsBuilder
     .executePatchJobSettings()
     .setRetrySettings(
         osConfigServiceSettingsBuilder
             .executePatchJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigServiceSettings osConfigServiceSettings = osConfigServiceSettingsBuilder.build();

OsConfigServiceSettings.Builder

Builder for OsConfigServiceSettings.

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

OsConfigZonalServiceClient.ListInventoriesPage

OsConfigZonalServiceClient.ListInventoriesPagedResponse

OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsFixedSizeCollection

OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPage

OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse

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.

OsPolicyAssignmentsProto

OsPolicyProto

PatchDeploymentName

PatchDeploymentName.Builder

Builder for projects/{project}/patchDeployments/{patch_deployment}.

PatchDeployments

PatchDeployments.CreatePatchDeploymentRequest

A request message for creating a patch deployment.

Protobuf type google.cloud.osconfig.v1.CreatePatchDeploymentRequest

PatchDeployments.CreatePatchDeploymentRequest.Builder

A request message for creating a patch deployment.

Protobuf type google.cloud.osconfig.v1.CreatePatchDeploymentRequest

PatchDeployments.DeletePatchDeploymentRequest

A request message for deleting a patch deployment.

Protobuf type google.cloud.osconfig.v1.DeletePatchDeploymentRequest

PatchDeployments.DeletePatchDeploymentRequest.Builder

A request message for deleting a patch deployment.

Protobuf type google.cloud.osconfig.v1.DeletePatchDeploymentRequest

PatchDeployments.GetPatchDeploymentRequest

A request message for retrieving a patch deployment.

Protobuf type google.cloud.osconfig.v1.GetPatchDeploymentRequest

PatchDeployments.GetPatchDeploymentRequest.Builder

A request message for retrieving a patch deployment.

Protobuf type google.cloud.osconfig.v1.GetPatchDeploymentRequest

PatchDeployments.ListPatchDeploymentsRequest

A request message for listing patch deployments.

Protobuf type google.cloud.osconfig.v1.ListPatchDeploymentsRequest

PatchDeployments.ListPatchDeploymentsRequest.Builder

A request message for listing patch deployments.

Protobuf type google.cloud.osconfig.v1.ListPatchDeploymentsRequest

PatchDeployments.ListPatchDeploymentsResponse

A response message for listing patch deployments.

Protobuf type google.cloud.osconfig.v1.ListPatchDeploymentsResponse

PatchDeployments.ListPatchDeploymentsResponse.Builder

A response message for listing patch deployments.

Protobuf type google.cloud.osconfig.v1.ListPatchDeploymentsResponse

PatchDeployments.MonthlySchedule

Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".

Protobuf type google.cloud.osconfig.v1.MonthlySchedule

PatchDeployments.MonthlySchedule.Builder

Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".

Protobuf type google.cloud.osconfig.v1.MonthlySchedule

PatchDeployments.OneTimeSchedule

Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.

Protobuf type google.cloud.osconfig.v1.OneTimeSchedule

PatchDeployments.OneTimeSchedule.Builder

Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.

Protobuf type google.cloud.osconfig.v1.OneTimeSchedule

PatchDeployments.PatchDeployment

Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs.

Protobuf type google.cloud.osconfig.v1.PatchDeployment

PatchDeployments.PatchDeployment.Builder

Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs.

Protobuf type google.cloud.osconfig.v1.PatchDeployment

PatchDeployments.PausePatchDeploymentRequest

A request message for pausing a patch deployment.

Protobuf type google.cloud.osconfig.v1.PausePatchDeploymentRequest

PatchDeployments.PausePatchDeploymentRequest.Builder

A request message for pausing a patch deployment.

Protobuf type google.cloud.osconfig.v1.PausePatchDeploymentRequest

PatchDeployments.RecurringSchedule

Sets the time for recurring patch deployments.

Protobuf type google.cloud.osconfig.v1.RecurringSchedule

PatchDeployments.RecurringSchedule.Builder

Sets the time for recurring patch deployments.

Protobuf type google.cloud.osconfig.v1.RecurringSchedule

PatchDeployments.ResumePatchDeploymentRequest

A request message for resuming a patch deployment.

Protobuf type google.cloud.osconfig.v1.ResumePatchDeploymentRequest

PatchDeployments.ResumePatchDeploymentRequest.Builder

A request message for resuming a patch deployment.

Protobuf type google.cloud.osconfig.v1.ResumePatchDeploymentRequest

PatchDeployments.UpdatePatchDeploymentRequest

A request message for updating a patch deployment.

Protobuf type google.cloud.osconfig.v1.UpdatePatchDeploymentRequest

PatchDeployments.UpdatePatchDeploymentRequest.Builder

A request message for updating a patch deployment.

Protobuf type google.cloud.osconfig.v1.UpdatePatchDeploymentRequest

PatchDeployments.WeekDayOfMonth

Represents one week day in a month. An example is "the 4th Sunday".

Protobuf type google.cloud.osconfig.v1.WeekDayOfMonth

PatchDeployments.WeekDayOfMonth.Builder

Represents one week day in a month. An example is "the 4th Sunday".

Protobuf type google.cloud.osconfig.v1.WeekDayOfMonth

PatchDeployments.WeeklySchedule

Represents a weekly schedule.

Protobuf type google.cloud.osconfig.v1.WeeklySchedule

PatchDeployments.WeeklySchedule.Builder

Represents a weekly schedule.

Protobuf type google.cloud.osconfig.v1.WeeklySchedule

PatchJobName

PatchJobName.Builder

Builder for projects/{project}/patchJobs/{patch_job}.

PatchJobs

PatchJobs.AptSettings

Apt patching is completed by executing apt-get update && apt-get upgrade. Additional options can be set to control how this is executed.

Protobuf type google.cloud.osconfig.v1.AptSettings

PatchJobs.AptSettings.Builder

Apt patching is completed by executing apt-get update && apt-get upgrade. Additional options can be set to control how this is executed.

Protobuf type google.cloud.osconfig.v1.AptSettings

PatchJobs.CancelPatchJobRequest

Message for canceling a patch job.

Protobuf type google.cloud.osconfig.v1.CancelPatchJobRequest

PatchJobs.CancelPatchJobRequest.Builder

Message for canceling a patch job.

Protobuf type google.cloud.osconfig.v1.CancelPatchJobRequest

PatchJobs.ExecStep

A step that runs an executable for a PatchJob.

Protobuf type google.cloud.osconfig.v1.ExecStep

PatchJobs.ExecStep.Builder

A step that runs an executable for a PatchJob.

Protobuf type google.cloud.osconfig.v1.ExecStep

PatchJobs.ExecStepConfig

Common configurations for an ExecStep.

Protobuf type google.cloud.osconfig.v1.ExecStepConfig

PatchJobs.ExecStepConfig.Builder

Common configurations for an ExecStep.

Protobuf type google.cloud.osconfig.v1.ExecStepConfig

PatchJobs.ExecutePatchJobRequest

A request message to initiate patching across Compute Engine instances.

Protobuf type google.cloud.osconfig.v1.ExecutePatchJobRequest

PatchJobs.ExecutePatchJobRequest.Builder

A request message to initiate patching across Compute Engine instances.

Protobuf type google.cloud.osconfig.v1.ExecutePatchJobRequest

PatchJobs.GcsObject

Cloud Storage object representation.

Protobuf type google.cloud.osconfig.v1.GcsObject

PatchJobs.GcsObject.Builder

Cloud Storage object representation.

Protobuf type google.cloud.osconfig.v1.GcsObject

PatchJobs.GetPatchJobRequest

Request to get an active or completed patch job.

Protobuf type google.cloud.osconfig.v1.GetPatchJobRequest

PatchJobs.GetPatchJobRequest.Builder

Request to get an active or completed patch job.

Protobuf type google.cloud.osconfig.v1.GetPatchJobRequest

PatchJobs.GooSettings

Googet patching is performed by running googet update.

Protobuf type google.cloud.osconfig.v1.GooSettings

PatchJobs.GooSettings.Builder

Googet patching is performed by running googet update.

Protobuf type google.cloud.osconfig.v1.GooSettings

PatchJobs.Instance

Namespace for instance state enums.

Protobuf type google.cloud.osconfig.v1.Instance

PatchJobs.Instance.Builder

Namespace for instance state enums.

Protobuf type google.cloud.osconfig.v1.Instance

PatchJobs.ListPatchJobInstanceDetailsRequest

Request to list details for all instances that are part of a patch job.

Protobuf type google.cloud.osconfig.v1.ListPatchJobInstanceDetailsRequest

PatchJobs.ListPatchJobInstanceDetailsRequest.Builder

Request to list details for all instances that are part of a patch job.

Protobuf type google.cloud.osconfig.v1.ListPatchJobInstanceDetailsRequest

PatchJobs.ListPatchJobInstanceDetailsResponse

A response message for listing the instances details for a patch job.

Protobuf type google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse

PatchJobs.ListPatchJobInstanceDetailsResponse.Builder

A response message for listing the instances details for a patch job.

Protobuf type google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse

PatchJobs.ListPatchJobsRequest

A request message for listing patch jobs.

Protobuf type google.cloud.osconfig.v1.ListPatchJobsRequest

PatchJobs.ListPatchJobsRequest.Builder

A request message for listing patch jobs.

Protobuf type google.cloud.osconfig.v1.ListPatchJobsRequest

PatchJobs.ListPatchJobsResponse

A response message for listing patch jobs.

Protobuf type google.cloud.osconfig.v1.ListPatchJobsResponse

PatchJobs.ListPatchJobsResponse.Builder

A response message for listing patch jobs.

Protobuf type google.cloud.osconfig.v1.ListPatchJobsResponse

PatchJobs.PatchConfig

Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.

Protobuf type google.cloud.osconfig.v1.PatchConfig

PatchJobs.PatchConfig.Builder

Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.

Protobuf type google.cloud.osconfig.v1.PatchConfig

PatchJobs.PatchInstanceFilter

A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.

Protobuf type google.cloud.osconfig.v1.PatchInstanceFilter

PatchJobs.PatchInstanceFilter.Builder

A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.

Protobuf type google.cloud.osconfig.v1.PatchInstanceFilter

PatchJobs.PatchInstanceFilter.GroupLabel

Targets a group of VM instances by using their assigned labels. Labels are key-value pairs. A GroupLabel is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following GroupLabel: {"env":"test", "app":"web"}. This means that the patch job is applied to VMs that have both the labels env=test and app=web.

Protobuf type google.cloud.osconfig.v1.PatchInstanceFilter.GroupLabel

PatchJobs.PatchInstanceFilter.GroupLabel.Builder

Targets a group of VM instances by using their assigned labels. Labels are key-value pairs. A GroupLabel is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following GroupLabel: {"env":"test", "app":"web"}. This means that the patch job is applied to VMs that have both the labels env=test and app=web.

Protobuf type google.cloud.osconfig.v1.PatchInstanceFilter.GroupLabel

PatchJobs.PatchJob

A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see Creating patch jobs.

Protobuf type google.cloud.osconfig.v1.PatchJob

PatchJobs.PatchJob.Builder

A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see Creating patch jobs.

Protobuf type google.cloud.osconfig.v1.PatchJob

PatchJobs.PatchJob.InstanceDetailsSummary

A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to InstancePatchState. List patch job instance details to see the specific states of each instance.

Protobuf type google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary

PatchJobs.PatchJob.InstanceDetailsSummary.Builder

A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to InstancePatchState. List patch job instance details to see the specific states of each instance.

Protobuf type google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary

PatchJobs.PatchJobInstanceDetails

Patch details for a VM instance. For more information about reviewing VM instance details, see Listing all VM instance details for a specific patch job.

Protobuf type google.cloud.osconfig.v1.PatchJobInstanceDetails

PatchJobs.PatchJobInstanceDetails.Builder

Patch details for a VM instance. For more information about reviewing VM instance details, see Listing all VM instance details for a specific patch job.

Protobuf type google.cloud.osconfig.v1.PatchJobInstanceDetails

PatchJobs.PatchRollout

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.

Protobuf type google.cloud.osconfig.v1.PatchRollout

PatchJobs.PatchRollout.Builder

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.

Protobuf type google.cloud.osconfig.v1.PatchRollout

PatchJobs.WindowsUpdateSettings

Windows patching is performed using the Windows Update Agent.

Protobuf type google.cloud.osconfig.v1.WindowsUpdateSettings

PatchJobs.WindowsUpdateSettings.Builder

Windows patching is performed using the Windows Update Agent.

Protobuf type google.cloud.osconfig.v1.WindowsUpdateSettings

PatchJobs.YumSettings

Yum patching is performed by executing yum update. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.

Protobuf type google.cloud.osconfig.v1.YumSettings

PatchJobs.YumSettings.Builder

Yum patching is performed by executing yum update. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.

Protobuf type google.cloud.osconfig.v1.YumSettings

PatchJobs.ZypperSettings

Zypper patching is performed by running zypper patch. See also https://en.opensuse.org/SDB:Zypper_manual.

Protobuf type google.cloud.osconfig.v1.ZypperSettings

PatchJobs.ZypperSettings.Builder

Zypper patching is performed by running zypper patch. See also https://en.opensuse.org/SDB:Zypper_manual.

Protobuf type google.cloud.osconfig.v1.ZypperSettings

ProjectName

ProjectName.Builder

Builder for projects/{project}.

UpdateOSPolicyAssignmentRequest

A request message to update an OS policy assignment

Protobuf type google.cloud.osconfig.v1.UpdateOSPolicyAssignmentRequest

UpdateOSPolicyAssignmentRequest.Builder

A request message to update an OS policy assignment

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

VulnerabilityReport.Vulnerability

A vulnerability affecting the VM instance.

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

VulnerabilityReport.Vulnerability.Builder

A vulnerability affecting the VM instance.

Protobuf type google.cloud.osconfig.v1.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.v1.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.v1.VulnerabilityReport.Vulnerability.Details

VulnerabilityReport.Vulnerability.Details.Reference

A reference for this vulnerability.

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

VulnerabilityReport.Vulnerability.Details.Reference.Builder

A reference for this vulnerability.

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

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.v1.VulnerabilityReport.Vulnerability.Item

VulnerabilityReport.Vulnerability.Item.Builder

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

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

VulnerabilityReportName

VulnerabilityReportName.Builder

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

Interfaces

CVSSv3OrBuilder

Common.FixedOrPercentOrBuilder

CreateOSPolicyAssignmentRequestOrBuilder

DeleteOSPolicyAssignmentRequestOrBuilder

GetInventoryRequestOrBuilder

GetOSPolicyAssignmentReportRequestOrBuilder

GetOSPolicyAssignmentRequestOrBuilder

GetVulnerabilityReportRequestOrBuilder

Inventory.ItemOrBuilder

Inventory.OsInfoOrBuilder

Inventory.SoftwarePackageOrBuilder

Inventory.VersionedPackageOrBuilder

Inventory.WindowsApplicationOrBuilder

Inventory.WindowsQuickFixEngineeringPackageOrBuilder

Inventory.WindowsUpdatePackage.WindowsUpdateCategoryOrBuilder

Inventory.WindowsUpdatePackageOrBuilder

Inventory.ZypperPatchOrBuilder

InventoryOrBuilder

ListInventoriesRequestOrBuilder

ListInventoriesResponseOrBuilder

ListOSPolicyAssignmentReportsRequestOrBuilder

ListOSPolicyAssignmentReportsResponseOrBuilder

ListOSPolicyAssignmentRevisionsRequestOrBuilder

ListOSPolicyAssignmentRevisionsResponseOrBuilder

ListOSPolicyAssignmentsRequestOrBuilder

ListOSPolicyAssignmentsResponseOrBuilder

ListVulnerabilityReportsRequestOrBuilder

ListVulnerabilityReportsResponseOrBuilder

OSPolicy.InventoryFilterOrBuilder

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.InstanceFilter.InventoryOrBuilder

OSPolicyAssignment.InstanceFilterOrBuilder

OSPolicyAssignment.LabelSetOrBuilder

OSPolicyAssignment.RolloutOrBuilder

OSPolicyAssignmentOperationMetadataOrBuilder

OSPolicyAssignmentOrBuilder

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ExecResourceOutputOrBuilder

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStepOrBuilder

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder

OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder

OSPolicyAssignmentReportOrBuilder

OSPolicyOrBuilder

PatchDeployments.CreatePatchDeploymentRequestOrBuilder

PatchDeployments.DeletePatchDeploymentRequestOrBuilder

PatchDeployments.GetPatchDeploymentRequestOrBuilder

PatchDeployments.ListPatchDeploymentsRequestOrBuilder

PatchDeployments.ListPatchDeploymentsResponseOrBuilder

PatchDeployments.MonthlyScheduleOrBuilder

PatchDeployments.OneTimeScheduleOrBuilder

PatchDeployments.PatchDeploymentOrBuilder

PatchDeployments.PausePatchDeploymentRequestOrBuilder

PatchDeployments.RecurringScheduleOrBuilder

PatchDeployments.ResumePatchDeploymentRequestOrBuilder

PatchDeployments.UpdatePatchDeploymentRequestOrBuilder

PatchDeployments.WeekDayOfMonthOrBuilder

PatchDeployments.WeeklyScheduleOrBuilder

PatchJobs.AptSettingsOrBuilder

PatchJobs.CancelPatchJobRequestOrBuilder

PatchJobs.ExecStepConfigOrBuilder

PatchJobs.ExecStepOrBuilder

PatchJobs.ExecutePatchJobRequestOrBuilder

PatchJobs.GcsObjectOrBuilder

PatchJobs.GetPatchJobRequestOrBuilder

PatchJobs.GooSettingsOrBuilder

PatchJobs.InstanceOrBuilder

PatchJobs.ListPatchJobInstanceDetailsRequestOrBuilder

PatchJobs.ListPatchJobInstanceDetailsResponseOrBuilder

PatchJobs.ListPatchJobsRequestOrBuilder

PatchJobs.ListPatchJobsResponseOrBuilder

PatchJobs.PatchConfigOrBuilder

PatchJobs.PatchInstanceFilter.GroupLabelOrBuilder

PatchJobs.PatchInstanceFilterOrBuilder

PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder

PatchJobs.PatchJobInstanceDetailsOrBuilder

PatchJobs.PatchJobOrBuilder

PatchJobs.PatchRolloutOrBuilder

PatchJobs.WindowsUpdateSettingsOrBuilder

PatchJobs.YumSettingsOrBuilder

PatchJobs.ZypperSettingsOrBuilder

UpdateOSPolicyAssignmentRequestOrBuilder

VulnerabilityReport.Vulnerability.Details.ReferenceOrBuilder

VulnerabilityReport.Vulnerability.DetailsOrBuilder

VulnerabilityReport.Vulnerability.ItemOrBuilder

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.v1.CVSSv3.AttackComplexity

CVSSv3.AttackVector

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

Protobuf enum google.cloud.osconfig.v1.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.v1.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.v1.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.v1.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.v1.CVSSv3.UserInteraction

Common.FixedOrPercent.ModeCase

Inventory.Item.DetailsCase

Inventory.Item.OriginType

The origin of a specific inventory item.

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

Inventory.Item.Type

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

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

Inventory.SoftwarePackage.DetailsCase

InventoryView

The view for inventory objects.

Protobuf enum google.cloud.osconfig.v1.InventoryView

OSPolicy.Mode

Policy mode

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

OSPolicy.Resource.ExecResource.Exec.Interpreter

The interpreter to use.

Protobuf enum google.cloud.osconfig.v1.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.v1.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.v1.OSPolicy.Resource.PackageResource.DesiredState

OSPolicy.Resource.PackageResource.SystemPackageCase

OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType

Type of archive.

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

OSPolicy.Resource.RepositoryResource.RepositoryCase

OSPolicy.Resource.ResourceTypeCase

OSPolicyAssignment.RolloutState

OS policy assignment rollout state

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

OSPolicyAssignmentOperationMetadata.APIMethod

The OS policy assignment API method.

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

OSPolicyAssignmentOperationMetadata.RolloutState

State of the rollout

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

OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState

Possible compliance states for an os policy.

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ComplianceState

Possible compliance states for a resource.

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep.Type

Supported configuration step types

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

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OutputCase

PatchDeployments.MonthlySchedule.DayOfMonthCase

PatchDeployments.PatchDeployment.ScheduleCase

PatchDeployments.PatchDeployment.State

Represents state of patch peployment.

Protobuf enum google.cloud.osconfig.v1.PatchDeployment.State

PatchDeployments.RecurringSchedule.Frequency

Specifies the frequency of the recurring patch deployments.

Protobuf enum google.cloud.osconfig.v1.RecurringSchedule.Frequency

PatchDeployments.RecurringSchedule.ScheduleConfigCase

PatchJobs.AptSettings.Type

Apt patch type.

Protobuf enum google.cloud.osconfig.v1.AptSettings.Type

PatchJobs.ExecStepConfig.ExecutableCase

PatchJobs.ExecStepConfig.Interpreter

The interpreter used to execute the a file.

Protobuf enum google.cloud.osconfig.v1.ExecStepConfig.Interpreter

PatchJobs.Instance.PatchState

Patch state of an instance.

Protobuf enum google.cloud.osconfig.v1.Instance.PatchState

PatchJobs.PatchConfig.RebootConfig

Post-patch reboot settings.

Protobuf enum google.cloud.osconfig.v1.PatchConfig.RebootConfig

PatchJobs.PatchJob.State

Enumeration of the various states a patch job passes through as it executes.

Protobuf enum google.cloud.osconfig.v1.PatchJob.State

PatchJobs.PatchRollout.Mode

Type of the rollout.

Protobuf enum google.cloud.osconfig.v1.PatchRollout.Mode

PatchJobs.WindowsUpdateSettings.Classification

Microsoft Windows update classifications as defined in [1] https://support.microsoft.com/en-us/help/824684/description-of-the-standard-terminology-that-is-used-to-describe-micro

Protobuf enum google.cloud.osconfig.v1.WindowsUpdateSettings.Classification