google-cloud-access_approval-v1 0.1.0

data/lib/google/cloud/access_approval/v1/access_approval/credentials.rb

@@ -0,0 +1,51 @@
+# 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!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module AccessApproval
+      module V1
+        module AccessApproval
+          # Credentials for the AccessApproval API.
+          class Credentials < Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "ACCESS_APPROVAL_CREDENTIALS",
+              "ACCESS_APPROVAL_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "ACCESS_APPROVAL_CREDENTIALS_JSON",
+              "ACCESS_APPROVAL_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/access_approval/v1/version.rb

@@ -0,0 +1,28 @@
+# 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 AccessApproval
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/google/cloud/accessapproval/v1/accessapproval_pb.rb

@@ -0,0 +1,123 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/accessapproval/v1/accessapproval.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/accessapproval/v1/accessapproval.proto", :syntax => :proto3) do
+    add_message "google.cloud.accessapproval.v1.AccessLocations" do
+      optional :principal_office_country, :string, 1
+      optional :principal_physical_location_country, :string, 2
+    end
+    add_message "google.cloud.accessapproval.v1.AccessReason" do
+      optional :type, :enum, 1, "google.cloud.accessapproval.v1.AccessReason.Type"
+      optional :detail, :string, 2
+    end
+    add_enum "google.cloud.accessapproval.v1.AccessReason.Type" do
+      value :TYPE_UNSPECIFIED, 0
+      value :CUSTOMER_INITIATED_SUPPORT, 1
+      value :GOOGLE_INITIATED_SERVICE, 2
+      value :GOOGLE_INITIATED_REVIEW, 3
+    end
+    add_message "google.cloud.accessapproval.v1.ApproveDecision" do
+      optional :approve_time, :message, 1, "google.protobuf.Timestamp"
+      optional :expire_time, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.accessapproval.v1.DismissDecision" do
+      optional :dismiss_time, :message, 1, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.accessapproval.v1.ResourceProperties" do
+      optional :excludes_descendants, :bool, 1
+    end
+    add_message "google.cloud.accessapproval.v1.ApprovalRequest" do
+      optional :name, :string, 1
+      optional :requested_resource_name, :string, 2
+      optional :requested_resource_properties, :message, 9, "google.cloud.accessapproval.v1.ResourceProperties"
+      optional :requested_reason, :message, 3, "google.cloud.accessapproval.v1.AccessReason"
+      optional :requested_locations, :message, 4, "google.cloud.accessapproval.v1.AccessLocations"
+      optional :request_time, :message, 5, "google.protobuf.Timestamp"
+      optional :requested_expiration, :message, 6, "google.protobuf.Timestamp"
+      oneof :decision do
+        optional :approve, :message, 7, "google.cloud.accessapproval.v1.ApproveDecision"
+        optional :dismiss, :message, 8, "google.cloud.accessapproval.v1.DismissDecision"
+      end
+    end
+    add_message "google.cloud.accessapproval.v1.EnrolledService" do
+      optional :cloud_product, :string, 1
+      optional :enrollment_level, :enum, 2, "google.cloud.accessapproval.v1.EnrollmentLevel"
+    end
+    add_message "google.cloud.accessapproval.v1.AccessApprovalSettings" do
+      optional :name, :string, 1
+      repeated :notification_emails, :string, 2
+      repeated :enrolled_services, :message, 3, "google.cloud.accessapproval.v1.EnrolledService"
+      optional :enrolled_ancestor, :bool, 4
+    end
+    add_message "google.cloud.accessapproval.v1.ListApprovalRequestsMessage" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :page_size, :int32, 3
+      optional :page_token, :string, 4
+    end
+    add_message "google.cloud.accessapproval.v1.ListApprovalRequestsResponse" do
+      repeated :approval_requests, :message, 1, "google.cloud.accessapproval.v1.ApprovalRequest"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.accessapproval.v1.GetApprovalRequestMessage" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.accessapproval.v1.ApproveApprovalRequestMessage" do
+      optional :name, :string, 1
+      optional :expire_time, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.accessapproval.v1.DismissApprovalRequestMessage" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.accessapproval.v1.GetAccessApprovalSettingsMessage" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.accessapproval.v1.UpdateAccessApprovalSettingsMessage" do
+      optional :settings, :message, 1, "google.cloud.accessapproval.v1.AccessApprovalSettings"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.accessapproval.v1.DeleteAccessApprovalSettingsMessage" do
+      optional :name, :string, 1
+    end
+    add_enum "google.cloud.accessapproval.v1.EnrollmentLevel" do
+      value :ENROLLMENT_LEVEL_UNSPECIFIED, 0
+      value :BLOCK_ALL, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module AccessApproval
+      module V1
+        AccessLocations = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.AccessLocations").msgclass
+        AccessReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.AccessReason").msgclass
+        AccessReason::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.AccessReason.Type").enummodule
+        ApproveDecision = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ApproveDecision").msgclass
+        DismissDecision = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.DismissDecision").msgclass
+        ResourceProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ResourceProperties").msgclass
+        ApprovalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ApprovalRequest").msgclass
+        EnrolledService = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.EnrolledService").msgclass
+        AccessApprovalSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.AccessApprovalSettings").msgclass
+        ListApprovalRequestsMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ListApprovalRequestsMessage").msgclass
+        ListApprovalRequestsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ListApprovalRequestsResponse").msgclass
+        GetApprovalRequestMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.GetApprovalRequestMessage").msgclass
+        ApproveApprovalRequestMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.ApproveApprovalRequestMessage").msgclass
+        DismissApprovalRequestMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.DismissApprovalRequestMessage").msgclass
+        GetAccessApprovalSettingsMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.GetAccessApprovalSettingsMessage").msgclass
+        UpdateAccessApprovalSettingsMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.UpdateAccessApprovalSettingsMessage").msgclass
+        DeleteAccessApprovalSettingsMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.DeleteAccessApprovalSettingsMessage").msgclass
+        EnrollmentLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.accessapproval.v1.EnrollmentLevel").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/accessapproval/v1/accessapproval_services_pb.rb

@@ -0,0 +1,109 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/accessapproval/v1/accessapproval.proto for package 'Google.Cloud.AccessApproval.V1'
+# Original file comments:
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/cloud/accessapproval/v1/accessapproval_pb'
+
+module Google
+  module Cloud
+    module AccessApproval
+      module V1
+        module AccessApproval
+          # This API allows a customer to manage accesses to cloud resources by
+          # Google personnel. It defines the following resource model:
+          #
+          # - The API has a collection of
+          #   [ApprovalRequest][google.cloud.accessapproval.v1.ApprovalRequest]
+          #   resources, named `approvalRequests/{approval_request_id}`
+          # - The API has top-level settings per Project/Folder/Organization, named
+          #   `accessApprovalSettings`
+          #
+          # The service also periodically emails a list of recipients, defined at the
+          # Project/Folder/Organization level in the accessApprovalSettings, when there
+          # is a pending ApprovalRequest for them to act on. The ApprovalRequests can
+          # also optionally be published to a Cloud Pub/Sub topic owned by the customer
+          # (for Beta, the Pub/Sub setup is managed manually).
+          #
+          # ApprovalRequests can be approved or dismissed. Google personel can only
+          # access the indicated resource or resources if the request is approved
+          # (subject to some exclusions:
+          # https://cloud.google.com/access-approval/docs/overview#exclusions).
+          #
+          # Note: Using Access Approval functionality will mean that Google may not be
+          # able to meet the SLAs for your chosen products, as any support response times
+          # may be dramatically increased. As such the SLAs do not apply to any service
+          # disruption to the extent impacted by Customer's use of Access Approval. Do
+          # not enable Access Approval for projects where you may require high service
+          # availability and rapid response by Google Cloud Support.
+          #
+          # After a request is approved or dismissed, no further action may be taken on
+          # it. Requests with the requested_expiration in the past or with no activity
+          # for 14 days are considered dismissed. When an approval expires, the request
+          # is considered dismissed.
+          #
+          # If a request is not approved or dismissed, we call it pending.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.accessapproval.v1.AccessApproval'
+
+            # Lists approval requests associated with a project, folder, or organization.
+            # Approval requests can be filtered by state (pending, active, dismissed).
+            # The order is reverse chronological.
+            rpc :ListApprovalRequests, Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage, Google::Cloud::AccessApproval::V1::ListApprovalRequestsResponse
+            # Gets an approval request. Returns NOT_FOUND if the request does not exist.
+            rpc :GetApprovalRequest, Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage, Google::Cloud::AccessApproval::V1::ApprovalRequest
+            # Approves a request and returns the updated ApprovalRequest.
+            #
+            # Returns NOT_FOUND if the request does not exist. Returns
+            # FAILED_PRECONDITION if the request exists but is not in a pending state.
+            rpc :ApproveApprovalRequest, Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage, Google::Cloud::AccessApproval::V1::ApprovalRequest
+            # Dismisses a request. Returns the updated ApprovalRequest.
+            #
+            # NOTE: This does not deny access to the resource if another request has been
+            # made and approved. It is equivalent in effect to ignoring the request
+            # altogether.
+            #
+            # Returns NOT_FOUND if the request does not exist.
+            #
+            # Returns FAILED_PRECONDITION if the request exists but is not in a pending
+            # state.
+            rpc :DismissApprovalRequest, Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage, Google::Cloud::AccessApproval::V1::ApprovalRequest
+            # Gets the settings associated with a project, folder, or organization.
+            rpc :GetAccessApprovalSettings, Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage, Google::Cloud::AccessApproval::V1::AccessApprovalSettings
+            # Updates the settings associated with a project, folder, or organization.
+            # Settings to update are determined by the value of field_mask.
+            rpc :UpdateAccessApprovalSettings, Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage, Google::Cloud::AccessApproval::V1::AccessApprovalSettings
+            # Deletes the settings associated with a project, folder, or organization.
+            # This will have the effect of disabling Access Approval for the project,
+            # folder, or organization, but only if all ancestors also have Access
+            # Approval disabled. If Access Approval is enabled at a higher level of the
+            # hierarchy, then Access Approval will still be enabled at this level as
+            # the settings are inherited.
+            rpc :DeleteAccessApprovalSettings, Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage, Google::Protobuf::Empty
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/common_resources_pb.rb

@@ -0,0 +1,15 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/common_resources.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/common_resources.proto", :syntax => :proto3) do
+  end
+end
+
+module Google
+  module Cloud
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Access Approval API V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [Array<String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end