google-cloud-redis-v1beta1 0.1.0

data/lib/google/cloud/redis/v1beta1/cloud_redis/paths.rb

@@ -0,0 +1,69 @@
+# 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 Redis
+      module V1beta1
+        module CloudRedis
+          # Path helper methods for the CloudRedis API.
+          module Paths
+            ##
+            # Create a fully-qualified Instance resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/instances/{instance}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param instance [String]
+            #
+            # @return [String]
+            def instance_path project:, location:, instance:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/instances/#{instance}"
+            end
+
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [String]
+            def location_path project:, location:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1beta1/cloud_redis_pb.rb

@@ -0,0 +1,155 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/redis/v1beta1/cloud_redis.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/redis/v1beta1/cloud_redis.proto", :syntax => :proto3) do
+    add_message "google.cloud.redis.v1beta1.Instance" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      map :labels, :string, :string, 3
+      optional :location_id, :string, 4
+      optional :alternative_location_id, :string, 5
+      optional :redis_version, :string, 7
+      optional :reserved_ip_range, :string, 9
+      optional :host, :string, 10
+      optional :port, :int32, 11
+      optional :current_location_id, :string, 12
+      optional :create_time, :message, 13, "google.protobuf.Timestamp"
+      optional :state, :enum, 14, "google.cloud.redis.v1beta1.Instance.State"
+      optional :status_message, :string, 15
+      map :redis_configs, :string, :string, 16
+      optional :tier, :enum, 17, "google.cloud.redis.v1beta1.Instance.Tier"
+      optional :memory_size_gb, :int32, 18
+      optional :authorized_network, :string, 20
+      optional :persistence_iam_identity, :string, 21
+      optional :connect_mode, :enum, 22, "google.cloud.redis.v1beta1.Instance.ConnectMode"
+    end
+    add_enum "google.cloud.redis.v1beta1.Instance.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :READY, 2
+      value :UPDATING, 3
+      value :DELETING, 4
+      value :REPAIRING, 5
+      value :MAINTENANCE, 6
+      value :IMPORTING, 8
+      value :FAILING_OVER, 10
+    end
+    add_enum "google.cloud.redis.v1beta1.Instance.Tier" do
+      value :TIER_UNSPECIFIED, 0
+      value :BASIC, 1
+      value :STANDARD_HA, 3
+    end
+    add_enum "google.cloud.redis.v1beta1.Instance.ConnectMode" do
+      value :CONNECT_MODE_UNSPECIFIED, 0
+      value :DIRECT_PEERING, 1
+      value :PRIVATE_SERVICE_ACCESS, 2
+    end
+    add_message "google.cloud.redis.v1beta1.ListInstancesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.redis.v1beta1.ListInstancesResponse" do
+      repeated :instances, :message, 1, "google.cloud.redis.v1beta1.Instance"
+      optional :next_page_token, :string, 2
+      repeated :unreachable, :string, 3
+    end
+    add_message "google.cloud.redis.v1beta1.GetInstanceRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.redis.v1beta1.CreateInstanceRequest" do
+      optional :parent, :string, 1
+      optional :instance_id, :string, 2
+      optional :instance, :message, 3, "google.cloud.redis.v1beta1.Instance"
+    end
+    add_message "google.cloud.redis.v1beta1.UpdateInstanceRequest" do
+      optional :update_mask, :message, 1, "google.protobuf.FieldMask"
+      optional :instance, :message, 2, "google.cloud.redis.v1beta1.Instance"
+    end
+    add_message "google.cloud.redis.v1beta1.UpgradeInstanceRequest" do
+      optional :name, :string, 1
+      optional :redis_version, :string, 2
+    end
+    add_message "google.cloud.redis.v1beta1.DeleteInstanceRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.redis.v1beta1.GcsSource" do
+      optional :uri, :string, 1
+    end
+    add_message "google.cloud.redis.v1beta1.InputConfig" do
+      oneof :source do
+        optional :gcs_source, :message, 1, "google.cloud.redis.v1beta1.GcsSource"
+      end
+    end
+    add_message "google.cloud.redis.v1beta1.ImportInstanceRequest" do
+      optional :name, :string, 1
+      optional :input_config, :message, 3, "google.cloud.redis.v1beta1.InputConfig"
+    end
+    add_message "google.cloud.redis.v1beta1.GcsDestination" do
+      optional :uri, :string, 1
+    end
+    add_message "google.cloud.redis.v1beta1.OutputConfig" do
+      oneof :destination do
+        optional :gcs_destination, :message, 1, "google.cloud.redis.v1beta1.GcsDestination"
+      end
+    end
+    add_message "google.cloud.redis.v1beta1.ExportInstanceRequest" do
+      optional :name, :string, 1
+      optional :output_config, :message, 3, "google.cloud.redis.v1beta1.OutputConfig"
+    end
+    add_message "google.cloud.redis.v1beta1.FailoverInstanceRequest" do
+      optional :name, :string, 1
+      optional :data_protection_mode, :enum, 2, "google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode"
+    end
+    add_enum "google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode" do
+      value :DATA_PROTECTION_MODE_UNSPECIFIED, 0
+      value :LIMITED_DATA_LOSS, 1
+      value :FORCE_DATA_LOSS, 2
+    end
+    add_message "google.cloud.redis.v1beta1.LocationMetadata" do
+      map :available_zones, :string, :message, 1, "google.cloud.redis.v1beta1.ZoneMetadata"
+    end
+    add_message "google.cloud.redis.v1beta1.ZoneMetadata" do
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Redis
+      module V1beta1
+        Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance").msgclass
+        Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.State").enummodule
+        Instance::Tier = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.Tier").enummodule
+        Instance::ConnectMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.ConnectMode").enummodule
+        ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ListInstancesRequest").msgclass
+        ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ListInstancesResponse").msgclass
+        GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.GetInstanceRequest").msgclass
+        CreateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.CreateInstanceRequest").msgclass
+        UpdateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.UpdateInstanceRequest").msgclass
+        UpgradeInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.UpgradeInstanceRequest").msgclass
+        DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.DeleteInstanceRequest").msgclass
+        GcsSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.GcsSource").msgclass
+        InputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.InputConfig").msgclass
+        ImportInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ImportInstanceRequest").msgclass
+        GcsDestination = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.GcsDestination").msgclass
+        OutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.OutputConfig").msgclass
+        ExportInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ExportInstanceRequest").msgclass
+        FailoverInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.FailoverInstanceRequest").msgclass
+        FailoverInstanceRequest::DataProtectionMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode").enummodule
+        LocationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.LocationMetadata").msgclass
+        ZoneMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ZoneMetadata").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1beta1/cloud_redis_services_pb.rb

@@ -0,0 +1,113 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/redis/v1beta1/cloud_redis.proto for package 'google.cloud.redis.v1beta1'
+# 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/redis/v1beta1/cloud_redis_pb'
+
+module Google
+  module Cloud
+    module Redis
+      module V1beta1
+        module CloudRedis
+          # Configures and manages Cloud Memorystore for Redis instances
+          #
+          # Google Cloud Memorystore for Redis v1beta1
+          #
+          # The `redis.googleapis.com` service implements the Google Cloud Memorystore
+          # for Redis API and defines the following resource model for managing Redis
+          # instances:
+          # * The service works with a collection of cloud projects, named: `/projects/*`
+          # * Each project has a collection of available locations, named: `/locations/*`
+          # * Each location has a collection of Redis instances, named: `/instances/*`
+          # * As such, Redis instances are resources of the form:
+          #   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
+          #
+          # Note that location_id must be refering to a GCP `region`; for example:
+          # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.redis.v1beta1.CloudRedis'
+
+            # Lists all Redis instances owned by a project in either the specified
+            # location (region) or all locations.
+            #
+            # The location should have the following format:
+            #
+            # * `projects/{project_id}/locations/{location_id}`
+            #
+            # If `location_id` is specified as `-` (wildcard), then all regions
+            # available to the project are queried, and the results are aggregated.
+            rpc :ListInstances, ListInstancesRequest, ListInstancesResponse
+            # Gets the details of a specific Redis instance.
+            rpc :GetInstance, GetInstanceRequest, Instance
+            # Creates a Redis instance based on the specified tier and memory size.
+            #
+            # By default, the instance is accessible from the project's
+            # [default network](/compute/docs/networks-and-firewalls#networks).
+            #
+            # The creation is executed asynchronously and callers may check the returned
+            # operation to track its progress. Once the operation is completed the Redis
+            # instance will be fully functional. Completed longrunning.Operation will
+            # contain the new instance object in the response field.
+            #
+            # The returned operation is automatically deleted after a few hours, so there
+            # is no need to call DeleteOperation.
+            rpc :CreateInstance, CreateInstanceRequest, Google::Longrunning::Operation
+            # Updates the metadata and configuration of a specific Redis instance.
+            #
+            # Completed longrunning.Operation will contain the new instance object
+            # in the response field. The returned operation is automatically deleted
+            # after a few hours, so there is no need to call DeleteOperation.
+            rpc :UpdateInstance, UpdateInstanceRequest, Google::Longrunning::Operation
+            # Upgrades Redis instance to the newer Redis version specified in the
+            # request.
+            rpc :UpgradeInstance, UpgradeInstanceRequest, Google::Longrunning::Operation
+            # Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
+            #
+            # Redis may stop serving during this operation. Instance state will be
+            # IMPORTING for entire operation. When complete, the instance will contain
+            # only data from the imported file.
+            #
+            # The returned operation is automatically deleted after a few hours, so
+            # there is no need to call DeleteOperation.
+            rpc :ImportInstance, ImportInstanceRequest, Google::Longrunning::Operation
+            # Export Redis instance data into a Redis RDB format file in Cloud Storage.
+            #
+            # Redis will continue serving during this operation.
+            #
+            # The returned operation is automatically deleted after a few hours, so
+            # there is no need to call DeleteOperation.
+            rpc :ExportInstance, ExportInstanceRequest, Google::Longrunning::Operation
+            # Initiates a failover of the master node to current replica node for a
+            # specific STANDARD tier Cloud Memorystore for Redis instance.
+            rpc :FailoverInstance, FailoverInstanceRequest, Google::Longrunning::Operation
+            # Deletes a specific Redis instance.  Instance stops serving and data is
+            # deleted.
+            rpc :DeleteInstance, DeleteInstanceRequest, Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1beta1/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 Redis
+      module V1beta1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Google Cloud Memorystore for Redis V1beta1 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