google-cloud-os_config-v1 0.5.0 → 0.9.0

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

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+        # 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::V1::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::V1::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::V1::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::V1::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::V1::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::V1::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::V1::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::V1::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/v1/os_policy_assignments.rb

@@ -0,0 +1,392 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+        # OS policy assignment is an API resource that is used to
+        # apply a set of OS policies to a dynamically targeted group of Compute Engine
+        # VM instances.
+        #
+        # An OS policy is used to define the desired state configuration for a
+        # Compute Engine VM instance through a set of configuration resources that
+        # provide capabilities such as installing or removing software packages, or
+        # executing a script.
+        #
+        # For more information, see [OS policy and OS policy
+        # assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}`
+        #
+        #     This field is ignored when you create an OS policy assignment.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     OS policy assignment description.
+        #     Length of the description is limited to 1024 characters.
+        # @!attribute [rw] os_policies
+        #   @return [::Array<::Google::Cloud::OsConfig::V1::OSPolicy>]
+        #     Required. List of OS policies to be applied to the VMs.
+        # @!attribute [rw] instance_filter
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignment::InstanceFilter]
+        #     Required. Filter to select VMs.
+        # @!attribute [rw] rollout
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout]
+        #     Required. Rollout to deploy the OS policy assignment.
+        #     A rollout is triggered in the following situations:
+        #     1) OSPolicyAssignment is created.
+        #     2) OSPolicyAssignment is updated and the update contains changes to one of
+        #     the following fields:
+        #        - instance_filter
+        #        - os_policies
+        #     3) OSPolicyAssignment is deleted.
+        # @!attribute [r] revision_id
+        #   @return [::String]
+        #     Output only. The assignment revision ID
+        #     A new revision is committed whenever a rollout is triggered for a OS policy
+        #     assignment
+        # @!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::V1::OSPolicyAssignment::RolloutState]
+        #     Output only. OS policy assignment rollout state
+        # @!attribute [r] baseline
+        #   @return [::Boolean]
+        #     Output only. Indicates that this revision has been successfully rolled out
+        #     in this zone and new VMs will be assigned OS policies from this revision.
+        #
+        #     For a given OS policy assignment, there is only one revision with a value
+        #     of `true` for this field.
+        # @!attribute [r] deleted
+        #   @return [::Boolean]
+        #     Output only. Indicates that this revision deletes the OS policy assignment.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     Output only. Indicates that reconciliation is in progress for the revision.
+        #     This value is `true` when the `rollout_state` is one of:
+        #     * IN_PROGRESS
+        #     * CANCELLING
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated unique id for the OS policy assignment
+        #     resource.
+        class OSPolicyAssignment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Message representing label set.
+          # * A label is a key value pair set for a VM.
+          # * A LabelSet is a set of labels.
+          # * Labels within a LabelSet are ANDed. In other words, a LabelSet is
+          #   applicable for a VM only if it matches all the labels in the
+          #   LabelSet.
+          # * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will
+          #            only be applicable for those VMs with both labels
+          #            present.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Labels are identified by key/value pairs in this map.
+          #     A VM should contain all the key/value pairs specified in this
+          #     map to be selected.
+          class LabelSet
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # 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] inclusion_labels
+          #   @return [::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignment::LabelSet>]
+          #     List of label sets used for VM inclusion.
+          #
+          #     If the list has more than one `LabelSet`, the VM is included if any
+          #     of the label sets are applicable for the VM.
+          # @!attribute [rw] exclusion_labels
+          #   @return [::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignment::LabelSet>]
+          #     List of label sets used for VM exclusion.
+          #
+          #     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::V1::OSPolicyAssignment::InstanceFilter::Inventory>]
+          #     List of inventories to select VMs.
+          #
+          #     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
+          # assignment.
+          # @!attribute [rw] disruption_budget
+          #   @return [::Google::Cloud::OsConfig::V1::FixedOrPercent]
+          #     Required. The maximum number (or percentage) of VMs per zone to disrupt
+          #     at any given moment.
+          # @!attribute [rw] min_wait_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Required. This determines the minimum duration of time to wait after the
+          #     configuration changes are applied through the current rollout. A
+          #     VM continues to count towards the `disruption_budget` at least
+          #     until this duration of time has passed after configuration changes are
+          #     applied.
+          class Rollout
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # OS policy assignment rollout state
+          module RolloutState
+            # Invalid value
+            ROLLOUT_STATE_UNSPECIFIED = 0
+
+            # The rollout is in progress.
+            IN_PROGRESS = 1
+
+            # The rollout is being cancelled.
+            CANCELLING = 2
+
+            # The rollout is cancelled.
+            CANCELLED = 3
+
+            # The rollout has completed successfully.
+            SUCCEEDED = 4
+          end
+        end
+
+        # OS policy assignment operation metadata provided by OS policy assignment API
+        # methods that return long running operations.
+        # @!attribute [rw] os_policy_assignment
+        #   @return [::String]
+        #     Reference to the `OSPolicyAssignment` API resource.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
+        # @!attribute [rw] api_method
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentOperationMetadata::APIMethod]
+        #     The OS policy assignment API method.
+        # @!attribute [rw] rollout_state
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentOperationMetadata::RolloutState]
+        #     State of the rollout
+        # @!attribute [rw] rollout_start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Rollout start time
+        # @!attribute [rw] rollout_update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Rollout update time
+        class OSPolicyAssignmentOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The OS policy assignment API method.
+          module APIMethod
+            # Invalid value
+            API_METHOD_UNSPECIFIED = 0
+
+            # Create OS policy assignment API method
+            CREATE = 1
+
+            # Update OS policy assignment API method
+            UPDATE = 2
+
+            # Delete OS policy assignment API method
+            DELETE = 3
+          end
+
+          # State of the rollout
+          module RolloutState
+            # Invalid value
+            ROLLOUT_STATE_UNSPECIFIED = 0
+
+            # The rollout is in progress.
+            IN_PROGRESS = 1
+
+            # The rollout is being cancelled.
+            CANCELLING = 2
+
+            # The rollout is cancelled.
+            CANCELLED = 3
+
+            # The rollout has completed successfully.
+            SUCCEEDED = 4
+          end
+        end
+
+        # A request message to create an OS policy assignment
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name in the form:
+        #     projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] os_policy_assignment
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignment]
+        #     Required. The OS policy assignment to be created.
+        # @!attribute [rw] os_policy_assignment_id
+        #   @return [::String]
+        #     Required. The logical name of the OS policy assignment in the project
+        #     with the following restrictions:
+        #
+        #     * Must contain only lowercase letters, numbers, and hyphens.
+        #     * Must start with a letter.
+        #     * Must be between 1-63 characters.
+        #     * Must end with a number or a letter.
+        #     * Must be unique within the project.
+        class CreateOSPolicyAssignmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message to update an OS policy assignment
+        # @!attribute [rw] os_policy_assignment
+        #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignment]
+        #     Required. The updated OS policy assignment.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask that controls which fields of the assignment should be
+        #     updated.
+        class UpdateOSPolicyAssignmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message to get an OS policy assignment
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of OS policy assignment.
+        #
+        #     Format:
+        #     `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}`
+        class GetOSPolicyAssignmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message to list OS policy assignments for a parent resource
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of assignments to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A pagination token returned from a previous call to
+        #     `ListOSPolicyAssignments` that indicates where this listing should continue
+        #     from.
+        class ListOSPolicyAssignmentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response message for listing all assignments under given parent.
+        # @!attribute [rw] os_policy_assignments
+        #   @return [::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>]
+        #     The list of assignments
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     The pagination token to retrieve the next page of OS policy assignments.
+        class ListOSPolicyAssignmentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message to list revisions for a OS policy assignment
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the OS policy assignment to list revisions for.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of revisions to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A pagination token returned from a previous call to
+        #     `ListOSPolicyAssignmentRevisions` that indicates where this listing should
+        #     continue from.
+        class ListOSPolicyAssignmentRevisionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response message for listing all revisions for a OS policy assignment.
+        # @!attribute [rw] os_policy_assignments
+        #   @return [::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>]
+        #     The OS policy assignment revisions
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     The pagination token to retrieve the next page of OS policy assignment
+        #     revisions.
+        class ListOSPolicyAssignmentRevisionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for deleting a OS policy assignment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the OS policy assignment to be deleted
+        class DeleteOSPolicyAssignmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end