@Generated("by gapic-generator-java")
Package com.google.cloud.osconfig.v1alpha
A client to OS Config API
The interfaces provided are listed below, along with usage samples.
======================= OsConfigZonalServiceClient =======================
Service Description: Zonal OS Config API
The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.
Sample for OsConfigZonalServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (OsConfigZonalServiceClient osConfigZonalServiceClient =
OsConfigZonalServiceClient.create()) {
OSPolicyAssignmentName name =
OSPolicyAssignmentName.of("[PROJECT]", "[LOCATION]", "[OS_POLICY_ASSIGNMENT]");
OSPolicyAssignment response = osConfigZonalServiceClient.getOSPolicyAssignment(name);
}
-
Class Summary Class Description Common ConfigCommonProto CreateOSPolicyAssignmentRequest A request message to create an OS policy assignmentCreateOSPolicyAssignmentRequest.Builder A request message to create an OS policy assignmentCVSSv3 Common Vulnerability Scoring System version 3.CVSSv3.Builder Common Vulnerability Scoring System version 3.DeleteOSPolicyAssignmentRequest A request message for deleting a OS policy assignment.DeleteOSPolicyAssignmentRequest.Builder A request message for deleting a OS policy assignment.FixedOrPercent Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.FixedOrPercent.Builder Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.GetInstanceOSPoliciesComplianceRequest Deprecated. GetInstanceOSPoliciesComplianceRequest.Builder A request message for getting OS policies compliance data for the given Compute Engine VM instance.GetInventoryRequest A request message for getting inventory data for the specified VM.GetInventoryRequest.Builder A request message for getting inventory data for the specified VM.GetOSPolicyAssignmentReportRequest Get a report of the OS policy assignment for a VM instance.GetOSPolicyAssignmentReportRequest.Builder Get a report of the OS policy assignment for a VM instance.GetOSPolicyAssignmentRequest A request message to get an OS policy assignmentGetOSPolicyAssignmentRequest.Builder A request message to get an OS policy assignmentGetVulnerabilityReportRequest A request message for getting the vulnerability report for the specified VM.GetVulnerabilityReportRequest.Builder A request message for getting the vulnerability report for the specified VM.InstanceName InstanceName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}.InstanceOSPoliciesCompliance Deprecated. InstanceOSPoliciesCompliance.Builder This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time.InstanceOSPoliciesCompliance.OSPolicyCompliance Deprecated. InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder Compliance data for an OS policyInstanceOSPoliciesComplianceName InstanceOSPoliciesComplianceName.Builder Builder for projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.InstanceOSPoliciesComplianceProto InstanceOSPolicyAssignmentName InstanceOSPolicyAssignmentName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}.Inventories Inventory This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time.Inventory.Builder This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time.Inventory.Item A single piece of inventory on a VM.Inventory.Item.Builder A single piece of inventory on a VM.Inventory.OsInfo Operating system information for the VM.Inventory.OsInfo.Builder Operating system information for the VM.Inventory.SoftwarePackage Software package information of the operating system.Inventory.SoftwarePackage.Builder Software package information of the operating system.Inventory.VersionedPackage Information related to the a standard versioned package.Inventory.VersionedPackage.Builder Information related to the a standard versioned package.Inventory.WindowsApplication Contains information about a Windows application that is retrieved from the Windows Registry.Inventory.WindowsApplication.Builder Contains information about a Windows application that is retrieved from the Windows Registry.Inventory.WindowsQuickFixEngineeringPackage Information related to a Quick Fix Engineering package.Inventory.WindowsQuickFixEngineeringPackage.Builder Information related to a Quick Fix Engineering package.Inventory.WindowsUpdatePackage Details related to a Windows Update package.Inventory.WindowsUpdatePackage.Builder Details related to a Windows Update package.Inventory.WindowsUpdatePackage.WindowsUpdateCategory Categories specified by the Windows Update.Inventory.WindowsUpdatePackage.WindowsUpdateCategory.Builder Categories specified by the Windows Update.Inventory.ZypperPatch Details related to a Zypper Patch.Inventory.ZypperPatch.Builder Details related to a Zypper Patch.InventoryName InventoryName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}/inventory.ListInstanceOSPoliciesCompliancesRequest Deprecated. ListInstanceOSPoliciesCompliancesRequest.Builder A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.ListInstanceOSPoliciesCompliancesResponse Deprecated. ListInstanceOSPoliciesCompliancesResponse.Builder A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.ListInventoriesRequest A request message for listing inventory data for all VMs in the specified location.ListInventoriesRequest.Builder A request message for listing inventory data for all VMs in the specified location.ListInventoriesResponse A response message for listing inventory data for all VMs in a specified location.ListInventoriesResponse.Builder A response message for listing inventory data for all VMs in a specified location.ListOSPolicyAssignmentReportsRequest List the OS policy assignment reports for VM instances.ListOSPolicyAssignmentReportsRequest.Builder List the OS policy assignment reports for VM instances.ListOSPolicyAssignmentReportsResponse A response message for listing OS Policy assignment reports including the page of results and page token.ListOSPolicyAssignmentReportsResponse.Builder A response message for listing OS Policy assignment reports including the page of results and page token.ListOSPolicyAssignmentRevisionsRequest A request message to list revisions for a OS policy assignmentListOSPolicyAssignmentRevisionsRequest.Builder A request message to list revisions for a OS policy assignmentListOSPolicyAssignmentRevisionsResponse A response message for listing all revisions for a OS policy assignment.ListOSPolicyAssignmentRevisionsResponse.Builder A response message for listing all revisions for a OS policy assignment.ListOSPolicyAssignmentsRequest A request message to list OS policy assignments for a parent resourceListOSPolicyAssignmentsRequest.Builder A request message to list OS policy assignments for a parent resourceListOSPolicyAssignmentsResponse A response message for listing all assignments under given parent.ListOSPolicyAssignmentsResponse.Builder A response message for listing all assignments under given parent.ListVulnerabilityReportsRequest A request message for listing vulnerability reports for all VM instances in the specified location.ListVulnerabilityReportsRequest.Builder A request message for listing vulnerability reports for all VM instances in the specified location.ListVulnerabilityReportsResponse A response message for listing vulnerability reports for all VM instances in the specified location.ListVulnerabilityReportsResponse.Builder A response message for listing vulnerability reports for all VM instances in the specified location.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.OsConfigZonalServiceClient Service Description: Zonal OS Config APIOsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesFixedSizeCollection OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPage OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPagedResponse 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 A stub to allow clients to do synchronous rpc calls to service OsConfigZonalService.OsConfigZonalServiceGrpc.OsConfigZonalServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service OsConfigZonalService.OsConfigZonalServiceGrpc.OsConfigZonalServiceImplBase Base class for the server implementation of the service OsConfigZonalService.OsConfigZonalServiceGrpc.OsConfigZonalServiceStub A stub to allow clients to do asynchronous rpc calls to service OsConfigZonalService.OsConfigZonalServiceProto OsConfigZonalServiceSettings Settings class to configure an instance ofOsConfigZonalServiceClient
.OsConfigZonalServiceSettings.Builder Builder for OsConfigZonalServiceSettings.OSPolicy An OS policy defines the desired state configuration for a VM.OSPolicy.Builder An OS policy defines the desired state configuration for a VM.OSPolicy.InventoryFilter Filtering criteria to select VMs based on inventory details.OSPolicy.InventoryFilter.Builder Filtering criteria to select VMs based on inventory details.OSPolicy.OSFilter Filtering criteria to select VMs based on OS details.OSPolicy.OSFilter.Builder Filtering criteria to select VMs based on OS details.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.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.OSPolicy.Resource.ExecResource A resource that allows executing scripts on the VM.OSPolicy.Resource.ExecResource.Builder A resource that allows executing scripts on the VM.OSPolicy.Resource.ExecResource.Exec A file or script to execute.OSPolicy.Resource.ExecResource.Exec.Builder A file or script to execute.OSPolicy.Resource.File A remote or local file.OSPolicy.Resource.File.Builder A remote or local file.OSPolicy.Resource.File.Gcs Specifies a file available as a Cloud Storage Object.OSPolicy.Resource.File.Gcs.Builder Specifies a file available as a Cloud Storage Object.OSPolicy.Resource.File.Remote Specifies a file available via some URI.OSPolicy.Resource.File.Remote.Builder Specifies a file available via some URI.OSPolicy.Resource.FileResource A resource that manages the state of a file.OSPolicy.Resource.FileResource.Builder A resource that manages the state of a file.OSPolicy.Resource.PackageResource A resource that manages a system package.OSPolicy.Resource.PackageResource.APT A package managed by APT.OSPolicy.Resource.PackageResource.APT.Builder A package managed by APT.OSPolicy.Resource.PackageResource.Builder A resource that manages a system package.OSPolicy.Resource.PackageResource.Deb A deb package file.OSPolicy.Resource.PackageResource.Deb.Builder A deb package file.OSPolicy.Resource.PackageResource.GooGet A package managed by GooGet.OSPolicy.Resource.PackageResource.GooGet.Builder A package managed by GooGet.OSPolicy.Resource.PackageResource.MSI An MSI package.OSPolicy.Resource.PackageResource.MSI.Builder An MSI package.OSPolicy.Resource.PackageResource.RPM An RPM package file.OSPolicy.Resource.PackageResource.RPM.Builder An RPM package file.OSPolicy.Resource.PackageResource.YUM A package managed by YUM.OSPolicy.Resource.PackageResource.YUM.Builder A package managed by YUM.OSPolicy.Resource.PackageResource.Zypper A package managed by Zypper.OSPolicy.Resource.PackageResource.Zypper.Builder A package managed by Zypper.OSPolicy.Resource.RepositoryResource A resource that manages a package repository.OSPolicy.Resource.RepositoryResource.AptRepository Represents a single apt package repository.OSPolicy.Resource.RepositoryResource.AptRepository.Builder Represents a single apt package repository.OSPolicy.Resource.RepositoryResource.Builder A resource that manages a package repository.OSPolicy.Resource.RepositoryResource.GooRepository Represents a Goo package repository.OSPolicy.Resource.RepositoryResource.GooRepository.Builder Represents a Goo package repository.OSPolicy.Resource.RepositoryResource.YumRepository Represents a single yum package repository.OSPolicy.Resource.RepositoryResource.YumRepository.Builder Represents a single yum package repository.OSPolicy.Resource.RepositoryResource.ZypperRepository Represents a single zypper package repository.OSPolicy.Resource.RepositoryResource.ZypperRepository.Builder Represents a single zypper package repository.OSPolicy.ResourceGroup Resource groups provide a mechanism to group OS policy resources.OSPolicy.ResourceGroup.Builder Resource groups provide a mechanism to group OS policy resources.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.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.OSPolicyAssignment.InstanceFilter Filters to select target VMs for an assignment.OSPolicyAssignment.InstanceFilter.Builder Filters to select target VMs for an assignment.OSPolicyAssignment.InstanceFilter.Inventory VM inventory details.OSPolicyAssignment.InstanceFilter.Inventory.Builder VM inventory details.OSPolicyAssignment.LabelSet Message representing label set.OSPolicyAssignment.LabelSet.Builder Message representing label set.OSPolicyAssignment.Rollout Message to configure the rollout at the zonal level for the OS policy assignment.OSPolicyAssignment.Rollout.Builder Message to configure the rollout at the zonal level for the OS policy assignment.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.OSPolicyAssignmentOperationMetadata.Builder OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.OSPolicyAssignmentReport A report of the OS policy assignment status for a given instance.OSPolicyAssignmentReport.Builder A report of the OS policy assignment status for a given instance.OSPolicyAssignmentReport.OSPolicyCompliance Compliance data for an OS policyOSPolicyAssignmentReport.OSPolicyCompliance.Builder Compliance data for an OS policyOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance Compliance data for an OS policy resource.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder Compliance data for an OS policy resource.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ExecResourceOutput ExecResource specific output.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ExecResourceOutput.Builder ExecResource specific output.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep.Builder Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state.OSPolicyAssignmentReportName OSPolicyAssignmentReportName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.OSPolicyAssignmentReportsProto OsPolicyAssignmentsProto OsPolicyProto OSPolicyResourceCompliance Deprecated. OSPolicyResourceCompliance.Builder Compliance data for an OS policy resource.OSPolicyResourceCompliance.ExecResourceOutput Deprecated. OSPolicyResourceCompliance.ExecResourceOutput.Builder ExecResource specific output.OSPolicyResourceConfigStep Deprecated. OSPolicyResourceConfigStep.Builder Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state.UpdateOSPolicyAssignmentRequest A request message to update an OS policy assignmentUpdateOSPolicyAssignmentRequest.Builder A request message to update an OS policy assignmentVulnerabilityProto VulnerabilityReport This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time.VulnerabilityReport.Builder This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time.VulnerabilityReport.Vulnerability A vulnerability affecting the VM instance.VulnerabilityReport.Vulnerability.Builder A vulnerability affecting the VM instance.VulnerabilityReport.Vulnerability.Details Contains metadata information for the vulnerability.VulnerabilityReport.Vulnerability.Details.Builder Contains metadata information for the vulnerability.VulnerabilityReport.Vulnerability.Details.Reference A reference for this vulnerability.VulnerabilityReport.Vulnerability.Details.Reference.Builder A reference for this vulnerability.VulnerabilityReport.Vulnerability.Item OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.VulnerabilityReport.Vulnerability.Item.Builder OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.VulnerabilityReportName VulnerabilityReportName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport. -
Enum Summary Enum Description CVSSv3.AttackComplexity This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.CVSSv3.AttackVector This metric reflects the context by which vulnerability exploitation is possible.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.CVSSv3.PrivilegesRequired This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.CVSSv3.Scope The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security 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.FixedOrPercent.ModeCase Inventory.Item.DetailsCase Inventory.Item.OriginType The origin of a specific inventory item.Inventory.Item.Type The different types of inventory that are tracked on a VM.Inventory.SoftwarePackage.DetailsCase InventoryView The view for inventory objects.OSPolicy.Mode Policy modeOSPolicy.Resource.ExecResource.Exec.Interpreter The interpreter to use.OSPolicy.Resource.ExecResource.Exec.SourceCase OSPolicy.Resource.File.TypeCase OSPolicy.Resource.FileResource.DesiredState Desired state of the file.OSPolicy.Resource.FileResource.SourceCase OSPolicy.Resource.PackageResource.DesiredState The desired state that the OS Config agent maintains on the VM.OSPolicy.Resource.PackageResource.SystemPackageCase OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType Type of archive.OSPolicy.Resource.RepositoryResource.RepositoryCase OSPolicy.Resource.ResourceTypeCase OSPolicyAssignment.RolloutState OS policy assignment rollout stateOSPolicyAssignmentOperationMetadata.APIMethod The OS policy assignment API method.OSPolicyAssignmentOperationMetadata.RolloutState State of the rolloutOSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState Possible compliance states for an os policy.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ComplianceState Possible compliance states for a resource.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OSPolicyResourceConfigStep.Type Supported configuration step typesOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.OutputCase OSPolicyComplianceState Deprecated. OSPolicyResourceCompliance.OutputCase OSPolicyResourceConfigStep.Outcome Deprecated. OSPolicyResourceConfigStep.Type Deprecated.