@Generated("by gapic-generator-java")
Package com.google.cloud.osconfig.v1beta
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:
// 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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.ExecutePatchJobRequest request =
PatchJobs.ExecutePatchJobRequest.newBuilder()
.setParent("parent-995424086")
.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);
}
-
Class Summary Class Description Common Common.FixedOrPercent Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.Common.FixedOrPercent.Builder Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.GuestPolicies GuestPolicies.AptRepository Represents a single Apt package repository.GuestPolicies.AptRepository.Builder Represents a single Apt package repository.GuestPolicies.Assignment An assignment represents the group or groups of VM instances that the policy applies to.GuestPolicies.Assignment.Builder An assignment represents the group or groups of VM instances that the policy applies to.GuestPolicies.Assignment.GroupLabel Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".GuestPolicies.Assignment.GroupLabel.Builder Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".GuestPolicies.Assignment.OsType Defines the criteria for selecting VM Instances by OS type.GuestPolicies.Assignment.OsType.Builder Defines the criteria for selecting VM Instances by OS type.GuestPolicies.CreateGuestPolicyRequest A request message for creating a guest policy.GuestPolicies.CreateGuestPolicyRequest.Builder A request message for creating a guest policy.GuestPolicies.DeleteGuestPolicyRequest A request message for deleting a guest policy.GuestPolicies.DeleteGuestPolicyRequest.Builder A request message for deleting a guest policy.GuestPolicies.EffectiveGuestPolicy The effective guest policy that applies to a VM instance.GuestPolicies.EffectiveGuestPolicy.Builder The effective guest policy that applies to a VM instance.GuestPolicies.EffectiveGuestPolicy.SourcedPackage A guest policy package including its source.GuestPolicies.EffectiveGuestPolicy.SourcedPackage.Builder A guest policy package including its source.GuestPolicies.EffectiveGuestPolicy.SourcedPackageRepository A guest policy package repository including its source.GuestPolicies.EffectiveGuestPolicy.SourcedPackageRepository.Builder A guest policy package repository including its source.GuestPolicies.EffectiveGuestPolicy.SourcedSoftwareRecipe A guest policy recipe including its source.GuestPolicies.EffectiveGuestPolicy.SourcedSoftwareRecipe.Builder A guest policy recipe including its source.GuestPolicies.GetGuestPolicyRequest A request message for retrieving a guest policy.GuestPolicies.GetGuestPolicyRequest.Builder A request message for retrieving a guest policy.GuestPolicies.GooRepository Represents a Goo package repository.GuestPolicies.GooRepository.Builder Represents a Goo package repository.GuestPolicies.GuestPolicy An OS Config resource representing a guest configuration policy.GuestPolicies.GuestPolicy.Builder An OS Config resource representing a guest configuration policy.GuestPolicies.ListGuestPoliciesRequest A request message for listing guest policies.GuestPolicies.ListGuestPoliciesRequest.Builder A request message for listing guest policies.GuestPolicies.ListGuestPoliciesResponse A response message for listing guest policies.GuestPolicies.ListGuestPoliciesResponse.Builder A response message for listing guest policies.GuestPolicies.LookupEffectiveGuestPolicyRequest A request message for getting the effective guest policy assigned to the instance.GuestPolicies.LookupEffectiveGuestPolicyRequest.Builder A request message for getting the effective guest policy assigned to the instance.GuestPolicies.Package Package is a reference to the software package to be installed or removed.GuestPolicies.Package.Builder Package is a reference to the software package to be installed or removed.GuestPolicies.PackageRepository A package repository.GuestPolicies.PackageRepository.Builder A package repository.GuestPolicies.SoftwareRecipe A software recipe is a set of instructions for installing and configuring a piece of software.GuestPolicies.SoftwareRecipe.Artifact Specifies a resource to be used in the recipe.GuestPolicies.SoftwareRecipe.Artifact.Builder Specifies a resource to be used in the recipe.GuestPolicies.SoftwareRecipe.Artifact.Gcs Specifies an artifact available as a Google Cloud Storage object.GuestPolicies.SoftwareRecipe.Artifact.Gcs.Builder Specifies an artifact available as a Google Cloud Storage object.GuestPolicies.SoftwareRecipe.Artifact.Remote Specifies an artifact available via some URI.GuestPolicies.SoftwareRecipe.Artifact.Remote.Builder Specifies an artifact available via some URI.GuestPolicies.SoftwareRecipe.Builder A software recipe is a set of instructions for installing and configuring a piece of software.GuestPolicies.SoftwareRecipe.Step An action that can be taken as part of installing or updating a recipe.GuestPolicies.SoftwareRecipe.Step.Builder An action that can be taken as part of installing or updating a recipe.GuestPolicies.SoftwareRecipe.Step.CopyFile Copies the artifact to the specified path on the instance.GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder Copies the artifact to the specified path on the instance.GuestPolicies.SoftwareRecipe.Step.ExecFile Executes an artifact or local file.GuestPolicies.SoftwareRecipe.Step.ExecFile.Builder Executes an artifact or local file.GuestPolicies.SoftwareRecipe.Step.ExtractArchive Extracts an archive of the type specified in the specified directory.GuestPolicies.SoftwareRecipe.Step.ExtractArchive.Builder Extracts an archive of the type specified in the specified directory.GuestPolicies.SoftwareRecipe.Step.InstallDpkg Installs a deb via dpkg.GuestPolicies.SoftwareRecipe.Step.InstallDpkg.Builder Installs a deb via dpkg.GuestPolicies.SoftwareRecipe.Step.InstallMsi Installs an MSI file.GuestPolicies.SoftwareRecipe.Step.InstallMsi.Builder Installs an MSI file.GuestPolicies.SoftwareRecipe.Step.InstallRpm Installs an rpm file via the rpm utility.GuestPolicies.SoftwareRecipe.Step.InstallRpm.Builder Installs an rpm file via the rpm utility.GuestPolicies.SoftwareRecipe.Step.RunScript Runs a script through an interpreter.GuestPolicies.SoftwareRecipe.Step.RunScript.Builder Runs a script through an interpreter.GuestPolicies.UpdateGuestPolicyRequest A request message for updating a guest policy.GuestPolicies.UpdateGuestPolicyRequest.Builder A request message for updating a guest policy.GuestPolicies.YumRepository Represents a single Yum package repository.GuestPolicies.YumRepository.Builder Represents a single Yum package repository.GuestPolicies.ZypperRepository Represents a single Zypper package repository.GuestPolicies.ZypperRepository.Builder Represents a single Zypper package repository.GuestPolicyName GuestPolicyName.Builder Builder for projects/{project}/guestPolicies/{guest_policy}.OsConfigProto OsConfigServiceClient Service Description: OS Config APIOsConfigServiceClient.ListGuestPoliciesFixedSizeCollection OsConfigServiceClient.ListGuestPoliciesPage OsConfigServiceClient.ListGuestPoliciesPagedResponse 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 A stub to allow clients to do synchronous rpc calls to service OsConfigService.OsConfigServiceGrpc.OsConfigServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service OsConfigService.OsConfigServiceGrpc.OsConfigServiceImplBase Base class for the server implementation of the service OsConfigService.OsConfigServiceGrpc.OsConfigServiceStub A stub to allow clients to do asynchronous rpc calls to service OsConfigService.OsConfigServiceSettings Settings class to configure an instance ofOsConfigServiceClient
.OsConfigServiceSettings.Builder Builder for OsConfigServiceSettings.PatchDeploymentName PatchDeploymentName.Builder Builder for projects/{project}/patchDeployments/{patch_deployment}.PatchDeployments PatchDeployments.CreatePatchDeploymentRequest A request message for creating a patch deployment.PatchDeployments.CreatePatchDeploymentRequest.Builder A request message for creating a patch deployment.PatchDeployments.DeletePatchDeploymentRequest A request message for deleting a patch deployment.PatchDeployments.DeletePatchDeploymentRequest.Builder A request message for deleting a patch deployment.PatchDeployments.GetPatchDeploymentRequest A request message for retrieving a patch deployment.PatchDeployments.GetPatchDeploymentRequest.Builder A request message for retrieving a patch deployment.PatchDeployments.ListPatchDeploymentsRequest A request message for listing patch deployments.PatchDeployments.ListPatchDeploymentsRequest.Builder A request message for listing patch deployments.PatchDeployments.ListPatchDeploymentsResponse A response message for listing patch deployments.PatchDeployments.ListPatchDeploymentsResponse.Builder A response message for listing patch deployments.PatchDeployments.MonthlySchedule Represents a monthly schedule.PatchDeployments.MonthlySchedule.Builder Represents a monthly schedule.PatchDeployments.OneTimeSchedule Sets the time for a one time patch deployment.PatchDeployments.OneTimeSchedule.Builder Sets the time for a one time patch deployment.PatchDeployments.PatchDeployment Patch deployments are configurations that individual patch jobs use to complete a patch.PatchDeployments.PatchDeployment.Builder Patch deployments are configurations that individual patch jobs use to complete a patch.PatchDeployments.PausePatchDeploymentRequest A request message for pausing a patch deployment.PatchDeployments.PausePatchDeploymentRequest.Builder A request message for pausing a patch deployment.PatchDeployments.RecurringSchedule Sets the time for recurring patch deployments.PatchDeployments.RecurringSchedule.Builder Sets the time for recurring patch deployments.PatchDeployments.ResumePatchDeploymentRequest A request message for resuming a patch deployment.PatchDeployments.ResumePatchDeploymentRequest.Builder A request message for resuming a patch deployment.PatchDeployments.UpdatePatchDeploymentRequest A request message for updating a patch deployment.PatchDeployments.UpdatePatchDeploymentRequest.Builder A request message for updating a patch deployment.PatchDeployments.WeekDayOfMonth Represents one week day in a month.PatchDeployments.WeekDayOfMonth.Builder Represents one week day in a month.PatchDeployments.WeeklySchedule Represents a weekly schedule.PatchDeployments.WeeklySchedule.Builder Represents a weekly schedule.PatchJobs PatchJobs.AptSettings Apt patching is completed by executing `apt-get update && apt-get upgrade`.PatchJobs.AptSettings.Builder Apt patching is completed by executing `apt-get update && apt-get upgrade`.PatchJobs.CancelPatchJobRequest Message for canceling a patch job.PatchJobs.CancelPatchJobRequest.Builder Message for canceling a patch job.PatchJobs.ExecStep A step that runs an executable for a PatchJob.PatchJobs.ExecStep.Builder A step that runs an executable for a PatchJob.PatchJobs.ExecStepConfig Common configurations for an ExecStep.PatchJobs.ExecStepConfig.Builder Common configurations for an ExecStep.PatchJobs.ExecutePatchJobRequest A request message to initiate patching across Compute Engine instances.PatchJobs.ExecutePatchJobRequest.Builder A request message to initiate patching across Compute Engine instances.PatchJobs.GcsObject Google Cloud Storage object representation.PatchJobs.GcsObject.Builder Google Cloud Storage object representation.PatchJobs.GetPatchJobRequest Request to get an active or completed patch job.PatchJobs.GetPatchJobRequest.Builder Request to get an active or completed patch job.PatchJobs.GooSettings Googet patching is performed by running `googet update`.PatchJobs.GooSettings.Builder Googet patching is performed by running `googet update`.PatchJobs.Instance Namespace for instance state enums.PatchJobs.Instance.Builder Namespace for instance state enums.PatchJobs.ListPatchJobInstanceDetailsRequest Request to list details for all instances that are part of a patch job.PatchJobs.ListPatchJobInstanceDetailsRequest.Builder Request to list details for all instances that are part of a patch job.PatchJobs.ListPatchJobInstanceDetailsResponse A response message for listing the instances details for a patch job.PatchJobs.ListPatchJobInstanceDetailsResponse.Builder A response message for listing the instances details for a patch job.PatchJobs.ListPatchJobsRequest A request message for listing patch jobs.PatchJobs.ListPatchJobsRequest.Builder A request message for listing patch jobs.PatchJobs.ListPatchJobsResponse A response message for listing patch jobs.PatchJobs.ListPatchJobsResponse.Builder A response message for listing patch jobs.PatchJobs.PatchConfig Patch configuration specifications.PatchJobs.PatchConfig.Builder Patch configuration specifications.PatchJobs.PatchInstanceFilter A filter to target VM instances for patching.PatchJobs.PatchInstanceFilter.Builder A filter to target VM instances for patching.PatchJobs.PatchInstanceFilter.GroupLabel Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".PatchJobs.PatchInstanceFilter.GroupLabel.Builder Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".PatchJobs.PatchJob A high level representation of a patch job that is either in progress or has completed.PatchJobs.PatchJob.Builder A high level representation of a patch job that is either in progress or has completed.PatchJobs.PatchJob.InstanceDetailsSummary A summary of the current patch state across all instances that this patch job affects.PatchJobs.PatchJob.InstanceDetailsSummary.Builder A summary of the current patch state across all instances that this patch job affects.PatchJobs.PatchJobInstanceDetails Patch details for a VM instance.PatchJobs.PatchJobInstanceDetails.Builder Patch details for a VM instance.PatchJobs.PatchRollout Patch rollout configuration specifications.PatchJobs.PatchRollout.Builder Patch rollout configuration specifications.PatchJobs.WindowsUpdateSettings Windows patching is performed using the Windows Update Agent.PatchJobs.WindowsUpdateSettings.Builder Windows patching is performed using the Windows Update Agent.PatchJobs.YumSettings Yum patching is performed by executing `yum update`.PatchJobs.YumSettings.Builder Yum patching is performed by executing `yum update`.PatchJobs.ZypperSettings Zypper patching is performed by running `zypper patch`.PatchJobs.ZypperSettings.Builder Zypper patching is performed by running `zypper patch`.ProjectName ProjectName.Builder Builder for projects/{project}.