chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google-apis-osconfig_v1beta/lib/google/apis/osconfig_v1beta/classes.rb

2772 lines
114 KiB
Ruby
Raw Blame History

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module OsconfigV1beta
# 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`.
class AptRepository
include Google::Apis::Core::Hashable
# Type of archive files in this repository. The default behavior is DEB.
# Corresponds to the JSON property `archiveType`
# @return [String]
attr_accessor :archive_type
# Required. List of components for this repository. Must contain at least one
# item.
# Corresponds to the JSON property `components`
# @return [Array<String>]
attr_accessor :components
# Required. Distribution of this repository.
# Corresponds to the JSON property `distribution`
# @return [String]
attr_accessor :distribution
# URI of the key file for this repository. The agent maintains a keyring at `/
# etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in
# any applied guest policy.
# Corresponds to the JSON property `gpgKey`
# @return [String]
attr_accessor :gpg_key
# Required. URI for this repository.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@archive_type = args[:archive_type] if args.key?(:archive_type)
@components = args[:components] if args.key?(:components)
@distribution = args[:distribution] if args.key?(:distribution)
@gpg_key = args[:gpg_key] if args.key?(:gpg_key)
@uri = args[:uri] if args.key?(:uri)
end
end
# Apt patching is completed by executing `apt-get update && apt-get upgrade`.
# Additional options can be set to control how this is executed.
class AptSettings
include Google::Apis::Core::Hashable
# List of packages to exclude from update. These packages will be excluded
# Corresponds to the JSON property `excludes`
# @return [Array<String>]
attr_accessor :excludes
# An exclusive list of packages to be updated. These are the only packages that
# will be updated. If these packages are not installed, they will be ignored.
# This field cannot be specified with any other patch configuration fields.
# Corresponds to the JSON property `exclusivePackages`
# @return [Array<String>]
attr_accessor :exclusive_packages
# By changing the type to DIST, the patching is performed using `apt-get dist-
# upgrade` instead.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@excludes = args[:excludes] if args.key?(:excludes)
@exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages)
@type = args[:type] if args.key?(:type)
end
end
# 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.
class Assignment
include Google::Apis::Core::Hashable
# Targets instances matching at least one of these label sets. This allows an
# assignment to target disparate groups, for example "env=prod or env=staging".
# Corresponds to the JSON property `groupLabels`
# @return [Array<Google::Apis::OsconfigV1beta::AssignmentGroupLabel>]
attr_accessor :group_labels
# Targets VM instances whose name starts with one of these prefixes. Like labels,
# this is another way to group VM instances when targeting configs, for example
# prefix="prod-". Only supported for project-level policies.
# Corresponds to the JSON property `instanceNamePrefixes`
# @return [Array<String>]
attr_accessor :instance_name_prefixes
# Targets any of the instances specified. Instances are specified by their URI
# in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is
# uncommon and is supported to facilitate the management of changes by the
# instance or to target specific VM instances for development and testing. Only
# supported for project-level policies and must reference instances within this
# project.
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# Targets VM instances matching at least one of the following OS types. VM
# instances must match all supplied criteria for a given OsType to be included.
# Corresponds to the JSON property `osTypes`
# @return [Array<Google::Apis::OsconfigV1beta::AssignmentOsType>]
attr_accessor :os_types
# Targets instances in any of these zones. Leave empty to target instances in
# any zone. Zonal targeting is uncommon and is supported to facilitate the
# management of changes by zone.
# Corresponds to the JSON property `zones`
# @return [Array<String>]
attr_accessor :zones
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@group_labels = args[:group_labels] if args.key?(:group_labels)
@instance_name_prefixes = args[:instance_name_prefixes] if args.key?(:instance_name_prefixes)
@instances = args[:instances] if args.key?(:instances)
@os_types = args[:os_types] if args.key?(:os_types)
@zones = args[:zones] if args.key?(:zones)
end
end
# Represents a group of VM intances that can be identified as having all these
# labels, for example "env=prod and app=web".
class AssignmentGroupLabel
include Google::Apis::Core::Hashable
# Google Compute Engine instance labels that must be present for an instance to
# be included in this assignment group.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@labels = args[:labels] if args.key?(:labels)
end
end
# Defines the criteria for selecting VM Instances by OS type.
class AssignmentOsType
include Google::Apis::Core::Hashable
# Targets VM instances with OS Inventory enabled and having the following OS
# architecture.
# Corresponds to the JSON property `osArchitecture`
# @return [String]
attr_accessor :os_architecture
# Targets VM instances with OS Inventory enabled and having the following OS
# short name, for example "debian" or "windows".
# Corresponds to the JSON property `osShortName`
# @return [String]
attr_accessor :os_short_name
# Targets VM instances with OS Inventory enabled and having the following
# following OS version.
# Corresponds to the JSON property `osVersion`
# @return [String]
attr_accessor :os_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@os_architecture = args[:os_architecture] if args.key?(:os_architecture)
@os_short_name = args[:os_short_name] if args.key?(:os_short_name)
@os_version = args[:os_version] if args.key?(:os_version)
end
end
# Message for canceling a patch job.
class CancelPatchJobRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# The effective guest policy that applies to a VM instance.
class EffectiveGuestPolicy
include Google::Apis::Core::Hashable
# List of package repository configurations assigned to the VM instance.
# Corresponds to the JSON property `packageRepositories`
# @return [Array<Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackageRepository>]
attr_accessor :package_repositories
# List of package configurations assigned to the VM instance.
# Corresponds to the JSON property `packages`
# @return [Array<Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedPackage>]
attr_accessor :packages
# List of recipes assigned to the VM instance.
# Corresponds to the JSON property `softwareRecipes`
# @return [Array<Google::Apis::OsconfigV1beta::EffectiveGuestPolicySourcedSoftwareRecipe>]
attr_accessor :software_recipes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@package_repositories = args[:package_repositories] if args.key?(:package_repositories)
@packages = args[:packages] if args.key?(:packages)
@software_recipes = args[:software_recipes] if args.key?(:software_recipes)
end
end
# A guest policy package including its source.
class EffectiveGuestPolicySourcedPackage
include Google::Apis::Core::Hashable
# 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`
# Corresponds to the JSON property `package`
# @return [Google::Apis::OsconfigV1beta::Package]
attr_accessor :package
# Name of the guest policy providing this config.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@package = args[:package] if args.key?(:package)
@source = args[:source] if args.key?(:source)
end
end
# A guest policy package repository including its source.
class EffectiveGuestPolicySourcedPackageRepository
include Google::Apis::Core::Hashable
# A package repository.
# Corresponds to the JSON property `packageRepository`
# @return [Google::Apis::OsconfigV1beta::PackageRepository]
attr_accessor :package_repository
# Name of the guest policy providing this config.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@package_repository = args[:package_repository] if args.key?(:package_repository)
@source = args[:source] if args.key?(:source)
end
end
# A guest policy recipe including its source.
class EffectiveGuestPolicySourcedSoftwareRecipe
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `softwareRecipe`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipe]
attr_accessor :software_recipe
# Name of the guest policy providing this config.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@software_recipe = args[:software_recipe] if args.key?(:software_recipe)
@source = args[:source] if args.key?(:source)
end
end
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A step that runs an executable for a PatchJob.
class ExecStep
include Google::Apis::Core::Hashable
# Common configurations for an ExecStep.
# Corresponds to the JSON property `linuxExecStepConfig`
# @return [Google::Apis::OsconfigV1beta::ExecStepConfig]
attr_accessor :linux_exec_step_config
# Common configurations for an ExecStep.
# Corresponds to the JSON property `windowsExecStepConfig`
# @return [Google::Apis::OsconfigV1beta::ExecStepConfig]
attr_accessor :windows_exec_step_config
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@linux_exec_step_config = args[:linux_exec_step_config] if args.key?(:linux_exec_step_config)
@windows_exec_step_config = args[:windows_exec_step_config] if args.key?(:windows_exec_step_config)
end
end
# Common configurations for an ExecStep.
class ExecStepConfig
include Google::Apis::Core::Hashable
# Defaults to [0]. A list of possible return values that the execution can
# return to indicate a success.
# Corresponds to the JSON property `allowedSuccessCodes`
# @return [Array<Fixnum>]
attr_accessor :allowed_success_codes
# Google Cloud Storage object representation.
# Corresponds to the JSON property `gcsObject`
# @return [Google::Apis::OsconfigV1beta::GcsObject]
attr_accessor :gcs_object
# The script interpreter to use to run the script. If no interpreter is
# specified the script will be executed directly, which will likely only succeed
# for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\
# )).
# Corresponds to the JSON property `interpreter`
# @return [String]
attr_accessor :interpreter
# An absolute path to the executable on the VM.
# Corresponds to the JSON property `localPath`
# @return [String]
attr_accessor :local_path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes)
@gcs_object = args[:gcs_object] if args.key?(:gcs_object)
@interpreter = args[:interpreter] if args.key?(:interpreter)
@local_path = args[:local_path] if args.key?(:local_path)
end
end
# A request message to initiate patching across Compute Engine instances.
class ExecutePatchJobRequest
include Google::Apis::Core::Hashable
# Description of the patch job. Length of the description is limited to 1024
# characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Display name for this patch job. This does not have to be unique.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# If this patch is a dry-run only, instances are contacted but will do nothing.
# Corresponds to the JSON property `dryRun`
# @return [Boolean]
attr_accessor :dry_run
alias_method :dry_run?, :dry_run
# Duration of the patch job. After the duration ends, the patch job times out.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# 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.
# Corresponds to the JSON property `instanceFilter`
# @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter]
attr_accessor :instance_filter
# Patch configuration specifications. Contains details on how to apply the patch(
# es) to a VM instance.
# Corresponds to the JSON property `patchConfig`
# @return [Google::Apis::OsconfigV1beta::PatchConfig]
attr_accessor :patch_config
# Patch rollout configuration specifications. Contains details on the
# concurrency control when applying patch(es) to all targeted VMs.
# Corresponds to the JSON property `rollout`
# @return [Google::Apis::OsconfigV1beta::PatchRollout]
attr_accessor :rollout
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@display_name = args[:display_name] if args.key?(:display_name)
@dry_run = args[:dry_run] if args.key?(:dry_run)
@duration = args[:duration] if args.key?(:duration)
@instance_filter = args[:instance_filter] if args.key?(:instance_filter)
@patch_config = args[:patch_config] if args.key?(:patch_config)
@rollout = args[:rollout] if args.key?(:rollout)
end
end
# Message encapsulating a value that can be either absolute ("fixed") or
# relative ("percent") to a value.
class FixedOrPercent
include Google::Apis::Core::Hashable
# Specifies a fixed value.
# Corresponds to the JSON property `fixed`
# @return [Fixnum]
attr_accessor :fixed
# Specifies the relative value defined as a percentage, which will be multiplied
# by a reference value.
# Corresponds to the JSON property `percent`
# @return [Fixnum]
attr_accessor :percent
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fixed = args[:fixed] if args.key?(:fixed)
@percent = args[:percent] if args.key?(:percent)
end
end
# Google Cloud Storage object representation.
class GcsObject
include Google::Apis::Core::Hashable
# Required. Bucket of the Google Cloud Storage object.
# Corresponds to the JSON property `bucket`
# @return [String]
attr_accessor :bucket
# Required. Generation number of the Google Cloud Storage object. This is used
# to ensure that the ExecStep specified by this PatchJob does not change.
# Corresponds to the JSON property `generationNumber`
# @return [Fixnum]
attr_accessor :generation_number
# Required. Name of the Google Cloud Storage object.
# Corresponds to the JSON property `object`
# @return [String]
attr_accessor :object
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket = args[:bucket] if args.key?(:bucket)
@generation_number = args[:generation_number] if args.key?(:generation_number)
@object = args[:object] if args.key?(:object)
end
end
# Represents a Goo package repository. These is added to a repo file that is
# stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
class GooRepository
include Google::Apis::Core::Hashable
# Required. The name of the repository.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. The url of the repository.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@url = args[:url] if args.key?(:url)
end
end
# Googet patching is performed by running `googet update`.
class GooSettings
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# 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.
class GuestPolicy
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `assignment`
# @return [Google::Apis::OsconfigV1beta::Assignment]
attr_accessor :assignment
# Output only. Time this guest policy was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Description of the guest policy. Length of the description is limited to 1024
# characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The etag for this guest policy. If this is provided on update, it must match
# the server's etag.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Required. Unique name of the resource in this project using one of the
# following forms: `projects/`project_number`/guestPolicies/`guest_policy_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A list of package repositories to configure on the VM instance. This is done
# before any other configs are applied so they can use these repos. Package
# repositories are only configured if the corresponding package manager(s) are
# available.
# Corresponds to the JSON property `packageRepositories`
# @return [Array<Google::Apis::OsconfigV1beta::PackageRepository>]
attr_accessor :package_repositories
# The software packages to be managed by this policy.
# Corresponds to the JSON property `packages`
# @return [Array<Google::Apis::OsconfigV1beta::Package>]
attr_accessor :packages
# A list of Recipes to install on the VM instance.
# Corresponds to the JSON property `recipes`
# @return [Array<Google::Apis::OsconfigV1beta::SoftwareRecipe>]
attr_accessor :recipes
# Output only. Last time this guest policy was updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@assignment = args[:assignment] if args.key?(:assignment)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@etag = args[:etag] if args.key?(:etag)
@name = args[:name] if args.key?(:name)
@package_repositories = args[:package_repositories] if args.key?(:package_repositories)
@packages = args[:packages] if args.key?(:packages)
@recipes = args[:recipes] if args.key?(:recipes)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# The inventory details of a VM.
class Inventory
include Google::Apis::Core::Hashable
# Inventory items related to the VM keyed by an opaque unique identifier for
# each inventory item. The identifier is unique to each distinct and addressable
# inventory item and will change, when there is a new package version.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::OsconfigV1beta::InventoryItem>]
attr_accessor :items
# Operating system information for the VM.
# Corresponds to the JSON property `osInfo`
# @return [Google::Apis::OsconfigV1beta::InventoryOsInfo]
attr_accessor :os_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] if args.key?(:items)
@os_info = args[:os_info] if args.key?(:os_info)
end
end
# A single piece of inventory on a VM.
class InventoryItem
include Google::Apis::Core::Hashable
# Software package information of the operating system.
# Corresponds to the JSON property `availablePackage`
# @return [Google::Apis::OsconfigV1beta::InventorySoftwarePackage]
attr_accessor :available_package
# When this inventory item was first detected.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Identifier for this item, unique across items for this VM.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Software package information of the operating system.
# Corresponds to the JSON property `installedPackage`
# @return [Google::Apis::OsconfigV1beta::InventorySoftwarePackage]
attr_accessor :installed_package
# The origin of this inventory item.
# Corresponds to the JSON property `originType`
# @return [String]
attr_accessor :origin_type
# The specific type of inventory, correlating to its specific details.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# When this inventory item was last modified.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@available_package = args[:available_package] if args.key?(:available_package)
@create_time = args[:create_time] if args.key?(:create_time)
@id = args[:id] if args.key?(:id)
@installed_package = args[:installed_package] if args.key?(:installed_package)
@origin_type = args[:origin_type] if args.key?(:origin_type)
@type = args[:type] if args.key?(:type)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Operating system information for the VM.
class InventoryOsInfo
include Google::Apis::Core::Hashable
# The system architecture of the operating system.
# Corresponds to the JSON property `architecture`
# @return [String]
attr_accessor :architecture
# The VM hostname.
# Corresponds to the JSON property `hostname`
# @return [String]
attr_accessor :hostname
# The kernel release of the operating system.
# Corresponds to the JSON property `kernelRelease`
# @return [String]
attr_accessor :kernel_release
# The kernel version of the operating system.
# Corresponds to the JSON property `kernelVersion`
# @return [String]
attr_accessor :kernel_version
# The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft
# Window Server 2019 Datacenter'.
# Corresponds to the JSON property `longName`
# @return [String]
attr_accessor :long_name
# The current version of the OS Config agent running on the VM.
# Corresponds to the JSON property `osconfigAgentVersion`
# @return [String]
attr_accessor :osconfig_agent_version
# The operating system short name. For example, 'windows' or 'debian'.
# Corresponds to the JSON property `shortName`
# @return [String]
attr_accessor :short_name
# The version of the operating system.
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@architecture = args[:architecture] if args.key?(:architecture)
@hostname = args[:hostname] if args.key?(:hostname)
@kernel_release = args[:kernel_release] if args.key?(:kernel_release)
@kernel_version = args[:kernel_version] if args.key?(:kernel_version)
@long_name = args[:long_name] if args.key?(:long_name)
@osconfig_agent_version = args[:osconfig_agent_version] if args.key?(:osconfig_agent_version)
@short_name = args[:short_name] if args.key?(:short_name)
@version = args[:version] if args.key?(:version)
end
end
# Software package information of the operating system.
class InventorySoftwarePackage
include Google::Apis::Core::Hashable
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
# Corresponds to the JSON property `aptPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryVersionedPackage]
attr_accessor :apt_package
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
# Corresponds to the JSON property `cosPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryVersionedPackage]
attr_accessor :cos_package
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
# Corresponds to the JSON property `googetPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryVersionedPackage]
attr_accessor :googet_package
# 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
# Corresponds to the JSON property `qfePackage`
# @return [Google::Apis::OsconfigV1beta::InventoryWindowsQuickFixEngineeringPackage]
attr_accessor :qfe_package
# 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.
# Corresponds to the JSON property `wuaPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryWindowsUpdatePackage]
attr_accessor :wua_package
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
# Corresponds to the JSON property `yumPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryVersionedPackage]
attr_accessor :yum_package
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
# Corresponds to the JSON property `zypperPackage`
# @return [Google::Apis::OsconfigV1beta::InventoryVersionedPackage]
attr_accessor :zypper_package
# Details related to a Zypper Patch.
# Corresponds to the JSON property `zypperPatch`
# @return [Google::Apis::OsconfigV1beta::InventoryZypperPatch]
attr_accessor :zypper_patch
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apt_package = args[:apt_package] if args.key?(:apt_package)
@cos_package = args[:cos_package] if args.key?(:cos_package)
@googet_package = args[:googet_package] if args.key?(:googet_package)
@qfe_package = args[:qfe_package] if args.key?(:qfe_package)
@wua_package = args[:wua_package] if args.key?(:wua_package)
@yum_package = args[:yum_package] if args.key?(:yum_package)
@zypper_package = args[:zypper_package] if args.key?(:zypper_package)
@zypper_patch = args[:zypper_patch] if args.key?(:zypper_patch)
end
end
# Information related to the a standard versioned package. This includes package
# info for APT, Yum, Zypper, and Googet package managers.
class InventoryVersionedPackage
include Google::Apis::Core::Hashable
# The system architecture this package is intended for.
# Corresponds to the JSON property `architecture`
# @return [String]
attr_accessor :architecture
# The name of the package.
# Corresponds to the JSON property `packageName`
# @return [String]
attr_accessor :package_name
# The version of the package.
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@architecture = args[:architecture] if args.key?(:architecture)
@package_name = args[:package_name] if args.key?(:package_name)
@version = args[:version] if args.key?(:version)
end
end
# 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
class InventoryWindowsQuickFixEngineeringPackage
include Google::Apis::Core::Hashable
# A short textual description of the QFE update.
# Corresponds to the JSON property `caption`
# @return [String]
attr_accessor :caption
# A textual description of the QFE update.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Unique identifier associated with a particular QFE update.
# Corresponds to the JSON property `hotFixId`
# @return [String]
attr_accessor :hot_fix_id
# Date that the QFE update was installed. Mapped from installed_on field.
# Corresponds to the JSON property `installTime`
# @return [String]
attr_accessor :install_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@caption = args[:caption] if args.key?(:caption)
@description = args[:description] if args.key?(:description)
@hot_fix_id = args[:hot_fix_id] if args.key?(:hot_fix_id)
@install_time = args[:install_time] if args.key?(:install_time)
end
end
# 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.
class InventoryWindowsUpdatePackage
include Google::Apis::Core::Hashable
# The categories that are associated with this update package.
# Corresponds to the JSON property `categories`
# @return [Array<Google::Apis::OsconfigV1beta::InventoryWindowsUpdatePackageWindowsUpdateCategory>]
attr_accessor :categories
# The localized description of the update package.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# A collection of Microsoft Knowledge Base article IDs that are associated with
# the update package.
# Corresponds to the JSON property `kbArticleIds`
# @return [Array<String>]
attr_accessor :kb_article_ids
# The last published date of the update, in (UTC) date and time.
# Corresponds to the JSON property `lastDeploymentChangeTime`
# @return [String]
attr_accessor :last_deployment_change_time
# A collection of URLs that provide more information about the update package.
# Corresponds to the JSON property `moreInfoUrls`
# @return [Array<String>]
attr_accessor :more_info_urls
# The revision number of this update package.
# Corresponds to the JSON property `revisionNumber`
# @return [Fixnum]
attr_accessor :revision_number
# A hyperlink to the language-specific support information for the update.
# Corresponds to the JSON property `supportUrl`
# @return [String]
attr_accessor :support_url
# The localized title of the update package.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Gets the identifier of an update package. Stays the same across revisions.
# Corresponds to the JSON property `updateId`
# @return [String]
attr_accessor :update_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@categories = args[:categories] if args.key?(:categories)
@description = args[:description] if args.key?(:description)
@kb_article_ids = args[:kb_article_ids] if args.key?(:kb_article_ids)
@last_deployment_change_time = args[:last_deployment_change_time] if args.key?(:last_deployment_change_time)
@more_info_urls = args[:more_info_urls] if args.key?(:more_info_urls)
@revision_number = args[:revision_number] if args.key?(:revision_number)
@support_url = args[:support_url] if args.key?(:support_url)
@title = args[:title] if args.key?(:title)
@update_id = args[:update_id] if args.key?(:update_id)
end
end
# Categories specified by the Windows Update.
class InventoryWindowsUpdatePackageWindowsUpdateCategory
include Google::Apis::Core::Hashable
# The identifier of the windows update category.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The name of the windows update category.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
end
end
# Details related to a Zypper Patch.
class InventoryZypperPatch
include Google::Apis::Core::Hashable
# The category of the patch.
# Corresponds to the JSON property `category`
# @return [String]
attr_accessor :category
# The name of the patch.
# Corresponds to the JSON property `patchName`
# @return [String]
attr_accessor :patch_name
# The severity specified for this patch
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Any summary information provided about this patch.
# Corresponds to the JSON property `summary`
# @return [String]
attr_accessor :summary
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@category = args[:category] if args.key?(:category)
@patch_name = args[:patch_name] if args.key?(:patch_name)
@severity = args[:severity] if args.key?(:severity)
@summary = args[:summary] if args.key?(:summary)
end
end
# A response message for listing guest policies.
class ListGuestPoliciesResponse
include Google::Apis::Core::Hashable
# The list of GuestPolicies.
# Corresponds to the JSON property `guestPolicies`
# @return [Array<Google::Apis::OsconfigV1beta::GuestPolicy>]
attr_accessor :guest_policies
# A pagination token that can be used to get the next page of guest policies.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@guest_policies = args[:guest_policies] if args.key?(:guest_policies)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# A response message for listing patch deployments.
class ListPatchDeploymentsResponse
include Google::Apis::Core::Hashable
# A pagination token that can be used to get the next page of patch deployments.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of patch deployments.
# Corresponds to the JSON property `patchDeployments`
# @return [Array<Google::Apis::OsconfigV1beta::PatchDeployment>]
attr_accessor :patch_deployments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@patch_deployments = args[:patch_deployments] if args.key?(:patch_deployments)
end
end
# A response message for listing the instances details for a patch job.
class ListPatchJobInstanceDetailsResponse
include Google::Apis::Core::Hashable
# A pagination token that can be used to get the next page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of instance status.
# Corresponds to the JSON property `patchJobInstanceDetails`
# @return [Array<Google::Apis::OsconfigV1beta::PatchJobInstanceDetails>]
attr_accessor :patch_job_instance_details
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@patch_job_instance_details = args[:patch_job_instance_details] if args.key?(:patch_job_instance_details)
end
end
# A response message for listing patch jobs.
class ListPatchJobsResponse
include Google::Apis::Core::Hashable
# A pagination token that can be used to get the next page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of patch jobs.
# Corresponds to the JSON property `patchJobs`
# @return [Array<Google::Apis::OsconfigV1beta::PatchJob>]
attr_accessor :patch_jobs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@patch_jobs = args[:patch_jobs] if args.key?(:patch_jobs)
end
end
# A request message for getting the effective guest policy assigned to the
# instance.
class LookupEffectiveGuestPolicyRequest
include Google::Apis::Core::Hashable
# Architecture of OS running on the instance. The OS Config agent only provides
# this field for targeting if OS Inventory is enabled for that instance.
# Corresponds to the JSON property `osArchitecture`
# @return [String]
attr_accessor :os_architecture
# Short name of the OS running on the instance. The OS Config agent only
# provides this field for targeting if OS Inventory is enabled for that instance.
# Corresponds to the JSON property `osShortName`
# @return [String]
attr_accessor :os_short_name
# Version of the OS running on the instance. The OS Config agent only provides
# this field for targeting if OS Inventory is enabled for that VM instance.
# Corresponds to the JSON property `osVersion`
# @return [String]
attr_accessor :os_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@os_architecture = args[:os_architecture] if args.key?(:os_architecture)
@os_short_name = args[:os_short_name] if args.key?(:os_short_name)
@os_version = args[:os_version] if args.key?(:os_version)
end
end
# 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".
class MonthlySchedule
include Google::Apis::Core::Hashable
# Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1
# indicates the last day of the month. Months without the target day will be
# skipped. For example, a schedule to run "every month on the 31st" will not run
# in February, April, June, etc.
# Corresponds to the JSON property `monthDay`
# @return [Fixnum]
attr_accessor :month_day
# Represents one week day in a month. An example is "the 4th Sunday".
# Corresponds to the JSON property `weekDayOfMonth`
# @return [Google::Apis::OsconfigV1beta::WeekDayOfMonth]
attr_accessor :week_day_of_month
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@month_day = args[:month_day] if args.key?(:month_day)
@week_day_of_month = args[:week_day_of_month] if args.key?(:week_day_of_month)
end
end
# Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https:
# //www.ietf.org/rfc/rfc3339.txt) text format.
class OneTimeSchedule
include Google::Apis::Core::Hashable
# Required. The desired patch job execution time.
# Corresponds to the JSON property `executeTime`
# @return [String]
attr_accessor :execute_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@execute_time = args[:execute_time] if args.key?(:execute_time)
end
end
# 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`
class Package
include Google::Apis::Core::Hashable
# The desired_state the agent should maintain for this package. The default is
# to ensure the package is installed.
# Corresponds to the JSON property `desiredState`
# @return [String]
attr_accessor :desired_state
# Type of package manager that can be used to install this package. If a system
# does not have the package manager, the package is not installed or removed no
# error message is returned. By default, or if you specify `ANY`, the agent
# attempts to install and remove this package using the default package manager.
# This is useful when creating a policy that applies to different types of
# systems. The default behavior is ANY.
# Corresponds to the JSON property `manager`
# @return [String]
attr_accessor :manager
# Required. The name of the package. A package is uniquely identified for
# conflict validation by checking the package name and the manager(s) that the
# package targets.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@desired_state = args[:desired_state] if args.key?(:desired_state)
@manager = args[:manager] if args.key?(:manager)
@name = args[:name] if args.key?(:name)
end
end
# A package repository.
class PackageRepository
include Google::Apis::Core::Hashable
# 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`.
# Corresponds to the JSON property `apt`
# @return [Google::Apis::OsconfigV1beta::AptRepository]
attr_accessor :apt
# Represents a Goo package repository. These is added to a repo file that is
# stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
# Corresponds to the JSON property `goo`
# @return [Google::Apis::OsconfigV1beta::GooRepository]
attr_accessor :goo
# 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`.
# Corresponds to the JSON property `yum`
# @return [Google::Apis::OsconfigV1beta::YumRepository]
attr_accessor :yum
# 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`.
# Corresponds to the JSON property `zypper`
# @return [Google::Apis::OsconfigV1beta::ZypperRepository]
attr_accessor :zypper
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apt = args[:apt] if args.key?(:apt)
@goo = args[:goo] if args.key?(:goo)
@yum = args[:yum] if args.key?(:yum)
@zypper = args[:zypper] if args.key?(:zypper)
end
end
# Patch configuration specifications. Contains details on how to apply the patch(
# es) to a VM instance.
class PatchConfig
include Google::Apis::Core::Hashable
# Apt patching is completed by executing `apt-get update && apt-get upgrade`.
# Additional options can be set to control how this is executed.
# Corresponds to the JSON property `apt`
# @return [Google::Apis::OsconfigV1beta::AptSettings]
attr_accessor :apt
# Googet patching is performed by running `googet update`.
# Corresponds to the JSON property `goo`
# @return [Google::Apis::OsconfigV1beta::GooSettings]
attr_accessor :goo
# A step that runs an executable for a PatchJob.
# Corresponds to the JSON property `postStep`
# @return [Google::Apis::OsconfigV1beta::ExecStep]
attr_accessor :post_step
# A step that runs an executable for a PatchJob.
# Corresponds to the JSON property `preStep`
# @return [Google::Apis::OsconfigV1beta::ExecStep]
attr_accessor :pre_step
# Post-patch reboot settings.
# Corresponds to the JSON property `rebootConfig`
# @return [String]
attr_accessor :reboot_config
# Windows patching is performed using the Windows Update Agent.
# Corresponds to the JSON property `windowsUpdate`
# @return [Google::Apis::OsconfigV1beta::WindowsUpdateSettings]
attr_accessor :windows_update
# 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.
# Corresponds to the JSON property `yum`
# @return [Google::Apis::OsconfigV1beta::YumSettings]
attr_accessor :yum
# Zypper patching is performed by running `zypper patch`. See also https://en.
# opensuse.org/SDB:Zypper_manual.
# Corresponds to the JSON property `zypper`
# @return [Google::Apis::OsconfigV1beta::ZypperSettings]
attr_accessor :zypper
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apt = args[:apt] if args.key?(:apt)
@goo = args[:goo] if args.key?(:goo)
@post_step = args[:post_step] if args.key?(:post_step)
@pre_step = args[:pre_step] if args.key?(:pre_step)
@reboot_config = args[:reboot_config] if args.key?(:reboot_config)
@windows_update = args[:windows_update] if args.key?(:windows_update)
@yum = args[:yum] if args.key?(:yum)
@zypper = args[:zypper] if args.key?(:zypper)
end
end
# 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](https://cloud.google.
# com/compute/docs/os-patch-management/schedule-patch-jobs).
class PatchDeployment
include Google::Apis::Core::Hashable
# Output only. Time the patch deployment was created. Timestamp is in [RFC3339](
# https://www.ietf.org/rfc/rfc3339.txt) text format.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Optional. Description of the patch deployment. Length of the description is
# limited to 1024 characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Optional. Duration of the patch. After the duration ends, the patch times out.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# 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.
# Corresponds to the JSON property `instanceFilter`
# @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter]
attr_accessor :instance_filter
# Output only. The last time a patch job was started by this deployment.
# Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
# Corresponds to the JSON property `lastExecuteTime`
# @return [String]
attr_accessor :last_execute_time
# Unique name for the patch deployment resource in a project. The patch
# deployment name is in the form: `projects/`project_id`/patchDeployments/`
# patch_deployment_id``. This field is ignored when you create a new patch
# deployment.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https:
# //www.ietf.org/rfc/rfc3339.txt) text format.
# Corresponds to the JSON property `oneTimeSchedule`
# @return [Google::Apis::OsconfigV1beta::OneTimeSchedule]
attr_accessor :one_time_schedule
# Patch configuration specifications. Contains details on how to apply the patch(
# es) to a VM instance.
# Corresponds to the JSON property `patchConfig`
# @return [Google::Apis::OsconfigV1beta::PatchConfig]
attr_accessor :patch_config
# Sets the time for recurring patch deployments.
# Corresponds to the JSON property `recurringSchedule`
# @return [Google::Apis::OsconfigV1beta::RecurringSchedule]
attr_accessor :recurring_schedule
# Patch rollout configuration specifications. Contains details on the
# concurrency control when applying patch(es) to all targeted VMs.
# Corresponds to the JSON property `rollout`
# @return [Google::Apis::OsconfigV1beta::PatchRollout]
attr_accessor :rollout
# Output only. Time the patch deployment was last updated. Timestamp is in [
# RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@duration = args[:duration] if args.key?(:duration)
@instance_filter = args[:instance_filter] if args.key?(:instance_filter)
@last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time)
@name = args[:name] if args.key?(:name)
@one_time_schedule = args[:one_time_schedule] if args.key?(:one_time_schedule)
@patch_config = args[:patch_config] if args.key?(:patch_config)
@recurring_schedule = args[:recurring_schedule] if args.key?(:recurring_schedule)
@rollout = args[:rollout] if args.key?(:rollout)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# 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.
class PatchInstanceFilter
include Google::Apis::Core::Hashable
# Target all VM instances in the project. If true, no other criteria is
# permitted.
# Corresponds to the JSON property `all`
# @return [Boolean]
attr_accessor :all
alias_method :all?, :all
# Targets VM instances matching at least one of these label sets. This allows
# targeting of disparate groups, for example "env=prod or env=staging".
# Corresponds to the JSON property `groupLabels`
# @return [Array<Google::Apis::OsconfigV1beta::PatchInstanceFilterGroupLabel>]
attr_accessor :group_labels
# Targets VMs whose name starts with one of these prefixes. Similar to labels,
# this is another way to group VMs when targeting configs, for example prefix="
# prod-".
# Corresponds to the JSON property `instanceNamePrefixes`
# @return [Array<String>]
attr_accessor :instance_name_prefixes
# Targets any of the VM instances specified. Instances are specified by their
# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[
# PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.
# googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[
# INSTANCE_NAME]`
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# Targets VM instances in ANY of these zones. Leave empty to target VM instances
# in any zone.
# Corresponds to the JSON property `zones`
# @return [Array<String>]
attr_accessor :zones
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@all = args[:all] if args.key?(:all)
@group_labels = args[:group_labels] if args.key?(:group_labels)
@instance_name_prefixes = args[:instance_name_prefixes] if args.key?(:instance_name_prefixes)
@instances = args[:instances] if args.key?(:instances)
@zones = args[:zones] if args.key?(:zones)
end
end
# Represents a group of VMs that can be identified as having all these labels,
# for example "env=prod and app=web".
class PatchInstanceFilterGroupLabel
include Google::Apis::Core::Hashable
# Compute Engine instance labels that must be present for a VM instance to be
# targeted by this filter.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@labels = args[:labels] if args.key?(:labels)
end
end
# 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](https://cloud.google.com/compute/
# docs/os-patch-management/create-patch-job).
class PatchJob
include Google::Apis::Core::Hashable
# Time this patch job was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Description of the patch job. Length of the description is limited to 1024
# characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Display name for this patch job. This is not a unique identifier.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# If this patch job is a dry run, the agent reports that it has finished without
# running any updates on the VM instance.
# Corresponds to the JSON property `dryRun`
# @return [Boolean]
attr_accessor :dry_run
alias_method :dry_run?, :dry_run
# Duration of the patch job. After the duration ends, the patch job times out.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# If this patch job failed, this message provides information about the failure.
# Corresponds to the JSON property `errorMessage`
# @return [String]
attr_accessor :error_message
# 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.
# Corresponds to the JSON property `instanceDetailsSummary`
# @return [Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary]
attr_accessor :instance_details_summary
# 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.
# Corresponds to the JSON property `instanceFilter`
# @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter]
attr_accessor :instance_filter
# Unique identifier for this patch job in the form `projects/*/patchJobs/*`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Patch configuration specifications. Contains details on how to apply the patch(
# es) to a VM instance.
# Corresponds to the JSON property `patchConfig`
# @return [Google::Apis::OsconfigV1beta::PatchConfig]
attr_accessor :patch_config
# Output only. Name of the patch deployment that created this patch job.
# Corresponds to the JSON property `patchDeployment`
# @return [String]
attr_accessor :patch_deployment
# Reflects the overall progress of the patch job in the range of 0.0 being no
# progress to 100.0 being complete.
# Corresponds to the JSON property `percentComplete`
# @return [Float]
attr_accessor :percent_complete
# Patch rollout configuration specifications. Contains details on the
# concurrency control when applying patch(es) to all targeted VMs.
# Corresponds to the JSON property `rollout`
# @return [Google::Apis::OsconfigV1beta::PatchRollout]
attr_accessor :rollout
# The current state of the PatchJob.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Last time this patch job was updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@display_name = args[:display_name] if args.key?(:display_name)
@dry_run = args[:dry_run] if args.key?(:dry_run)
@duration = args[:duration] if args.key?(:duration)
@error_message = args[:error_message] if args.key?(:error_message)
@instance_details_summary = args[:instance_details_summary] if args.key?(:instance_details_summary)
@instance_filter = args[:instance_filter] if args.key?(:instance_filter)
@name = args[:name] if args.key?(:name)
@patch_config = args[:patch_config] if args.key?(:patch_config)
@patch_deployment = args[:patch_deployment] if args.key?(:patch_deployment)
@percent_complete = args[:percent_complete] if args.key?(:percent_complete)
@rollout = args[:rollout] if args.key?(:rollout)
@state = args[:state] if args.key?(:state)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# 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](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-
# jobs#list-instance-details).
class PatchJobInstanceDetails
include Google::Apis::Core::Hashable
# The number of times the agent that the agent attempts to apply the patch.
# Corresponds to the JSON property `attemptCount`
# @return [Fixnum]
attr_accessor :attempt_count
# If the patch fails, this field provides the reason.
# Corresponds to the JSON property `failureReason`
# @return [String]
attr_accessor :failure_reason
# The unique identifier for the instance. This identifier is defined by the
# server.
# Corresponds to the JSON property `instanceSystemId`
# @return [String]
attr_accessor :instance_system_id
# The instance name in the form `projects/*/zones/*/instances/*`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Current state of instance patch.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attempt_count = args[:attempt_count] if args.key?(:attempt_count)
@failure_reason = args[:failure_reason] if args.key?(:failure_reason)
@instance_system_id = args[:instance_system_id] if args.key?(:instance_system_id)
@name = args[:name] if args.key?(:name)
@state = args[:state] if args.key?(:state)
end
end
# 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.
class PatchJobInstanceDetailsSummary
include Google::Apis::Core::Hashable
# Number of instances that have acked and will start shortly.
# Corresponds to the JSON property `ackedInstanceCount`
# @return [Fixnum]
attr_accessor :acked_instance_count
# Number of instances that are applying patches.
# Corresponds to the JSON property `applyingPatchesInstanceCount`
# @return [Fixnum]
attr_accessor :applying_patches_instance_count
# Number of instances that are downloading patches.
# Corresponds to the JSON property `downloadingPatchesInstanceCount`
# @return [Fixnum]
attr_accessor :downloading_patches_instance_count
# Number of instances that failed.
# Corresponds to the JSON property `failedInstanceCount`
# @return [Fixnum]
attr_accessor :failed_instance_count
# Number of instances that are inactive.
# Corresponds to the JSON property `inactiveInstanceCount`
# @return [Fixnum]
attr_accessor :inactive_instance_count
# Number of instances that do not appear to be running the agent. Check to
# ensure that the agent is installed, running, and able to communicate with the
# service.
# Corresponds to the JSON property `noAgentDetectedInstanceCount`
# @return [Fixnum]
attr_accessor :no_agent_detected_instance_count
# Number of instances notified about patch job.
# Corresponds to the JSON property `notifiedInstanceCount`
# @return [Fixnum]
attr_accessor :notified_instance_count
# Number of instances pending patch job.
# Corresponds to the JSON property `pendingInstanceCount`
# @return [Fixnum]
attr_accessor :pending_instance_count
# Number of instances that are running the post-patch step.
# Corresponds to the JSON property `postPatchStepInstanceCount`
# @return [Fixnum]
attr_accessor :post_patch_step_instance_count
# Number of instances that are running the pre-patch step.
# Corresponds to the JSON property `prePatchStepInstanceCount`
# @return [Fixnum]
attr_accessor :pre_patch_step_instance_count
# Number of instances rebooting.
# Corresponds to the JSON property `rebootingInstanceCount`
# @return [Fixnum]
attr_accessor :rebooting_instance_count
# Number of instances that have started.
# Corresponds to the JSON property `startedInstanceCount`
# @return [Fixnum]
attr_accessor :started_instance_count
# Number of instances that have completed successfully.
# Corresponds to the JSON property `succeededInstanceCount`
# @return [Fixnum]
attr_accessor :succeeded_instance_count
# Number of instances that require reboot.
# Corresponds to the JSON property `succeededRebootRequiredInstanceCount`
# @return [Fixnum]
attr_accessor :succeeded_reboot_required_instance_count
# Number of instances that exceeded the time out while applying the patch.
# Corresponds to the JSON property `timedOutInstanceCount`
# @return [Fixnum]
attr_accessor :timed_out_instance_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@acked_instance_count = args[:acked_instance_count] if args.key?(:acked_instance_count)
@applying_patches_instance_count = args[:applying_patches_instance_count] if args.key?(:applying_patches_instance_count)
@downloading_patches_instance_count = args[:downloading_patches_instance_count] if args.key?(:downloading_patches_instance_count)
@failed_instance_count = args[:failed_instance_count] if args.key?(:failed_instance_count)
@inactive_instance_count = args[:inactive_instance_count] if args.key?(:inactive_instance_count)
@no_agent_detected_instance_count = args[:no_agent_detected_instance_count] if args.key?(:no_agent_detected_instance_count)
@notified_instance_count = args[:notified_instance_count] if args.key?(:notified_instance_count)
@pending_instance_count = args[:pending_instance_count] if args.key?(:pending_instance_count)
@post_patch_step_instance_count = args[:post_patch_step_instance_count] if args.key?(:post_patch_step_instance_count)
@pre_patch_step_instance_count = args[:pre_patch_step_instance_count] if args.key?(:pre_patch_step_instance_count)
@rebooting_instance_count = args[:rebooting_instance_count] if args.key?(:rebooting_instance_count)
@started_instance_count = args[:started_instance_count] if args.key?(:started_instance_count)
@succeeded_instance_count = args[:succeeded_instance_count] if args.key?(:succeeded_instance_count)
@succeeded_reboot_required_instance_count = args[:succeeded_reboot_required_instance_count] if args.key?(:succeeded_reboot_required_instance_count)
@timed_out_instance_count = args[:timed_out_instance_count] if args.key?(:timed_out_instance_count)
end
end
# Patch rollout configuration specifications. Contains details on the
# concurrency control when applying patch(es) to all targeted VMs.
class PatchRollout
include Google::Apis::Core::Hashable
# Message encapsulating a value that can be either absolute ("fixed") or
# relative ("percent") to a value.
# Corresponds to the JSON property `disruptionBudget`
# @return [Google::Apis::OsconfigV1beta::FixedOrPercent]
attr_accessor :disruption_budget
# Mode of the patch rollout.
# Corresponds to the JSON property `mode`
# @return [String]
attr_accessor :mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disruption_budget = args[:disruption_budget] if args.key?(:disruption_budget)
@mode = args[:mode] if args.key?(:mode)
end
end
# Sets the time for recurring patch deployments.
class RecurringSchedule
include Google::Apis::Core::Hashable
# Optional. The end time at which a recurring patch deployment schedule is no
# longer active.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Required. The frequency unit of this recurring schedule.
# Corresponds to the JSON property `frequency`
# @return [String]
attr_accessor :frequency
# Output only. The time the last patch job ran successfully.
# Corresponds to the JSON property `lastExecuteTime`
# @return [String]
attr_accessor :last_execute_time
# 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".
# Corresponds to the JSON property `monthly`
# @return [Google::Apis::OsconfigV1beta::MonthlySchedule]
attr_accessor :monthly
# Output only. The time the next patch job is scheduled to run.
# Corresponds to the JSON property `nextExecuteTime`
# @return [String]
attr_accessor :next_execute_time
# Optional. The time that the recurring schedule becomes effective. Defaults to `
# create_time` of the patch deployment.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Represents a time of day. The date and time zone are either not significant or
# are specified elsewhere. An API may choose to allow leap seconds. Related
# types are google.type.Date and `google.protobuf.Timestamp`.
# Corresponds to the JSON property `timeOfDay`
# @return [Google::Apis::OsconfigV1beta::TimeOfDay]
attr_accessor :time_of_day
# Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
# time-zones).
# Corresponds to the JSON property `timeZone`
# @return [Google::Apis::OsconfigV1beta::TimeZone]
attr_accessor :time_zone
# Represents a weekly schedule.
# Corresponds to the JSON property `weekly`
# @return [Google::Apis::OsconfigV1beta::WeeklySchedule]
attr_accessor :weekly
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_time = args[:end_time] if args.key?(:end_time)
@frequency = args[:frequency] if args.key?(:frequency)
@last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time)
@monthly = args[:monthly] if args.key?(:monthly)
@next_execute_time = args[:next_execute_time] if args.key?(:next_execute_time)
@start_time = args[:start_time] if args.key?(:start_time)
@time_of_day = args[:time_of_day] if args.key?(:time_of_day)
@time_zone = args[:time_zone] if args.key?(:time_zone)
@weekly = args[:weekly] if args.key?(:weekly)
end
end
# 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.
class SoftwareRecipe
include Google::Apis::Core::Hashable
# Resources available to be used in the steps in the recipe.
# Corresponds to the JSON property `artifacts`
# @return [Array<Google::Apis::OsconfigV1beta::SoftwareRecipeArtifact>]
attr_accessor :artifacts
# Default is INSTALLED. The desired state the agent should maintain for this
# recipe. INSTALLED: The software recipe is installed on the instance but won't
# be updated to new versions. UPDATED: The software recipe is installed on the
# instance. The recipe is updated to a higher version, if a higher version of
# the recipe is assigned to this instance. REMOVE: Remove is unsupported for
# software recipes and attempts to create or update a recipe to the REMOVE state
# is rejected.
# Corresponds to the JSON property `desiredState`
# @return [String]
attr_accessor :desired_state
# Actions to be taken for installing this recipe. On failure it stops executing
# steps and does not attempt another installation. Any steps taken (including
# partially completed steps) are not rolled back.
# Corresponds to the JSON property `installSteps`
# @return [Array<Google::Apis::OsconfigV1beta::SoftwareRecipeStep>]
attr_accessor :install_steps
# Required. Unique identifier for the recipe. Only one recipe with a given name
# is installed on an instance. Names are also used to identify resources which
# helps to determine whether guest policies have conflicts. This means that
# requests to create multiple recipes with the same name and version are
# rejected since they could potentially have conflicting assignments.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Actions to be taken for updating this recipe. On failure it stops executing
# steps and does not attempt another update for this recipe. Any steps taken (
# including partially completed steps) are not rolled back.
# Corresponds to the JSON property `updateSteps`
# @return [Array<Google::Apis::OsconfigV1beta::SoftwareRecipeStep>]
attr_accessor :update_steps
# The version of this software recipe. Version can be up to 4 period separated
# numbers (e.g. 12.34.56.78).
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifacts = args[:artifacts] if args.key?(:artifacts)
@desired_state = args[:desired_state] if args.key?(:desired_state)
@install_steps = args[:install_steps] if args.key?(:install_steps)
@name = args[:name] if args.key?(:name)
@update_steps = args[:update_steps] if args.key?(:update_steps)
@version = args[:version] if args.key?(:version)
end
end
# Specifies a resource to be used in the recipe.
class SoftwareRecipeArtifact
include Google::Apis::Core::Hashable
# Defaults to false. When false, recipes are subject to validations based on the
# artifact type: Remote: A checksum must be specified, and only protocols with
# transport-layer security are permitted. GCS: An object generation number must
# be specified.
# Corresponds to the JSON property `allowInsecure`
# @return [Boolean]
attr_accessor :allow_insecure
alias_method :allow_insecure?, :allow_insecure
# Specifies an artifact available as a Google Cloud Storage object.
# Corresponds to the JSON property `gcs`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactGcs]
attr_accessor :gcs
# Required. Id of the artifact, which the installation and update steps of this
# recipe can reference. Artifacts in a recipe cannot have the same id.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Specifies an artifact available via some URI.
# Corresponds to the JSON property `remote`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeArtifactRemote]
attr_accessor :remote
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_insecure = args[:allow_insecure] if args.key?(:allow_insecure)
@gcs = args[:gcs] if args.key?(:gcs)
@id = args[:id] if args.key?(:id)
@remote = args[:remote] if args.key?(:remote)
end
end
# Specifies an artifact available as a Google Cloud Storage object.
class SoftwareRecipeArtifactGcs
include Google::Apis::Core::Hashable
# Bucket of the Google Cloud Storage object. Given an example URL: `https://
# storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-
# bucket`.
# Corresponds to the JSON property `bucket`
# @return [String]
attr_accessor :bucket
# Must be provided if allow_insecure is false. Generation number of the Google
# Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#
# 1234567` this value would be `1234567`.
# Corresponds to the JSON property `generation`
# @return [Fixnum]
attr_accessor :generation
# Name of the Google Cloud Storage object. As specified [here] (https://cloud.
# google.com/storage/docs/naming#objectnames) Given an example URL: `https://
# storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`
# .
# Corresponds to the JSON property `object`
# @return [String]
attr_accessor :object
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket = args[:bucket] if args.key?(:bucket)
@generation = args[:generation] if args.key?(:generation)
@object = args[:object] if args.key?(:object)
end
end
# Specifies an artifact available via some URI.
class SoftwareRecipeArtifactRemote
include Google::Apis::Core::Hashable
# Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format,
# to compare to the checksum of the artifact. If the checksum is not empty and
# it doesn't match the artifact then the recipe installation fails before
# running any of the steps.
# Corresponds to the JSON property `checksum`
# @return [String]
attr_accessor :checksum
# URI from which to fetch the object. It should contain both the protocol and
# path following the format `protocol`://`location`.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@checksum = args[:checksum] if args.key?(:checksum)
@uri = args[:uri] if args.key?(:uri)
end
end
# An action that can be taken as part of installing or updating a recipe.
class SoftwareRecipeStep
include Google::Apis::Core::Hashable
# Extracts an archive of the type specified in the specified directory.
# Corresponds to the JSON property `archiveExtraction`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepExtractArchive]
attr_accessor :archive_extraction
# Installs a deb via dpkg.
# Corresponds to the JSON property `dpkgInstallation`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallDpkg]
attr_accessor :dpkg_installation
# Copies the artifact to the specified path on the instance.
# Corresponds to the JSON property `fileCopy`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepCopyFile]
attr_accessor :file_copy
# Executes an artifact or local file.
# Corresponds to the JSON property `fileExec`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepExecFile]
attr_accessor :file_exec
# Installs an MSI file.
# Corresponds to the JSON property `msiInstallation`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallMsi]
attr_accessor :msi_installation
# Installs an rpm file via the rpm utility.
# Corresponds to the JSON property `rpmInstallation`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepInstallRpm]
attr_accessor :rpm_installation
# Runs a script through an interpreter.
# Corresponds to the JSON property `scriptRun`
# @return [Google::Apis::OsconfigV1beta::SoftwareRecipeStepRunScript]
attr_accessor :script_run
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@archive_extraction = args[:archive_extraction] if args.key?(:archive_extraction)
@dpkg_installation = args[:dpkg_installation] if args.key?(:dpkg_installation)
@file_copy = args[:file_copy] if args.key?(:file_copy)
@file_exec = args[:file_exec] if args.key?(:file_exec)
@msi_installation = args[:msi_installation] if args.key?(:msi_installation)
@rpm_installation = args[:rpm_installation] if args.key?(:rpm_installation)
@script_run = args[:script_run] if args.key?(:script_run)
end
end
# Copies the artifact to the specified path on the instance.
class SoftwareRecipeStepCopyFile
include Google::Apis::Core::Hashable
# Required. The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
# Required. The absolute path on the instance to put the file.
# Corresponds to the JSON property `destination`
# @return [String]
attr_accessor :destination
# Whether to allow this step to overwrite existing files. If this is false and
# the file already exists the file is not overwritten and the step is considered
# a success. Defaults to false.
# Corresponds to the JSON property `overwrite`
# @return [Boolean]
attr_accessor :overwrite
alias_method :overwrite?, :overwrite
# Consists of three octal digits which represent, in order, the permissions of
# the owner, group, and other users for the file (similarly to the numeric mode
# used in the linux chmod utility). Each digit represents a three bit number
# with the 4 bit corresponding to the read permissions, the 2 bit corresponds to
# the write bit, and the one bit corresponds to the execute permission. Default
# behavior is 755. Below are some examples of permissions and their associated
# values: read, write, and execute: 7 read and execute: 5 read and write: 6 read
# only: 4
# Corresponds to the JSON property `permissions`
# @return [String]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
@destination = args[:destination] if args.key?(:destination)
@overwrite = args[:overwrite] if args.key?(:overwrite)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Executes an artifact or local file.
class SoftwareRecipeStepExecFile
include Google::Apis::Core::Hashable
# Defaults to [0]. A list of possible return values that the program can return
# to indicate a success.
# Corresponds to the JSON property `allowedExitCodes`
# @return [Array<Fixnum>]
attr_accessor :allowed_exit_codes
# Arguments to be passed to the provided executable.
# Corresponds to the JSON property `args`
# @return [Array<String>]
attr_accessor :args
# The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
# The absolute path of the file on the local filesystem.
# Corresponds to the JSON property `localPath`
# @return [String]
attr_accessor :local_path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes)
@args = args[:args] if args.key?(:args)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
@local_path = args[:local_path] if args.key?(:local_path)
end
end
# Extracts an archive of the type specified in the specified directory.
class SoftwareRecipeStepExtractArchive
include Google::Apis::Core::Hashable
# Required. The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
# Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows.
# Corresponds to the JSON property `destination`
# @return [String]
attr_accessor :destination
# Required. The type of the archive to extract.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
@destination = args[:destination] if args.key?(:destination)
@type = args[:type] if args.key?(:type)
end
end
# Installs a deb via dpkg.
class SoftwareRecipeStepInstallDpkg
include Google::Apis::Core::Hashable
# Required. The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
end
end
# Installs an MSI file.
class SoftwareRecipeStepInstallMsi
include Google::Apis::Core::Hashable
# Return codes that indicate that the software installed or updated successfully.
# Behaviour defaults to [0]
# Corresponds to the JSON property `allowedExitCodes`
# @return [Array<Fixnum>]
attr_accessor :allowed_exit_codes
# Required. The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
# The flags to use when installing the MSI defaults to ["/i"] (i.e. the install
# flag).
# Corresponds to the JSON property `flags`
# @return [Array<String>]
attr_accessor :flags
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
@flags = args[:flags] if args.key?(:flags)
end
end
# Installs an rpm file via the rpm utility.
class SoftwareRecipeStepInstallRpm
include Google::Apis::Core::Hashable
# Required. The id of the relevant artifact in the recipe.
# Corresponds to the JSON property `artifactId`
# @return [String]
attr_accessor :artifact_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_id = args[:artifact_id] if args.key?(:artifact_id)
end
end
# Runs a script through an interpreter.
class SoftwareRecipeStepRunScript
include Google::Apis::Core::Hashable
# Return codes that indicate that the software installed or updated successfully.
# Behaviour defaults to [0]
# Corresponds to the JSON property `allowedExitCodes`
# @return [Array<Fixnum>]
attr_accessor :allowed_exit_codes
# The script interpreter to use to run the script. If no interpreter is
# specified the script is executed directly, which likely only succeed for
# scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
# Corresponds to the JSON property `interpreter`
# @return [String]
attr_accessor :interpreter
# Required. The shell script to be executed.
# Corresponds to the JSON property `script`
# @return [String]
attr_accessor :script
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_exit_codes = args[:allowed_exit_codes] if args.key?(:allowed_exit_codes)
@interpreter = args[:interpreter] if args.key?(:interpreter)
@script = args[:script] if args.key?(:script)
end
end
# Represents a time of day. The date and time zone are either not significant or
# are specified elsewhere. An API may choose to allow leap seconds. Related
# types are google.type.Date and `google.protobuf.Timestamp`.
class TimeOfDay
include Google::Apis::Core::Hashable
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
# allow the value "24:00:00" for scenarios like business closing time.
# Corresponds to the JSON property `hours`
# @return [Fixnum]
attr_accessor :hours
# Minutes of hour of day. Must be from 0 to 59.
# Corresponds to the JSON property `minutes`
# @return [Fixnum]
attr_accessor :minutes
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
# allow the value 60 if it allows leap-seconds.
# Corresponds to the JSON property `seconds`
# @return [Fixnum]
attr_accessor :seconds
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hours = args[:hours] if args.key?(:hours)
@minutes = args[:minutes] if args.key?(:minutes)
@nanos = args[:nanos] if args.key?(:nanos)
@seconds = args[:seconds] if args.key?(:seconds)
end
end
# Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
# time-zones).
class TimeZone
include Google::Apis::Core::Hashable
# IANA Time Zone Database time zone, e.g. "America/New_York".
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Optional. IANA Time Zone Database version number, e.g. "2019a".
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@version = args[:version] if args.key?(:version)
end
end
# Represents one week day in a month. An example is "the 4th Sunday".
class WeekDayOfMonth
include Google::Apis::Core::Hashable
# Required. A day of the week.
# Corresponds to the JSON property `dayOfWeek`
# @return [String]
attr_accessor :day_of_week
# Required. Week number in a month. 1-4 indicates the 1st to 4th week of the
# month. -1 indicates the last week of the month.
# Corresponds to the JSON property `weekOrdinal`
# @return [Fixnum]
attr_accessor :week_ordinal
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@day_of_week = args[:day_of_week] if args.key?(:day_of_week)
@week_ordinal = args[:week_ordinal] if args.key?(:week_ordinal)
end
end
# Represents a weekly schedule.
class WeeklySchedule
include Google::Apis::Core::Hashable
# Required. Day of the week.
# Corresponds to the JSON property `dayOfWeek`
# @return [String]
attr_accessor :day_of_week
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@day_of_week = args[:day_of_week] if args.key?(:day_of_week)
end
end
# Windows patching is performed using the Windows Update Agent.
class WindowsUpdateSettings
include Google::Apis::Core::Hashable
# Only apply updates of these windows update classifications. If empty, all
# updates are applied.
# Corresponds to the JSON property `classifications`
# @return [Array<String>]
attr_accessor :classifications
# List of KBs to exclude from update.
# Corresponds to the JSON property `excludes`
# @return [Array<String>]
attr_accessor :excludes
# An exclusive list of kbs to be updated. These are the only patches that will
# be updated. This field must not be used with other patch configurations.
# Corresponds to the JSON property `exclusivePatches`
# @return [Array<String>]
attr_accessor :exclusive_patches
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@classifications = args[:classifications] if args.key?(:classifications)
@excludes = args[:excludes] if args.key?(:excludes)
@exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches)
end
end
# 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`.
class YumRepository
include Google::Apis::Core::Hashable
# Required. The location of the repository directory.
# Corresponds to the JSON property `baseUrl`
# @return [String]
attr_accessor :base_url
# The display name of the repository.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# URIs of GPG keys.
# Corresponds to the JSON property `gpgKeys`
# @return [Array<String>]
attr_accessor :gpg_keys
# Required. A one word, unique name for this repository. This is the `repo id`
# in the Yum config file and also the `display_name` if `display_name` is
# omitted. This id is also used as the unique identifier when checking for guest
# policy conflicts.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@base_url = args[:base_url] if args.key?(:base_url)
@display_name = args[:display_name] if args.key?(:display_name)
@gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys)
@id = args[:id] if args.key?(:id)
end
end
# 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.
class YumSettings
include Google::Apis::Core::Hashable
# List of packages to exclude from update. These packages are excluded by using
# the yum `--exclude` flag.
# Corresponds to the JSON property `excludes`
# @return [Array<String>]
attr_accessor :excludes
# An exclusive list of packages to be updated. These are the only packages that
# will be updated. If these packages are not installed, they will be ignored.
# This field must not be specified with any other patch configuration fields.
# Corresponds to the JSON property `exclusivePackages`
# @return [Array<String>]
attr_accessor :exclusive_packages
# Will cause patch to run `yum update-minimal` instead.
# Corresponds to the JSON property `minimal`
# @return [Boolean]
attr_accessor :minimal
alias_method :minimal?, :minimal
# Adds the `--security` flag to `yum update`. Not supported on all platforms.
# Corresponds to the JSON property `security`
# @return [Boolean]
attr_accessor :security
alias_method :security?, :security
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@excludes = args[:excludes] if args.key?(:excludes)
@exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages)
@minimal = args[:minimal] if args.key?(:minimal)
@security = args[:security] if args.key?(:security)
end
end
# 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`.
class ZypperRepository
include Google::Apis::Core::Hashable
# Required. The location of the repository directory.
# Corresponds to the JSON property `baseUrl`
# @return [String]
attr_accessor :base_url
# The display name of the repository.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# URIs of GPG keys.
# Corresponds to the JSON property `gpgKeys`
# @return [Array<String>]
attr_accessor :gpg_keys
# Required. A one word, unique name for this repository. This is the `repo id`
# in the zypper config file and also the `display_name` if `display_name` is
# omitted. This id is also used as the unique identifier when checking for guest
# policy conflicts.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@base_url = args[:base_url] if args.key?(:base_url)
@display_name = args[:display_name] if args.key?(:display_name)
@gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys)
@id = args[:id] if args.key?(:id)
end
end
# Zypper patching is performed by running `zypper patch`. See also https://en.
# opensuse.org/SDB:Zypper_manual.
class ZypperSettings
include Google::Apis::Core::Hashable
# Install only patches with these categories. Common categories include security,
# recommended, and feature.
# Corresponds to the JSON property `categories`
# @return [Array<String>]
attr_accessor :categories
# List of patches to exclude from update.
# Corresponds to the JSON property `excludes`
# @return [Array<String>]
attr_accessor :excludes
# An exclusive list of patches to be updated. These are the only patches that
# will be installed using 'zypper patch patch:' command. This field must not be
# used with any other patch configuration fields.
# Corresponds to the JSON property `exclusivePatches`
# @return [Array<String>]
attr_accessor :exclusive_patches
# Install only patches with these severities. Common severities include critical,
# important, moderate, and low.
# Corresponds to the JSON property `severities`
# @return [Array<String>]
attr_accessor :severities
# Adds the `--with-optional` flag to `zypper patch`.
# Corresponds to the JSON property `withOptional`
# @return [Boolean]
attr_accessor :with_optional
alias_method :with_optional?, :with_optional
# Adds the `--with-update` flag, to `zypper patch`.
# Corresponds to the JSON property `withUpdate`
# @return [Boolean]
attr_accessor :with_update
alias_method :with_update?, :with_update
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@categories = args[:categories] if args.key?(:categories)
@excludes = args[:excludes] if args.key?(:excludes)
@exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches)
@severities = args[:severities] if args.key?(:severities)
@with_optional = args[:with_optional] if args.key?(:with_optional)
@with_update = args[:with_update] if args.key?(:with_update)
end
end
end
end
end
Reference in New Issue View Git Blame Copy Permalink