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("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);
}
Classes
Common
Common.FixedOrPercent
Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.FixedOrPercent
GuestPolicies
GuestPolicies.AptRepository
Represents a single Apt package repository. This repository is added to
a repo file that is stored at
/etc/apt/sources.list.d/google_osconfig.list.
Protobuf type google.cloud.osconfig.v1beta.AptRepository
GuestPolicies.AptRepository.Builder
Represents a single Apt package repository. This repository is added to
a repo file that is stored at
/etc/apt/sources.list.d/google_osconfig.list.
Protobuf type google.cloud.osconfig.v1beta.AptRepository
GuestPolicies.Assignment
An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.
Protobuf type google.cloud.osconfig.v1beta.Assignment
GuestPolicies.Assignment.Builder
An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.
Protobuf type google.cloud.osconfig.v1beta.Assignment
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".
Protobuf type google.cloud.osconfig.v1beta.Assignment.GroupLabel
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".
Protobuf type google.cloud.osconfig.v1beta.Assignment.GroupLabel
GuestPolicies.Assignment.OsType
Defines the criteria for selecting VM Instances by OS type.
Protobuf type google.cloud.osconfig.v1beta.Assignment.OsType
GuestPolicies.Assignment.OsType.Builder
Defines the criteria for selecting VM Instances by OS type.
Protobuf type google.cloud.osconfig.v1beta.Assignment.OsType
GuestPolicies.CreateGuestPolicyRequest
A request message for creating a guest policy.
Protobuf type google.cloud.osconfig.v1beta.CreateGuestPolicyRequest
GuestPolicies.CreateGuestPolicyRequest.Builder
A request message for creating a guest policy.
Protobuf type google.cloud.osconfig.v1beta.CreateGuestPolicyRequest
GuestPolicies.DeleteGuestPolicyRequest
A request message for deleting a guest policy.
Protobuf type google.cloud.osconfig.v1beta.DeleteGuestPolicyRequest
GuestPolicies.DeleteGuestPolicyRequest.Builder
A request message for deleting a guest policy.
Protobuf type google.cloud.osconfig.v1beta.DeleteGuestPolicyRequest
GuestPolicies.EffectiveGuestPolicy
The effective guest policy that applies to a VM instance.
Protobuf type google.cloud.osconfig.v1beta.EffectiveGuestPolicy
GuestPolicies.EffectiveGuestPolicy.Builder
The effective guest policy that applies to a VM instance.
Protobuf type google.cloud.osconfig.v1beta.EffectiveGuestPolicy
GuestPolicies.EffectiveGuestPolicy.SourcedPackage
A guest policy package including its source.
Protobuf type google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedPackage
GuestPolicies.EffectiveGuestPolicy.SourcedPackage.Builder
A guest policy package including its source.
Protobuf type google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedPackage
GuestPolicies.EffectiveGuestPolicy.SourcedPackageRepository
A guest policy package repository including its source.
Protobuf type
google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedPackageRepository
GuestPolicies.EffectiveGuestPolicy.SourcedPackageRepository.Builder
A guest policy package repository including its source.
Protobuf type
google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedPackageRepository
GuestPolicies.EffectiveGuestPolicy.SourcedSoftwareRecipe
A guest policy recipe including its source.
Protobuf type google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedSoftwareRecipe
GuestPolicies.EffectiveGuestPolicy.SourcedSoftwareRecipe.Builder
A guest policy recipe including its source.
Protobuf type
google.cloud.osconfig.v1beta.EffectiveGuestPolicy.SourcedSoftwareRecipe
GuestPolicies.GetGuestPolicyRequest
A request message for retrieving a guest policy.
Protobuf type google.cloud.osconfig.v1beta.GetGuestPolicyRequest
GuestPolicies.GetGuestPolicyRequest.Builder
A request message for retrieving a guest policy.
Protobuf type google.cloud.osconfig.v1beta.GetGuestPolicyRequest
GuestPolicies.GooRepository
Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.GooRepository
GuestPolicies.GooRepository.Builder
Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.GooRepository
GuestPolicies.GuestPolicy
An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.
Protobuf type google.cloud.osconfig.v1beta.GuestPolicy
GuestPolicies.GuestPolicy.Builder
An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.
Protobuf type google.cloud.osconfig.v1beta.GuestPolicy
GuestPolicies.ListGuestPoliciesRequest
A request message for listing guest policies.
Protobuf type google.cloud.osconfig.v1beta.ListGuestPoliciesRequest
GuestPolicies.ListGuestPoliciesRequest.Builder
A request message for listing guest policies.
Protobuf type google.cloud.osconfig.v1beta.ListGuestPoliciesRequest
GuestPolicies.ListGuestPoliciesResponse
A response message for listing guest policies.
Protobuf type google.cloud.osconfig.v1beta.ListGuestPoliciesResponse
GuestPolicies.ListGuestPoliciesResponse.Builder
A response message for listing guest policies.
Protobuf type google.cloud.osconfig.v1beta.ListGuestPoliciesResponse
GuestPolicies.LookupEffectiveGuestPolicyRequest
A request message for getting the effective guest policy assigned to the instance.
Protobuf type google.cloud.osconfig.v1beta.LookupEffectiveGuestPolicyRequest
GuestPolicies.LookupEffectiveGuestPolicyRequest.Builder
A request message for getting the effective guest policy assigned to the instance.
Protobuf type google.cloud.osconfig.v1beta.LookupEffectiveGuestPolicyRequest
GuestPolicies.Package
Package is a reference to the software package to be installed or removed.
The agent on the VM instance uses the system package manager to apply the
config.
These are the commands that the agent uses to install or remove
packages.
Apt
install: apt-get update && apt-get -y install package1 package2 package3
remove: apt-get -y remove package1 package2 package3
Yum
install: yum -y install package1 package2 package3
remove: yum -y remove package1 package2 package3
Zypper
install: zypper install package1 package2 package3
remove: zypper rm package1 package2
Googet
install: googet -noconfirm install package1 package2 package3
remove: googet -noconfirm remove package1 package2 package3
Protobuf type google.cloud.osconfig.v1beta.Package
GuestPolicies.Package.Builder
Package is a reference to the software package to be installed or removed.
The agent on the VM instance uses the system package manager to apply the
config.
These are the commands that the agent uses to install or remove
packages.
Apt
install: apt-get update && apt-get -y install package1 package2 package3
remove: apt-get -y remove package1 package2 package3
Yum
install: yum -y install package1 package2 package3
remove: yum -y remove package1 package2 package3
Zypper
install: zypper install package1 package2 package3
remove: zypper rm package1 package2
Googet
install: googet -noconfirm install package1 package2 package3
remove: googet -noconfirm remove package1 package2 package3
Protobuf type google.cloud.osconfig.v1beta.Package
GuestPolicies.PackageRepository
A package repository.
Protobuf type google.cloud.osconfig.v1beta.PackageRepository
GuestPolicies.PackageRepository.Builder
A package repository.
Protobuf type google.cloud.osconfig.v1beta.PackageRepository
GuestPolicies.SoftwareRecipe
A software recipe is a set of instructions for installing and configuring a
piece of software. It consists of a set of artifacts that are
downloaded, and a set of steps that install, configure, and/or update the
software.
Recipes support installing and updating software from artifacts in the
following formats:
Zip archive, Tar archive, Windows MSI, Debian package, and RPM package.
Additionally, recipes support executing a script (either defined in a file or
directly in this api) in bash, sh, cmd, and powershell.
Updating a software recipe
If a recipe is assigned to an instance and there is a recipe with the same
name but a lower version already installed and the assigned state
of the recipe is UPDATED, then the recipe is updated to
the new version.
Script Working Directories
Each script or execution step is run in its own temporary directory which
is deleted after completing the step.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe
GuestPolicies.SoftwareRecipe.Artifact
Specifies a resource to be used in the recipe.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact
GuestPolicies.SoftwareRecipe.Artifact.Builder
Specifies a resource to be used in the recipe.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact
GuestPolicies.SoftwareRecipe.Artifact.Gcs
Specifies an artifact available as a Google Cloud Storage object.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact.Gcs
GuestPolicies.SoftwareRecipe.Artifact.Gcs.Builder
Specifies an artifact available as a Google Cloud Storage object.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact.Gcs
GuestPolicies.SoftwareRecipe.Artifact.Remote
Specifies an artifact available via some URI.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact.Remote
GuestPolicies.SoftwareRecipe.Artifact.Remote.Builder
Specifies an artifact available via some URI.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact.Remote
GuestPolicies.SoftwareRecipe.Builder
A software recipe is a set of instructions for installing and configuring a
piece of software. It consists of a set of artifacts that are
downloaded, and a set of steps that install, configure, and/or update the
software.
Recipes support installing and updating software from artifacts in the
following formats:
Zip archive, Tar archive, Windows MSI, Debian package, and RPM package.
Additionally, recipes support executing a script (either defined in a file or
directly in this api) in bash, sh, cmd, and powershell.
Updating a software recipe
If a recipe is assigned to an instance and there is a recipe with the same
name but a lower version already installed and the assigned state
of the recipe is UPDATED, then the recipe is updated to
the new version.
Script Working Directories
Each script or execution step is run in its own temporary directory which
is deleted after completing the step.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe
GuestPolicies.SoftwareRecipe.Step
An action that can be taken as part of installing or updating a recipe.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step
GuestPolicies.SoftwareRecipe.Step.Builder
An action that can be taken as part of installing or updating a recipe.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step
GuestPolicies.SoftwareRecipe.Step.CopyFile
Copies the artifact to the specified path on the instance.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.CopyFile
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Copies the artifact to the specified path on the instance.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.CopyFile
GuestPolicies.SoftwareRecipe.Step.ExecFile
Executes an artifact or local file.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.ExecFile
GuestPolicies.SoftwareRecipe.Step.ExecFile.Builder
Executes an artifact or local file.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.ExecFile
GuestPolicies.SoftwareRecipe.Step.ExtractArchive
Extracts an archive of the type specified in the specified directory.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.ExtractArchive
GuestPolicies.SoftwareRecipe.Step.ExtractArchive.Builder
Extracts an archive of the type specified in the specified directory.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.ExtractArchive
GuestPolicies.SoftwareRecipe.Step.InstallDpkg
Installs a deb via dpkg.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallDpkg
GuestPolicies.SoftwareRecipe.Step.InstallDpkg.Builder
Installs a deb via dpkg.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallDpkg
GuestPolicies.SoftwareRecipe.Step.InstallMsi
Installs an MSI file.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallMsi
GuestPolicies.SoftwareRecipe.Step.InstallMsi.Builder
Installs an MSI file.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallMsi
GuestPolicies.SoftwareRecipe.Step.InstallRpm
Installs an rpm file via the rpm utility.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallRpm
GuestPolicies.SoftwareRecipe.Step.InstallRpm.Builder
Installs an rpm file via the rpm utility.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.InstallRpm
GuestPolicies.SoftwareRecipe.Step.RunScript
Runs a script through an interpreter.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.RunScript
GuestPolicies.SoftwareRecipe.Step.RunScript.Builder
Runs a script through an interpreter.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.RunScript
GuestPolicies.UpdateGuestPolicyRequest
A request message for updating a guest policy.
Protobuf type google.cloud.osconfig.v1beta.UpdateGuestPolicyRequest
GuestPolicies.UpdateGuestPolicyRequest.Builder
A request message for updating a guest policy.
Protobuf type google.cloud.osconfig.v1beta.UpdateGuestPolicyRequest
GuestPolicies.YumRepository
Represents a single Yum package repository. This repository is added to a
repo file that is stored at /etc/yum.repos.d/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.YumRepository
GuestPolicies.YumRepository.Builder
Represents a single Yum package repository. This repository is added to a
repo file that is stored at /etc/yum.repos.d/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.YumRepository
GuestPolicies.ZypperRepository
Represents a single Zypper package repository. This repository is added to a
repo file that is stored at /etc/zypp/repos.d/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.ZypperRepository
GuestPolicies.ZypperRepository.Builder
Represents a single Zypper package repository. This repository is added to a
repo file that is stored at /etc/zypp/repos.d/google_osconfig.repo.
Protobuf type google.cloud.osconfig.v1beta.ZypperRepository
GuestPolicyName
GuestPolicyName.Builder
Builder for projects/{project}/guestPolicies/{guest_policy}.
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("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);
}
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:
- 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.
- 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.
- 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.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
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.
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.v1beta.CreatePatchDeploymentRequest
PatchDeployments.CreatePatchDeploymentRequest.Builder
A request message for creating a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.CreatePatchDeploymentRequest
PatchDeployments.DeletePatchDeploymentRequest
A request message for deleting a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.DeletePatchDeploymentRequest
PatchDeployments.DeletePatchDeploymentRequest.Builder
A request message for deleting a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.DeletePatchDeploymentRequest
PatchDeployments.GetPatchDeploymentRequest
A request message for retrieving a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.GetPatchDeploymentRequest
PatchDeployments.GetPatchDeploymentRequest.Builder
A request message for retrieving a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.GetPatchDeploymentRequest
PatchDeployments.ListPatchDeploymentsRequest
A request message for listing patch deployments.
Protobuf type google.cloud.osconfig.v1beta.ListPatchDeploymentsRequest
PatchDeployments.ListPatchDeploymentsRequest.Builder
A request message for listing patch deployments.
Protobuf type google.cloud.osconfig.v1beta.ListPatchDeploymentsRequest
PatchDeployments.ListPatchDeploymentsResponse
A response message for listing patch deployments.
Protobuf type google.cloud.osconfig.v1beta.ListPatchDeploymentsResponse
PatchDeployments.ListPatchDeploymentsResponse.Builder
A response message for listing patch deployments.
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.MonthlySchedule
PatchDeployments.OneTimeSchedule
Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.
Protobuf type google.cloud.osconfig.v1beta.OneTimeSchedule
PatchDeployments.OneTimeSchedule.Builder
Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.PatchDeployment
PatchDeployments.PausePatchDeploymentRequest
A request message for pausing a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.PausePatchDeploymentRequest
PatchDeployments.PausePatchDeploymentRequest.Builder
A request message for pausing a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.PausePatchDeploymentRequest
PatchDeployments.RecurringSchedule
Sets the time for recurring patch deployments.
Protobuf type google.cloud.osconfig.v1beta.RecurringSchedule
PatchDeployments.RecurringSchedule.Builder
Sets the time for recurring patch deployments.
Protobuf type google.cloud.osconfig.v1beta.RecurringSchedule
PatchDeployments.ResumePatchDeploymentRequest
A request message for resuming a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.ResumePatchDeploymentRequest
PatchDeployments.ResumePatchDeploymentRequest.Builder
A request message for resuming a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.ResumePatchDeploymentRequest
PatchDeployments.UpdatePatchDeploymentRequest
A request message for updating a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.UpdatePatchDeploymentRequest
PatchDeployments.UpdatePatchDeploymentRequest.Builder
A request message for updating a patch deployment.
Protobuf type google.cloud.osconfig.v1beta.UpdatePatchDeploymentRequest
PatchDeployments.WeekDayOfMonth
Represents one week day in a month. An example is "the 4th Sunday".
Protobuf type google.cloud.osconfig.v1beta.WeekDayOfMonth
PatchDeployments.WeekDayOfMonth.Builder
Represents one week day in a month. An example is "the 4th Sunday".
Protobuf type google.cloud.osconfig.v1beta.WeekDayOfMonth
PatchDeployments.WeeklySchedule
Represents a weekly schedule.
Protobuf type google.cloud.osconfig.v1beta.WeeklySchedule
PatchDeployments.WeeklySchedule.Builder
Represents a weekly schedule.
Protobuf type google.cloud.osconfig.v1beta.WeeklySchedule
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.v1beta.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.v1beta.AptSettings
PatchJobs.CancelPatchJobRequest
Message for canceling a patch job.
Protobuf type google.cloud.osconfig.v1beta.CancelPatchJobRequest
PatchJobs.CancelPatchJobRequest.Builder
Message for canceling a patch job.
Protobuf type google.cloud.osconfig.v1beta.CancelPatchJobRequest
PatchJobs.ExecStep
A step that runs an executable for a PatchJob.
Protobuf type google.cloud.osconfig.v1beta.ExecStep
PatchJobs.ExecStep.Builder
A step that runs an executable for a PatchJob.
Protobuf type google.cloud.osconfig.v1beta.ExecStep
PatchJobs.ExecStepConfig
Common configurations for an ExecStep.
Protobuf type google.cloud.osconfig.v1beta.ExecStepConfig
PatchJobs.ExecStepConfig.Builder
Common configurations for an ExecStep.
Protobuf type google.cloud.osconfig.v1beta.ExecStepConfig
PatchJobs.ExecutePatchJobRequest
A request message to initiate patching across Compute Engine instances.
Protobuf type google.cloud.osconfig.v1beta.ExecutePatchJobRequest
PatchJobs.ExecutePatchJobRequest.Builder
A request message to initiate patching across Compute Engine instances.
Protobuf type google.cloud.osconfig.v1beta.ExecutePatchJobRequest
PatchJobs.GcsObject
Google Cloud Storage object representation.
Protobuf type google.cloud.osconfig.v1beta.GcsObject
PatchJobs.GcsObject.Builder
Google Cloud Storage object representation.
Protobuf type google.cloud.osconfig.v1beta.GcsObject
PatchJobs.GetPatchJobRequest
Request to get an active or completed patch job.
Protobuf type google.cloud.osconfig.v1beta.GetPatchJobRequest
PatchJobs.GetPatchJobRequest.Builder
Request to get an active or completed patch job.
Protobuf type google.cloud.osconfig.v1beta.GetPatchJobRequest
PatchJobs.GooSettings
Googet patching is performed by running googet update.
Protobuf type google.cloud.osconfig.v1beta.GooSettings
PatchJobs.GooSettings.Builder
Googet patching is performed by running googet update.
Protobuf type google.cloud.osconfig.v1beta.GooSettings
PatchJobs.Instance
Namespace for instance state enums.
Protobuf type google.cloud.osconfig.v1beta.Instance
PatchJobs.Instance.Builder
Namespace for instance state enums.
Protobuf type google.cloud.osconfig.v1beta.Instance
PatchJobs.ListPatchJobInstanceDetailsRequest
Request to list details for all instances that are part of a patch job.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsRequest
PatchJobs.ListPatchJobInstanceDetailsRequest.Builder
Request to list details for all instances that are part of a patch job.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsRequest
PatchJobs.ListPatchJobInstanceDetailsResponse
A response message for listing the instances details for a patch job.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsResponse
PatchJobs.ListPatchJobInstanceDetailsResponse.Builder
A response message for listing the instances details for a patch job.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsResponse
PatchJobs.ListPatchJobsRequest
A request message for listing patch jobs.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobsRequest
PatchJobs.ListPatchJobsRequest.Builder
A request message for listing patch jobs.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobsRequest
PatchJobs.ListPatchJobsResponse
A response message for listing patch jobs.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobsResponse
PatchJobs.ListPatchJobsResponse.Builder
A response message for listing patch jobs.
Protobuf type google.cloud.osconfig.v1beta.ListPatchJobsResponse
PatchJobs.PatchConfig
Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.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.v1beta.PatchInstanceFilter
PatchJobs.PatchInstanceFilter.GroupLabel
Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
Protobuf type google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel
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".
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.PatchRollout
PatchJobs.WindowsUpdateSettings
Windows patching is performed using the Windows Update Agent.
Protobuf type google.cloud.osconfig.v1beta.WindowsUpdateSettings
PatchJobs.WindowsUpdateSettings.Builder
Windows patching is performed using the Windows Update Agent.
Protobuf type google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.ZypperSettings
ProjectName
ProjectName.Builder
Builder for projects/{project}.
Interfaces
Common.FixedOrPercentOrBuilder
GuestPolicies.AptRepositoryOrBuilder
GuestPolicies.Assignment.GroupLabelOrBuilder
GuestPolicies.Assignment.OsTypeOrBuilder
GuestPolicies.AssignmentOrBuilder
GuestPolicies.CreateGuestPolicyRequestOrBuilder
GuestPolicies.DeleteGuestPolicyRequestOrBuilder
GuestPolicies.EffectiveGuestPolicy.SourcedPackageOrBuilder
GuestPolicies.EffectiveGuestPolicy.SourcedPackageRepositoryOrBuilder
GuestPolicies.EffectiveGuestPolicy.SourcedSoftwareRecipeOrBuilder
GuestPolicies.EffectiveGuestPolicyOrBuilder
GuestPolicies.GetGuestPolicyRequestOrBuilder
GuestPolicies.GooRepositoryOrBuilder
GuestPolicies.GuestPolicyOrBuilder
GuestPolicies.ListGuestPoliciesRequestOrBuilder
GuestPolicies.ListGuestPoliciesResponseOrBuilder
GuestPolicies.LookupEffectiveGuestPolicyRequestOrBuilder
GuestPolicies.PackageOrBuilder
GuestPolicies.PackageRepositoryOrBuilder
GuestPolicies.SoftwareRecipe.Artifact.GcsOrBuilder
GuestPolicies.SoftwareRecipe.Artifact.RemoteOrBuilder
GuestPolicies.SoftwareRecipe.ArtifactOrBuilder
GuestPolicies.SoftwareRecipe.Step.CopyFileOrBuilder
GuestPolicies.SoftwareRecipe.Step.ExecFileOrBuilder
GuestPolicies.SoftwareRecipe.Step.ExtractArchiveOrBuilder
GuestPolicies.SoftwareRecipe.Step.InstallDpkgOrBuilder
GuestPolicies.SoftwareRecipe.Step.InstallMsiOrBuilder
GuestPolicies.SoftwareRecipe.Step.InstallRpmOrBuilder
GuestPolicies.SoftwareRecipe.Step.RunScriptOrBuilder
GuestPolicies.SoftwareRecipe.StepOrBuilder
GuestPolicies.SoftwareRecipeOrBuilder
GuestPolicies.UpdateGuestPolicyRequestOrBuilder
GuestPolicies.YumRepositoryOrBuilder
GuestPolicies.ZypperRepositoryOrBuilder
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
Enums
Common.FixedOrPercent.ModeCase
GuestPolicies.AptRepository.ArchiveType
Type of archive.
Protobuf enum google.cloud.osconfig.v1beta.AptRepository.ArchiveType
GuestPolicies.DesiredState
The desired state that the OS Config agent maintains on the VM instance.
Protobuf enum google.cloud.osconfig.v1beta.DesiredState
GuestPolicies.Package.Manager
Types of package managers that may be used to manage this package.
Protobuf enum google.cloud.osconfig.v1beta.Package.Manager
GuestPolicies.PackageRepository.RepositoryCase
GuestPolicies.SoftwareRecipe.Artifact.ArtifactCase
GuestPolicies.SoftwareRecipe.Step.ExecFile.LocationTypeCase
GuestPolicies.SoftwareRecipe.Step.ExtractArchive.ArchiveType
Specifying the type of archive.
Protobuf enum
google.cloud.osconfig.v1beta.SoftwareRecipe.Step.ExtractArchive.ArchiveType
GuestPolicies.SoftwareRecipe.Step.RunScript.Interpreter
The interpreter used to execute a script.
Protobuf enum
google.cloud.osconfig.v1beta.SoftwareRecipe.Step.RunScript.Interpreter
GuestPolicies.SoftwareRecipe.Step.StepCase
PatchDeployments.MonthlySchedule.DayOfMonthCase
PatchDeployments.PatchDeployment.ScheduleCase
PatchDeployments.PatchDeployment.State
Represents state of patch peployment.
Protobuf enum google.cloud.osconfig.v1beta.PatchDeployment.State
PatchDeployments.RecurringSchedule.Frequency
Specifies the frequency of the recurring patch deployments.
Protobuf enum google.cloud.osconfig.v1beta.RecurringSchedule.Frequency
PatchDeployments.RecurringSchedule.ScheduleConfigCase
PatchJobs.AptSettings.Type
Apt patch type.
Protobuf enum google.cloud.osconfig.v1beta.AptSettings.Type
PatchJobs.ExecStepConfig.ExecutableCase
PatchJobs.ExecStepConfig.Interpreter
The interpreter used to execute the a file.
Protobuf enum google.cloud.osconfig.v1beta.ExecStepConfig.Interpreter
PatchJobs.Instance.PatchState
Patch state of an instance.
Protobuf enum google.cloud.osconfig.v1beta.Instance.PatchState
PatchJobs.PatchConfig.RebootConfig
Post-patch reboot settings.
Protobuf enum google.cloud.osconfig.v1beta.PatchConfig.RebootConfig
PatchJobs.PatchJob.State
Enumeration of the various states a patch job passes through as it executes.
Protobuf enum google.cloud.osconfig.v1beta.PatchJob.State
PatchJobs.PatchRollout.Mode
Type of the rollout.
Protobuf enum google.cloud.osconfig.v1beta.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.v1beta.WindowsUpdateSettings.Classification