google-cloud-os_config-v1alpha 0.2.1 → 0.4.0

data/proto_docs/google/cloud/osconfig/v1alpha/os_policy_assignment_reports.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 V1alpha
+        # Get a report of the OS policy assignment for a VM instance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. API resource name for OS policy assignment report.
+        #
+        #     Format:
+        #     `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report`
+        #
+        #     For `{project}`, either `project-number` or `project-id` can be provided.
+        #     For `{instance_id}`, either Compute Engine `instance-id` or `instance-name`
+        #     can be provided.
+        #     For `{assignment_id}`, the OSPolicyAssignment id must be provided.
+        class GetOSPolicyAssignmentReportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # List the OS policy assignment reports for VM instances.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name.
+        #
+        #     Format:
+        #     `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports`
+        #
+        #     For `{project}`, either `project-number` or `project-id` can be provided.
+        #     For `{instance}`, either `instance-name`, `instance-id`, or `-` can be
+        #     provided. If '-' is provided, the response will include
+        #     OSPolicyAssignmentReports for all instances in the project/location.
+        #     For `{assignment}`, either `assignment-id` or `-` can be provided. If '-'
+        #     is provided, the response will include OSPolicyAssignmentReports for all
+        #     OSPolicyAssignments in the project/location.
+        #     Either \\{instance} or \\{assignment} must be `-`.
+        #
+        #     For example:
+        #     `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports`
+        #      returns all reports for the instance
+        #     `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports`
+        #      returns all the reports for the given assignment across all instances.
+        #     `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports`
+        #      returns all the reports for all assignments across all instances.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of results to return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     If provided, this field specifies the criteria that must be met by the
+        #     `OSPolicyAssignmentReport` API resource that is included in the response.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A pagination token returned from a previous call to the
+        #     `ListOSPolicyAssignmentReports` method that indicates where this listing
+        #     should continue from.
+        class ListOSPolicyAssignmentReportsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response message for listing OS Policy assignment reports including the
+        # page of results and page token.
+        # @!attribute [rw] os_policy_assignment_reports
+        #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport>]
+        #     List of OS policy assignment reports.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     The pagination token to retrieve the next page of OS policy assignment
+        #     report objects.
+        class ListOSPolicyAssignmentReportsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A report of the OS policy assignment status for a given instance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The `OSPolicyAssignmentReport` API resource name.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report`
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     The Compute Engine VM instance name.
+        # @!attribute [rw] os_policy_assignment
+        #   @return [::String]
+        #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
+        #     belongs to.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
+        # @!attribute [rw] os_policy_compliances
+        #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance>]
+        #     Compliance data for each `OSPolicy` that is applied to the VM.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp for when the report was last generated.
+        # @!attribute [rw] last_run_id
+        #   @return [::String]
+        #     Unique identifier of the last attempted run to apply the OS policies
+        #     associated with this assignment on the VM.
+        #
+        #     This ID is logged by the OS Config agent while applying the OS
+        #     policies associated with this assignment on the VM.
+        #     NOTE: If the service is unable to successfully connect to the agent for
+        #     this run, then this id will not be available in the agent logs.
+        class OSPolicyAssignmentReport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Compliance data for an OS policy
+          # @!attribute [rw] os_policy_id
+          #   @return [::String]
+          #     The OS policy id
+          # @!attribute [rw] compliance_state
+          #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::ComplianceState]
+          #     The compliance state of the OS policy.
+          # @!attribute [rw] compliance_state_reason
+          #   @return [::String]
+          #     The reason for the OS policy to be in an unknown compliance state.
+          #     This field is always populated when `compliance_state` is `UNKNOWN`.
+          #
+          #     If populated, the field can contain one of the following values:
+          #
+          #     * `vm-not-running`: The VM was not running.
+          #     * `os-policies-not-supported-by-agent`: The version of the OS Config
+          #     agent running on the VM does not support running OS policies.
+          #     * `no-agent-detected`: The OS Config agent is not detected for the VM.
+          #     * `resource-execution-errors`: The OS Config agent encountered errors
+          #     while executing one or more resources in the policy. See
+          #     `os_policy_resource_compliances` for details.
+          #     * `task-timeout`: The task sent to the agent to apply the policy timed
+          #     out.
+          #     * `unexpected-agent-state`: The OS Config agent did not report the final
+          #     status of the task that attempted to apply the policy. Instead, the agent
+          #     unexpectedly started working on a different task. This mostly happens
+          #     when the agent or VM unexpectedly restarts while applying OS policies.
+          #     * `internal-service-errors`: Internal service errors were encountered
+          #     while attempting to apply the policy.
+          # @!attribute [rw] os_policy_resource_compliances
+          #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance>]
+          #     Compliance data for each resource within the policy that is applied to
+          #     the VM.
+          class OSPolicyCompliance
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Compliance data for an OS policy resource.
+            # @!attribute [rw] os_policy_resource_id
+            #   @return [::String]
+            #     The ID of the OS policy resource.
+            # @!attribute [rw] config_steps
+            #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep>]
+            #     Ordered list of configuration completed by the agent for the OS policy
+            #     resource.
+            # @!attribute [rw] compliance_state
+            #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::ComplianceState]
+            #     The compliance state of the resource.
+            # @!attribute [rw] compliance_state_reason
+            #   @return [::String]
+            #     A reason for the resource to be in the given compliance state.
+            #     This field is always populated when `compliance_state` is `UNKNOWN`.
+            #
+            #     The following values are supported when `compliance_state == UNKNOWN`
+            #
+            #     * `execution-errors`: Errors were encountered by the agent while
+            #     executing the resource and the compliance state couldn't be
+            #     determined.
+            #     * `execution-skipped-by-agent`: Resource execution was skipped by the
+            #     agent because errors were encountered while executing prior resources
+            #     in the OS policy.
+            #     * `os-policy-execution-attempt-failed`: The execution of the OS policy
+            #     containing this resource failed and the compliance state couldn't be
+            #     determined.
+            # @!attribute [rw] exec_resource_output
+            #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::ExecResourceOutput]
+            #     ExecResource specific output.
+            class OSPolicyResourceCompliance
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Step performed by the OS Config agent for configuring an
+              # `OSPolicy` resource to its desired state.
+              # @!attribute [rw] type
+              #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
+              #     Configuration step type.
+              # @!attribute [rw] error_message
+              #   @return [::String]
+              #     An error message recorded during the execution of this step.
+              #     Only populated if errors were encountered during this step execution.
+              class OSPolicyResourceConfigStep
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Supported configuration step types
+                module Type
+                  # Default value. This value is unused.
+                  TYPE_UNSPECIFIED = 0
+
+                  # Checks for resource conflicts such as schema errors.
+                  VALIDATION = 1
+
+                  # Checks the current status of the desired state for a resource.
+                  DESIRED_STATE_CHECK = 2
+
+                  # Enforces the desired state for a resource that is not in desired
+                  # state.
+                  DESIRED_STATE_ENFORCEMENT = 3
+
+                  # Re-checks the status of the desired state. This check is done
+                  # for a resource after the enforcement of all OS policies.
+                  #
+                  # This step is used to determine the final desired state status for
+                  # the resource. It accounts for any resources that might have drifted
+                  # from their desired state due to side effects from executing other
+                  # resources.
+                  DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
+                end
+              end
+
+              # ExecResource specific output.
+              # @!attribute [rw] enforcement_output
+              #   @return [::String]
+              #     Output from enforcement phase output file (if run).
+              #     Output size is limited to 100K bytes.
+              class ExecResourceOutput
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Possible compliance states for a resource.
+              module ComplianceState
+                # The resource is in an unknown compliance state.
+                #
+                # To get more details about why the policy is in this state, review
+                # the output of the `compliance_state_reason` field.
+                UNKNOWN = 0
+
+                # Resource is compliant.
+                COMPLIANT = 1
+
+                # Resource is non-compliant.
+                NON_COMPLIANT = 2
+              end
+            end
+
+            # Possible compliance states for an os policy.
+            module ComplianceState
+              # The policy is in an unknown compliance state.
+              #
+              # Refer to the field `compliance_state_reason` to learn the exact reason
+              # for the policy to be in this compliance state.
+              UNKNOWN = 0
+
+              # Policy is compliant.
+              #
+              # The policy is compliant if all the underlying resources are also
+              # compliant.
+              COMPLIANT = 1
+
+              # Policy is non-compliant.
+              #
+              # The policy is non-compliant if one or more underlying resources are
+              # non-compliant.
+              NON_COMPLIANT = 2
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/osconfig/v1alpha/os_policy_assignments.rb

@@ -68,6 +68,10 @@ module Google
         # @!attribute [r] revision_create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The timestamp that the revision was created.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     The etag for this OS policy assignment.
+        #     If this is provided on update, it must match the server's etag.
         # @!attribute [r] rollout_state
         #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::RolloutState]
         #     Output only. OS policy assignment rollout state
@@ -122,14 +126,18 @@ module Google
             end
           end
 
-          # Message to represent the filters to select VMs for an assignment
+          # Filters to select target VMs for an assignment.
+          #
+          # If more than one filter criteria is specified below, a VM will be selected
+          # if and only if it satisfies all of them.
           # @!attribute [rw] all
           #   @return [::Boolean]
           #     Target all VMs in the project. If true, no other criteria is
           #     permitted.
           # @!attribute [rw] os_short_names
           #   @return [::Array<::String>]
-          #     A VM is included if it's OS short name matches with any of the
+          #     Deprecated. Use the `inventories` field instead.
+          #     A VM is selected if it's OS short name matches with any of the
           #     values provided in this list.
           # @!attribute [rw] inclusion_labels
           #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::LabelSet>]
@@ -143,13 +151,33 @@ module Google
           #
           #     If the list has more than one label set, the VM is excluded if any
           #     of the label sets are applicable for the VM.
+          # @!attribute [rw] inventories
+          #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::InstanceFilter::Inventory>]
+          #     List of inventories to select VMs.
           #
-          #     This filter is applied last in the filtering chain and therefore a
-          #     VM is guaranteed to be excluded if it satisfies one of the below
-          #     label sets.
+          #     A VM is selected if its inventory data matches at least one of the
+          #     following inventories.
           class InstanceFilter
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # VM inventory details.
+            # @!attribute [rw] os_short_name
+            #   @return [::String]
+            #     Required. The OS short name
+            # @!attribute [rw] os_version
+            #   @return [::String]
+            #     The OS version
+            #
+            #     Prefix matches are supported if asterisk(*) is provided as the
+            #     last character. For example, to match all versions with a major
+            #     version of `7`, specify the following value for this field `7.*`
+            #
+            #     An empty string matches all OS versions.
+            class Inventory
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # Message to configure the rollout at the zonal level for the OS policy

data/proto_docs/google/cloud/osconfig/v1alpha/vulnerability.rb

@@ -37,8 +37,8 @@ module Google
         #     Output only. List of vulnerabilities affecting the VM.
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The timestamp for when the last vulnerability report was
-        #     generated for the VM.
+        #     Output only. The timestamp for when the last vulnerability report was generated for the
+        #     VM.
         class VulnerabilityReport
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -69,6 +69,9 @@ module Google
           # @!attribute [rw] update_time
           #   @return [::Google::Protobuf::Timestamp]
           #     The timestamp for when the vulnerability was last modified.
+          # @!attribute [rw] items
+          #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::VulnerabilityReport::Vulnerability::Item>]
+          #     List of items affected by the vulnerability.
           class Vulnerability
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,11 +107,43 @@ module Google
               # @!attribute [rw] url
               #   @return [::String]
               #     The url of the reference.
+              # @!attribute [rw] source
+              #   @return [::String]
+              #     The source of the reference e.g. NVD.
               class Reference
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
             end
+
+            # OS inventory item that is affected by a vulnerability or fixed as a
+            # result of a vulnerability.
+            # @!attribute [rw] installed_inventory_item_id
+            #   @return [::String]
+            #     Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM.
+            #     This field displays the inventory items affected by this vulnerability.
+            #     If the vulnerability report was not updated after the VM inventory
+            #     update, these values might not display in VM inventory. For some
+            #     operating systems, this field might be empty.
+            # @!attribute [rw] available_inventory_item_id
+            #   @return [::String]
+            #     Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM.
+            #     If the vulnerability report was not updated after the VM inventory
+            #     update, these values might not display in VM inventory. If there is no
+            #     available fix, the field is empty. The `inventory_item` value specifies
+            #     the latest `SoftwarePackage` available to the VM that fixes the
+            #     vulnerability.
+            # @!attribute [rw] fixed_cpe_uri
+            #   @return [::String]
+            #     The recommended [CPE URI](https://cpe.mitre.org/specification/) update
+            #     that contains a fix for this vulnerability.
+            # @!attribute [rw] upstream_fix
+            #   @return [::String]
+            #     The upstream OS patch, packages or KB that fixes the vulnerability.
+            class Item
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
         end
 
@@ -134,11 +169,9 @@ module Google
         #   @return [::String]
         #     Required. The parent resource name.
         #
-        #     Format: `projects/{project}/locations/{location}/instances/{instance}`
+        #     Format: `projects/{project}/locations/{location}/instances/-`
         #
         #     For `{project}`, either `project-number` or `project-id` can be provided.
-        #     For `{instance}`, only `-` character is supported to list vulnerability
-        #     reports across VMs.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of results to return.

data/proto_docs/google/protobuf/any.rb

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-os_config-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,7 @@ files:
 - lib/google/cloud/osconfig/v1alpha/config_common_pb.rb
 - lib/google/cloud/osconfig/v1alpha/instance_os_policies_compliance_pb.rb
 - lib/google/cloud/osconfig/v1alpha/inventory_pb.rb
+- lib/google/cloud/osconfig/v1alpha/os_policy_assignment_reports_pb.rb
 - lib/google/cloud/osconfig/v1alpha/os_policy_assignments_pb.rb
 - lib/google/cloud/osconfig/v1alpha/os_policy_pb.rb
 - lib/google/cloud/osconfig/v1alpha/osconfig_common_pb.rb
@@ -194,6 +195,7 @@ files:
 - proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb
 - proto_docs/google/cloud/osconfig/v1alpha/inventory.rb
 - proto_docs/google/cloud/osconfig/v1alpha/os_policy.rb
+- proto_docs/google/cloud/osconfig/v1alpha/os_policy_assignment_reports.rb
 - proto_docs/google/cloud/osconfig/v1alpha/os_policy_assignments.rb
 - proto_docs/google/cloud/osconfig/v1alpha/osconfig_common.rb
 - proto_docs/google/cloud/osconfig/v1alpha/vulnerability.rb
@@ -217,14 +219,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud OS Config V1alpha API