google-cloud-spanner-v1 0.1.0

data/lib/google/spanner/v1/spanner_services_pb.rb

@@ -0,0 +1,180 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/spanner/v1/spanner.proto for package 'Google.Cloud.Spanner.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/spanner/v1/spanner_pb'
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        module Spanner
+          # Cloud Spanner API
+          #
+          # The Cloud Spanner API can be used to manage sessions and execute
+          # transactions on data stored in Cloud Spanner databases.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.spanner.v1.Spanner'
+
+            # Creates a new session. A session can be used to perform
+            # transactions that read and/or modify data in a Cloud Spanner database.
+            # Sessions are meant to be reused for many consecutive
+            # transactions.
+            #
+            # Sessions can only execute one transaction at a time. To execute
+            # multiple concurrent read-write/write-only transactions, create
+            # multiple sessions. Note that standalone reads and queries use a
+            # transaction internally, and count toward the one transaction
+            # limit.
+            #
+            # Active sessions use additional server resources, so it is a good idea to
+            # delete idle and unneeded sessions.
+            # Aside from explicit deletes, Cloud Spanner may delete sessions for which no
+            # operations are sent for more than an hour. If a session is deleted,
+            # requests to it return `NOT_FOUND`.
+            #
+            # Idle sessions can be kept alive by sending a trivial SQL query
+            # periodically, e.g., `"SELECT 1"`.
+            rpc :CreateSession, Google::Cloud::Spanner::V1::CreateSessionRequest, Google::Cloud::Spanner::V1::Session
+            # Creates multiple new sessions.
+            #
+            # This API can be used to initialize a session cache on the clients.
+            # See https://goo.gl/TgSFN2 for best practices on session cache management.
+            rpc :BatchCreateSessions, Google::Cloud::Spanner::V1::BatchCreateSessionsRequest, Google::Cloud::Spanner::V1::BatchCreateSessionsResponse
+            # Gets a session. Returns `NOT_FOUND` if the session does not exist.
+            # This is mainly useful for determining whether a session is still
+            # alive.
+            rpc :GetSession, Google::Cloud::Spanner::V1::GetSessionRequest, Google::Cloud::Spanner::V1::Session
+            # Lists all sessions in a given database.
+            rpc :ListSessions, Google::Cloud::Spanner::V1::ListSessionsRequest, Google::Cloud::Spanner::V1::ListSessionsResponse
+            # Ends a session, releasing server resources associated with it. This will
+            # asynchronously trigger cancellation of any operations that are running with
+            # this session.
+            rpc :DeleteSession, Google::Cloud::Spanner::V1::DeleteSessionRequest, Google::Protobuf::Empty
+            # Executes an SQL statement, returning all results in a single reply. This
+            # method cannot be used to return a result set larger than 10 MiB;
+            # if the query yields more data than that, the query fails with
+            # a `FAILED_PRECONDITION` error.
+            #
+            # Operations inside read-write transactions might return `ABORTED`. If
+            # this occurs, the application should restart the transaction from
+            # the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
+            #
+            # Larger result sets can be fetched in streaming fashion by calling
+            # [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
+            rpc :ExecuteSql, Google::Cloud::Spanner::V1::ExecuteSqlRequest, Google::Cloud::Spanner::V1::ResultSet
+            # Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result
+            # set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there
+            # is no limit on the size of the returned result set. However, no
+            # individual row in the result set can exceed 100 MiB, and no
+            # column value can exceed 10 MiB.
+            rpc :ExecuteStreamingSql, Google::Cloud::Spanner::V1::ExecuteSqlRequest, stream(Google::Cloud::Spanner::V1::PartialResultSet)
+            # Executes a batch of SQL DML statements. This method allows many statements
+            # to be run with lower latency than submitting them sequentially with
+            # [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
+            #
+            # Statements are executed in sequential order. A request can succeed even if
+            # a statement fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.ExecuteBatchDmlResponse.status] field in the
+            # response provides information about the statement that failed. Clients must
+            # inspect this field to determine whether an error occurred.
+            #
+            # Execution stops after the first failed statement; the remaining statements
+            # are not executed.
+            rpc :ExecuteBatchDml, Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest, Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse
+            # Reads rows from the database using key lookups and scans, as a
+            # simple key/value style alternative to
+            # [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].  This method cannot be used to
+            # return a result set larger than 10 MiB; if the read matches more
+            # data than that, the read fails with a `FAILED_PRECONDITION`
+            # error.
+            #
+            # Reads inside read-write transactions might return `ABORTED`. If
+            # this occurs, the application should restart the transaction from
+            # the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
+            #
+            # Larger result sets can be yielded in streaming fashion by calling
+            # [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
+            rpc :Read, Google::Cloud::Spanner::V1::ReadRequest, Google::Cloud::Spanner::V1::ResultSet
+            # Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a
+            # stream. Unlike [Read][google.spanner.v1.Spanner.Read], there is no limit on the
+            # size of the returned result set. However, no individual row in
+            # the result set can exceed 100 MiB, and no column value can exceed
+            # 10 MiB.
+            rpc :StreamingRead, Google::Cloud::Spanner::V1::ReadRequest, stream(Google::Cloud::Spanner::V1::PartialResultSet)
+            # Begins a new transaction. This step can often be skipped:
+            # [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
+            # [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a
+            # side-effect.
+            rpc :BeginTransaction, Google::Cloud::Spanner::V1::BeginTransactionRequest, Google::Cloud::Spanner::V1::Transaction
+            # Commits a transaction. The request includes the mutations to be
+            # applied to rows in the database.
+            #
+            # `Commit` might return an `ABORTED` error. This can occur at any time;
+            # commonly, the cause is conflicts with concurrent
+            # transactions. However, it can also happen for a variety of other
+            # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
+            # the transaction from the beginning, re-using the same session.
+            rpc :Commit, Google::Cloud::Spanner::V1::CommitRequest, Google::Cloud::Spanner::V1::CommitResponse
+            # Rolls back a transaction, releasing any locks it holds. It is a good
+            # idea to call this for any transaction that includes one or more
+            # [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and
+            # ultimately decides not to commit.
+            #
+            # `Rollback` returns `OK` if it successfully aborts the transaction, the
+            # transaction was already aborted, or the transaction is not
+            # found. `Rollback` never returns `ABORTED`.
+            rpc :Rollback, Google::Cloud::Spanner::V1::RollbackRequest, Google::Protobuf::Empty
+            # Creates a set of partition tokens that can be used to execute a query
+            # operation in parallel.  Each of the returned partition tokens can be used
+            # by [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] to specify a subset
+            # of the query result to read.  The same session and read-only transaction
+            # must be used by the PartitionQueryRequest used to create the
+            # partition tokens and the ExecuteSqlRequests that use the partition tokens.
+            #
+            # Partition tokens become invalid when the session used to create them
+            # is deleted, is idle for too long, begins a new transaction, or becomes too
+            # old.  When any of these happen, it is not possible to resume the query, and
+            # the whole operation must be restarted from the beginning.
+            rpc :PartitionQuery, Google::Cloud::Spanner::V1::PartitionQueryRequest, Google::Cloud::Spanner::V1::PartitionResponse
+            # Creates a set of partition tokens that can be used to execute a read
+            # operation in parallel.  Each of the returned partition tokens can be used
+            # by [StreamingRead][google.spanner.v1.Spanner.StreamingRead] to specify a subset of the read
+            # result to read.  The same session and read-only transaction must be used by
+            # the PartitionReadRequest used to create the partition tokens and the
+            # ReadRequests that use the partition tokens.  There are no ordering
+            # guarantees on rows returned among the returned partition tokens, or even
+            # within each individual StreamingRead call issued with a partition_token.
+            #
+            # Partition tokens become invalid when the session used to create them
+            # is deleted, is idle for too long, begins a new transaction, or becomes too
+            # old.  When any of these happen, it is not possible to resume the read, and
+            # the whole operation must be restarted from the beginning.
+            rpc :PartitionRead, Google::Cloud::Spanner::V1::PartitionReadRequest, Google::Cloud::Spanner::V1::PartitionResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/spanner/v1/transaction_pb.rb

@@ -0,0 +1,59 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/spanner/v1/transaction.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/spanner/v1/transaction.proto", :syntax => :proto3) do
+    add_message "google.spanner.v1.TransactionOptions" do
+      oneof :mode do
+        optional :read_write, :message, 1, "google.spanner.v1.TransactionOptions.ReadWrite"
+        optional :partitioned_dml, :message, 3, "google.spanner.v1.TransactionOptions.PartitionedDml"
+        optional :read_only, :message, 2, "google.spanner.v1.TransactionOptions.ReadOnly"
+      end
+    end
+    add_message "google.spanner.v1.TransactionOptions.ReadWrite" do
+    end
+    add_message "google.spanner.v1.TransactionOptions.PartitionedDml" do
+    end
+    add_message "google.spanner.v1.TransactionOptions.ReadOnly" do
+      optional :return_read_timestamp, :bool, 6
+      oneof :timestamp_bound do
+        optional :strong, :bool, 1
+        optional :min_read_timestamp, :message, 2, "google.protobuf.Timestamp"
+        optional :max_staleness, :message, 3, "google.protobuf.Duration"
+        optional :read_timestamp, :message, 4, "google.protobuf.Timestamp"
+        optional :exact_staleness, :message, 5, "google.protobuf.Duration"
+      end
+    end
+    add_message "google.spanner.v1.Transaction" do
+      optional :id, :bytes, 1
+      optional :read_timestamp, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.spanner.v1.TransactionSelector" do
+      oneof :selector do
+        optional :single_use, :message, 1, "google.spanner.v1.TransactionOptions"
+        optional :id, :bytes, 2
+        optional :begin, :message, 3, "google.spanner.v1.TransactionOptions"
+      end
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        TransactionOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions").msgclass
+        TransactionOptions::ReadWrite = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.ReadWrite").msgclass
+        TransactionOptions::PartitionedDml = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.PartitionedDml").msgclass
+        TransactionOptions::ReadOnly = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.ReadOnly").msgclass
+        Transaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.Transaction").msgclass
+        TransactionSelector = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionSelector").msgclass
+      end
+    end
+  end
+end

data/lib/google/spanner/v1/type_pb.rb

@@ -0,0 +1,47 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/spanner/v1/type.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/spanner/v1/type.proto", :syntax => :proto3) do
+    add_message "google.spanner.v1.Type" do
+      optional :code, :enum, 1, "google.spanner.v1.TypeCode"
+      optional :array_element_type, :message, 2, "google.spanner.v1.Type"
+      optional :struct_type, :message, 3, "google.spanner.v1.StructType"
+    end
+    add_message "google.spanner.v1.StructType" do
+      repeated :fields, :message, 1, "google.spanner.v1.StructType.Field"
+    end
+    add_message "google.spanner.v1.StructType.Field" do
+      optional :name, :string, 1
+      optional :type, :message, 2, "google.spanner.v1.Type"
+    end
+    add_enum "google.spanner.v1.TypeCode" do
+      value :TYPE_CODE_UNSPECIFIED, 0
+      value :BOOL, 1
+      value :INT64, 2
+      value :FLOAT64, 3
+      value :TIMESTAMP, 4
+      value :DATE, 5
+      value :STRING, 6
+      value :BYTES, 7
+      value :ARRAY, 8
+      value :STRUCT, 9
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.Type").msgclass
+        StructType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.StructType").msgclass
+        StructType::Field = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.StructType.Field").msgclass
+        TypeCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TypeCode").enummodule
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Spanner 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