google-cloud-asset-v1 0.7.0 → 0.11.0

data/proto_docs/google/cloud/asset/v1/assets.rb

@@ -134,6 +134,11 @@ module Google
         #   @return [::Google::Identity::AccessContextManager::V1::ServicePerimeter]
         #     Please also refer to the [service perimeter user
         #     guide](https://cloud.google.com/vpc-service-controls/docs/overview).
+        # @!attribute [rw] os_inventory
+        #   @return [::Google::Cloud::OsConfig::V1::Inventory]
+        #     A representation of runtime OS Inventory information. See [this
+        #     topic](https://cloud.google.com/compute/docs/instances/os-inventory-management)
+        #     for more information.
         # @!attribute [rw] ancestors
         #   @return [::Array<::String>]
         #     The ancestry path of an asset in Google Cloud [resource
@@ -396,6 +401,173 @@ module Google
             end
           end
         end
+
+        # Represents the detailed state of an entity under analysis, such as a
+        # resource, an identity or an access.
+        # @!attribute [rw] code
+        #   @return [::Google::Rpc::Code]
+        #     The Google standard error code that best describes the state.
+        #     For example:
+        #     - OK means the analysis on this entity has been successfully finished;
+        #     - PERMISSION_DENIED means an access denied error is encountered;
+        #     - DEADLINE_EXCEEDED means the analysis on this entity hasn't been started
+        #     in time;
+        # @!attribute [rw] cause
+        #   @return [::String]
+        #     The human-readable description of the cause of failure.
+        class IamPolicyAnalysisState
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # IAM Policy analysis result, consisting of one IAM policy binding and derived
+        # access control lists.
+        # @!attribute [rw] attached_resource_full_name
+        #   @return [::String]
+        #     The [full resource
+        #     name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
+        #     of the resource to which the {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult#iam_binding iam_binding} policy attaches.
+        # @!attribute [rw] iam_binding
+        #   @return [::Google::Iam::V1::Binding]
+        #     The Cloud IAM policy binding under analysis.
+        # @!attribute [rw] access_control_lists
+        #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::AccessControlList>]
+        #     The access control lists derived from the {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult#iam_binding iam_binding} that match or
+        #     potentially match resource and access selectors specified in the request.
+        # @!attribute [rw] identity_list
+        #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::IdentityList]
+        #     The identity list derived from members of the {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult#iam_binding iam_binding} that match or
+        #     potentially match identity selector specified in the request.
+        # @!attribute [rw] fully_explored
+        #   @return [::Boolean]
+        #     Represents whether all analyses on the {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult#iam_binding iam_binding} have successfully
+        #     finished.
+        class IamPolicyAnalysisResult
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A Google Cloud resource under analysis.
+          # @!attribute [rw] full_resource_name
+          #   @return [::String]
+          #     The [full resource
+          #     name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
+          # @!attribute [rw] analysis_state
+          #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisState]
+          #     The analysis state of this resource.
+          class Resource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An IAM role or permission under analysis.
+          # @!attribute [rw] role
+          #   @return [::String]
+          #     The role.
+          # @!attribute [rw] permission
+          #   @return [::String]
+          #     The permission.
+          # @!attribute [rw] analysis_state
+          #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisState]
+          #     The analysis state of this access.
+          class Access
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An identity under analysis.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The identity name in any form of members appear in
+          #     [IAM policy
+          #     binding](https://cloud.google.com/iam/reference/rest/v1/Binding), such
+          #     as:
+          #     - user:foo@google.com
+          #     - group:group1@google.com
+          #     - serviceAccount:s1@prj1.iam.gserviceaccount.com
+          #     - projectOwner:some_project_id
+          #     - domain:google.com
+          #     - allUsers
+          #     - etc.
+          # @!attribute [rw] analysis_state
+          #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisState]
+          #     The analysis state of this identity.
+          class Identity
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A directional edge.
+          # @!attribute [rw] source_node
+          #   @return [::String]
+          #     The source node of the edge. For example, it could be a full resource
+          #     name for a resource node or an email of an identity.
+          # @!attribute [rw] target_node
+          #   @return [::String]
+          #     The target node of the edge. For example, it could be a full resource
+          #     name for a resource node or an email of an identity.
+          class Edge
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An access control list, derived from the above IAM policy binding, which
+          # contains a set of resources and accesses. May include one
+          # item from each set to compose an access control entry.
+          #
+          # NOTICE that there could be multiple access control lists for one IAM policy
+          # binding. The access control lists are created based on resource and access
+          # combinations.
+          #
+          # For example, assume we have the following cases in one IAM policy binding:
+          # - Permission P1 and P2 apply to resource R1 and R2;
+          # - Permission P3 applies to resource R2 and R3;
+          #
+          # This will result in the following access control lists:
+          # - AccessControlList 1: [R1, R2], [P1, P2]
+          # - AccessControlList 2: [R2, R3], [P3]
+          # @!attribute [rw] resources
+          #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Resource>]
+          #     The resources that match one of the following conditions:
+          #     - The resource_selector, if it is specified in request;
+          #     - Otherwise, resources reachable from the policy attached resource.
+          # @!attribute [rw] accesses
+          #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Access>]
+          #     The accesses that match one of the following conditions:
+          #     - The access_selector, if it is specified in request;
+          #     - Otherwise, access specifiers reachable from the policy binding's role.
+          # @!attribute [rw] resource_edges
+          #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge>]
+          #     Resource edges of the graph starting from the policy attached
+          #     resource to any descendant resources. The {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge#source_node Edge.source_node} contains
+          #     the full resource name of a parent resource and {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge#target_node Edge.target_node}
+          #     contains the full resource name of a child resource. This field is
+          #     present only if the output_resource_edges option is enabled in request.
+          class AccessControlList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The identities and group edges.
+          # @!attribute [rw] identities
+          #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Identity>]
+          #     Only the identities that match one of the following conditions will be
+          #     presented:
+          #     - The identity_selector, if it is specified in request;
+          #     - Otherwise, identities reachable from the policy binding's members.
+          # @!attribute [rw] group_edges
+          #   @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge>]
+          #     Group identity edges of the graph starting from the binding's
+          #     group members to any node of the {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::IdentityList#identities identities}. The {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge#source_node Edge.source_node}
+          #     contains a group, such as `group:parent@google.com`. The
+          #     {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult::Edge#target_node Edge.target_node} contains a member of the group,
+          #     such as `group:child@google.com` or `user:foo@google.com`.
+          #     This field is present only if the output_group_edges option is enabled in
+          #     request.
+          class IdentityList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

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