google-cloud-os_config-v1 0.1.3 → 0.4.0

data/proto_docs/google/cloud/osconfig/v1/inventory.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module OsConfig
+      module V1
+        # The inventory details of a VM.
+        # @!attribute [rw] os_info
+        #   @return [::Google::Cloud::OsConfig::V1::Inventory::OsInfo]
+        #     Base level operating system information for the VM.
+        # @!attribute [rw] items
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OsConfig::V1::Inventory::Item}]
+        #     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.
+        class Inventory
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Operating system information for the VM.
+          # @!attribute [rw] hostname
+          #   @return [::String]
+          #     The VM hostname.
+          # @!attribute [rw] long_name
+          #   @return [::String]
+          #     The operating system long name.
+          #     For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019
+          #     Datacenter'.
+          # @!attribute [rw] short_name
+          #   @return [::String]
+          #     The operating system short name.
+          #     For example, 'windows' or 'debian'.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     The version of the operating system.
+          # @!attribute [rw] architecture
+          #   @return [::String]
+          #     The system architecture of the operating system.
+          # @!attribute [rw] kernel_version
+          #   @return [::String]
+          #     The kernel version of the operating system.
+          # @!attribute [rw] kernel_release
+          #   @return [::String]
+          #     The kernel release of the operating system.
+          # @!attribute [rw] osconfig_agent_version
+          #   @return [::String]
+          #     The current version of the OS Config agent running on the VM.
+          class OsInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A single piece of inventory on a VM.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     Identifier for this item, unique across items for this VM.
+          # @!attribute [rw] origin_type
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::Item::OriginType]
+          #     The origin of this inventory item.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     When this inventory item was first detected.
+          # @!attribute [rw] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     When this inventory item was last modified.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::Item::Type]
+          #     The specific type of inventory, correlating to its specific details.
+          # @!attribute [rw] installed_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::SoftwarePackage]
+          #     Software package present on the VM instance.
+          # @!attribute [rw] available_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::SoftwarePackage]
+          #     Software package available to be installed on the VM instance.
+          class Item
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The origin of a specific inventory item.
+            module OriginType
+              # Invalid. An origin type must be specified.
+              ORIGIN_TYPE_UNSPECIFIED = 0
+
+              # This inventory item was discovered as the result of the agent
+              # reporting inventory via the reporting API.
+              INVENTORY_REPORT = 1
+            end
+
+            # The different types of inventory that are tracked on a VM.
+            module Type
+              # Invalid. An type must be specified.
+              TYPE_UNSPECIFIED = 0
+
+              # This represents a package that is installed on the VM.
+              INSTALLED_PACKAGE = 1
+
+              # This represents an update that is available for a package.
+              AVAILABLE_PACKAGE = 2
+            end
+          end
+
+          # Software package information of the operating system.
+          # @!attribute [rw] yum_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::VersionedPackage]
+          #     Yum package info.
+          #     For details about the yum package manager, see
+          #     https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.
+          # @!attribute [rw] apt_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::VersionedPackage]
+          #     Details of an APT package.
+          #     For details about the apt package manager, see
+          #     https://wiki.debian.org/Apt.
+          # @!attribute [rw] zypper_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::VersionedPackage]
+          #     Details of a Zypper package.
+          #     For details about the Zypper package manager, see
+          #     https://en.opensuse.org/SDB:Zypper_manual.
+          # @!attribute [rw] googet_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::VersionedPackage]
+          #     Details of a Googet package.
+          #      For details about the googet package manager, see
+          #      https://github.com/google/googet.
+          # @!attribute [rw] zypper_patch
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::ZypperPatch]
+          #     Details of a Zypper patch.
+          #     For details about the Zypper package manager, see
+          #     https://en.opensuse.org/SDB:Zypper_manual.
+          # @!attribute [rw] wua_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::WindowsUpdatePackage]
+          #     Details of a Windows Update package.
+          #     See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for
+          #     information about Windows Update.
+          # @!attribute [rw] qfe_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::WindowsQuickFixEngineeringPackage]
+          #     Details of a Windows Quick Fix engineering package.
+          #     See
+          #     https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering
+          #     for info in Windows Quick Fix Engineering.
+          # @!attribute [rw] cos_package
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::VersionedPackage]
+          #     Details of a COS package.
+          class SoftwarePackage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Information related to the a standard versioned package.  This includes
+          # package info for APT, Yum, Zypper, and Googet package managers.
+          # @!attribute [rw] package_name
+          #   @return [::String]
+          #     The name of the package.
+          # @!attribute [rw] architecture
+          #   @return [::String]
+          #     The system architecture this package is intended for.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     The version of the package.
+          class VersionedPackage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          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.
+          # @!attribute [rw] title
+          #   @return [::String]
+          #     The localized title of the update package.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The localized description of the update package.
+          # @!attribute [rw] categories
+          #   @return [::Array<::Google::Cloud::OsConfig::V1::Inventory::WindowsUpdatePackage::WindowsUpdateCategory>]
+          #     The categories that are associated with this update package.
+          # @!attribute [rw] kb_article_ids
+          #   @return [::Array<::String>]
+          #     A collection of Microsoft Knowledge Base article IDs that are associated
+          #     with the update package.
+          # @!attribute [rw] support_url
+          #   @return [::String]
+          #     A hyperlink to the language-specific support information for the update.
+          # @!attribute [rw] more_info_urls
+          #   @return [::Array<::String>]
+          #     A collection of URLs that provide more information about the update
+          #     package.
+          # @!attribute [rw] update_id
+          #   @return [::String]
+          #     Gets the identifier of an update package.  Stays the same across
+          #     revisions.
+          # @!attribute [rw] revision_number
+          #   @return [::Integer]
+          #     The revision number of this update package.
+          # @!attribute [rw] last_deployment_change_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The last published date of the update, in (UTC) date and time.
+          class WindowsUpdatePackage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Categories specified by the Windows Update.
+            # @!attribute [rw] id
+            #   @return [::String]
+            #     The identifier of the windows update category.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The name of the windows update category.
+            class WindowsUpdateCategory
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Details related to a Zypper Patch.
+          # @!attribute [rw] patch_name
+          #   @return [::String]
+          #     The name of the patch.
+          # @!attribute [rw] category
+          #   @return [::String]
+          #     The category of the patch.
+          # @!attribute [rw] severity
+          #   @return [::String]
+          #     The severity specified for this patch
+          # @!attribute [rw] summary
+          #   @return [::String]
+          #     Any summary information provided about this patch.
+          class ZypperPatch
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          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
+          # @!attribute [rw] caption
+          #   @return [::String]
+          #     A short textual description of the QFE update.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     A textual description of the QFE update.
+          # @!attribute [rw] hot_fix_id
+          #   @return [::String]
+          #     Unique identifier associated with a particular QFE update.
+          # @!attribute [rw] install_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Date that the QFE update was installed.  Mapped from installed_on field.
+          class WindowsQuickFixEngineeringPackage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::OsConfig::V1::Inventory::Item]
+          class ItemsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/osconfig/v1/osconfig_common.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module OsConfig
+      module V1
+        # Message encapsulating a value that can be either absolute ("fixed") or
+        # relative ("percent") to a value.
+        # @!attribute [rw] fixed
+        #   @return [::Integer]
+        #     Specifies a fixed value.
+        # @!attribute [rw] percent
+        #   @return [::Integer]
+        #     Specifies the relative value defined as a percentage, which will be
+        #     multiplied by a reference value.
+        class FixedOrPercent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/osconfig/v1/patch_deployments.rb

@@ -34,8 +34,8 @@ module Google
         #     This field is ignored when you create a new patch deployment.
         # @!attribute [rw] description
         #   @return [::String]
-        #     Optional. Description of the patch deployment. Length of the description is limited
-        #     to 1024 characters.
+        #     Optional. Description of the patch deployment. Length of the description is
+        #     limited to 1024 characters.
         # @!attribute [rw] instance_filter
         #   @return [::Google::Cloud::OsConfig::V1::PatchInstanceFilter]
         #     Required. VM instances to patch.
@@ -44,7 +44,8 @@ module Google
         #     Optional. Patch configuration that is applied.
         # @!attribute [rw] duration
         #   @return [::Google::Protobuf::Duration]
-        #     Optional. Duration of the patch. After the duration ends, the patch times out.
+        #     Optional. Duration of the patch. After the duration ends, the patch times
+        #     out.
         # @!attribute [rw] one_time_schedule
         #   @return [::Google::Cloud::OsConfig::V1::OneTimeSchedule]
         #     Required. Schedule a one-time execution.
@@ -64,6 +65,9 @@ module Google
         #     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.
+        # @!attribute [rw] rollout
+        #   @return [::Google::Cloud::OsConfig::V1::PatchRollout]
+        #     Optional. Rollout strategy of the patch job.
         class PatchDeployment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,8 +94,8 @@ module Google
         #     Defaults to `create_time` of the patch deployment.
         # @!attribute [rw] end_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Optional. The end time at which a recurring patch deployment schedule is no longer
-        #     active.
+        #     Optional. The end time at which a recurring patch deployment schedule is no
+        #     longer active.
         # @!attribute [rw] time_of_day
         #   @return [::Google::Type::TimeOfDay]
         #     Required. Time of the day to run a recurring deployment.
@@ -145,10 +149,10 @@ module Google
         #     Required. Week day in a month.
         # @!attribute [rw] month_day
         #   @return [::Integer]
-        #     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.
+        #     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.
         class MonthlySchedule
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -157,8 +161,8 @@ module Google
         # Represents one week day in a month. An example is "the 4th Sunday".
         # @!attribute [rw] week_ordinal
         #   @return [::Integer]
-        #     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.
+        #     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.
         # @!attribute [rw] day_of_week
         #   @return [::Google::Type::DayOfWeek]
         #     Required. A day of the week.
@@ -170,11 +174,12 @@ module Google
         # A request message for creating a patch deployment.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The project to apply this patch deployment to in the form `projects/*`.
+        #     Required. The project to apply this patch deployment to in the form
+        #     `projects/*`.
         # @!attribute [rw] patch_deployment_id
         #   @return [::String]
-        #     Required. A name for the patch deployment in the project. When creating a name
-        #     the following rules apply:
+        #     Required. A name for the patch deployment in the project. When creating a
+        #     name the following rules apply:
         #     * Must contain only lowercase letters, numbers, and hyphens.
         #     * Must start with a letter.
         #     * Must be between 1-63 characters.
@@ -204,11 +209,13 @@ module Google
         #     Required. The resource name of the parent in the form `projects/*`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Optional. The maximum number of patch deployments to return. Default is 100.
+        #     Optional. The maximum number of patch deployments to return. Default is
+        #     100.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     Optional. A pagination token returned from a previous call to ListPatchDeployments
-        #     that indicates where this listing should continue from.
+        #     Optional. A pagination token returned from a previous call to
+        #     ListPatchDeployments that indicates where this listing should continue
+        #     from.
         class ListPatchDeploymentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/osconfig/v1/patch_jobs.rb

@@ -32,8 +32,8 @@ module Google
         #     to 1024 characters.
         # @!attribute [rw] instance_filter
         #   @return [::Google::Cloud::OsConfig::V1::PatchInstanceFilter]
-        #     Required. Instances to patch, either explicitly or filtered by some criteria such
-        #     as zone or labels.
+        #     Required. Instances to patch, either explicitly or filtered by some
+        #     criteria such as zone or labels.
         # @!attribute [rw] patch_config
         #   @return [::Google::Cloud::OsConfig::V1::PatchConfig]
         #     Patch configuration being applied. If omitted, instances are
@@ -49,6 +49,9 @@ module Google
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Display name for this patch job. This does not have to be unique.
+        # @!attribute [rw] rollout
+        #   @return [::Google::Cloud::OsConfig::V1::PatchRollout]
+        #     Rollout strategy of the patch job.
         class ExecutePatchJobRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -66,7 +69,8 @@ module Google
         # Request to list details for all instances that are part of a patch job.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.
+        #     Required. The parent for the instances are in the form of
+        #     `projects/*/patchJobs/*`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of instance details records to return.  Default is 100.
@@ -157,7 +161,7 @@ module Google
         # A high level representation of a patch job that is either in progress
         # or has completed.
         #
-        # Instances details are not included in the job. To paginate through instance
+        # Instance details are not included in the job. To paginate through instance
         # details, use ListPatchJobInstanceDetails.
         #
         # For more information about patch jobs, see
@@ -182,7 +186,7 @@ module Google
         #     Last time this patch job was updated.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::OsConfig::V1::PatchJob::State]
-        #     The current state of the PatchJob .
+        #     The current state of the PatchJob.
         # @!attribute [rw] instance_filter
         #   @return [::Google::Cloud::OsConfig::V1::PatchInstanceFilter]
         #     Instances to patch.
@@ -211,6 +215,9 @@ module Google
         # @!attribute [r] patch_deployment
         #   @return [::String]
         #     Output only. Name of the patch deployment that created this patch job.
+        # @!attribute [rw] rollout
+        #   @return [::Google::Cloud::OsConfig::V1::PatchRollout]
+        #     Rollout strategy being applied.
         class PatchJob
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -707,6 +714,58 @@ module Google
             end
           end
         end
+
+        # Patch rollout configuration specifications. Contains details on the
+        # concurrency control when applying patch(es) to all targeted VMs.
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::OsConfig::V1::PatchRollout::Mode]
+        #     Mode of the patch rollout.
+        # @!attribute [rw] disruption_budget
+        #   @return [::Google::Cloud::OsConfig::V1::FixedOrPercent]
+        #     The maximum number (or percentage) of VMs per zone to disrupt at any given
+        #     moment. The number of VMs calculated from multiplying the percentage by the
+        #     total number of VMs in a zone is rounded up.
+        #
+        #     During patching, a VM is considered disrupted from the time the agent is
+        #     notified to begin until patching has completed. This disruption time
+        #     includes the time to complete reboot and any post-patch steps.
+        #
+        #     A VM contributes to the disruption budget if its patching operation fails
+        #     either when applying the patches, running pre or post patch steps, or if it
+        #     fails to respond with a success notification before timing out. VMs that
+        #     are not running or do not have an active agent do not count toward this
+        #     disruption budget.
+        #
+        #     For zone-by-zone rollouts, if the disruption budget in a zone is exceeded,
+        #     the patch job stops, because continuing to the next zone requires
+        #     completion of the patch process in the previous zone.
+        #
+        #     For example, if the disruption budget has a fixed value of `10`, and 8 VMs
+        #     fail to patch in the current zone, the patch job continues to patch 2 VMs
+        #     at a time until the zone is completed. When that zone is completed
+        #     successfully, patching begins with 10 VMs at a time in the next zone. If 10
+        #     VMs in the next zone fail to patch, the patch job stops.
+        class PatchRollout
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Type of the rollout.
+          module Mode
+            # Mode must be specified.
+            MODE_UNSPECIFIED = 0
+
+            # Patches are applied one zone at a time. The patch job begins in the
+            # region with the lowest number of targeted VMs. Within the region,
+            # patching begins in the zone with the lowest number of targeted VMs. If
+            # multiple regions (or zones within a region) have the same number of
+            # targeted VMs, a tie-breaker is achieved by sorting the regions or zones
+            # in alphabetical order.
+            ZONE_BY_ZONE = 1
+
+            # Patches are applied to VMs in all zones at the same time.
+            CONCURRENT_ZONES = 2
+          end
+        end
       end
     end
   end