google-cloud-datastore-admin-v1 0.1.0

data/lib/google/cloud/datastore/admin/v1/version.rb

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

data/lib/google/datastore/admin/v1/datastore_admin_pb.rb

@@ -0,0 +1,120 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/admin/v1/datastore_admin.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/datastore/admin/v1/index_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/datastore/admin/v1/datastore_admin.proto", :syntax => :proto3) do
+    add_message "google.datastore.admin.v1.CommonMetadata" do
+      optional :start_time, :message, 1, "google.protobuf.Timestamp"
+      optional :end_time, :message, 2, "google.protobuf.Timestamp"
+      optional :operation_type, :enum, 3, "google.datastore.admin.v1.OperationType"
+      map :labels, :string, :string, 4
+      optional :state, :enum, 5, "google.datastore.admin.v1.CommonMetadata.State"
+    end
+    add_enum "google.datastore.admin.v1.CommonMetadata.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :INITIALIZING, 1
+      value :PROCESSING, 2
+      value :CANCELLING, 3
+      value :FINALIZING, 4
+      value :SUCCESSFUL, 5
+      value :FAILED, 6
+      value :CANCELLED, 7
+    end
+    add_message "google.datastore.admin.v1.Progress" do
+      optional :work_completed, :int64, 1
+      optional :work_estimated, :int64, 2
+    end
+    add_message "google.datastore.admin.v1.ExportEntitiesRequest" do
+      optional :project_id, :string, 1
+      map :labels, :string, :string, 2
+      optional :entity_filter, :message, 3, "google.datastore.admin.v1.EntityFilter"
+      optional :output_url_prefix, :string, 4
+    end
+    add_message "google.datastore.admin.v1.ImportEntitiesRequest" do
+      optional :project_id, :string, 1
+      map :labels, :string, :string, 2
+      optional :input_url, :string, 3
+      optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
+    end
+    add_message "google.datastore.admin.v1.ExportEntitiesResponse" do
+      optional :output_url, :string, 1
+    end
+    add_message "google.datastore.admin.v1.ExportEntitiesMetadata" do
+      optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
+      optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
+      optional :progress_bytes, :message, 3, "google.datastore.admin.v1.Progress"
+      optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
+      optional :output_url_prefix, :string, 5
+    end
+    add_message "google.datastore.admin.v1.ImportEntitiesMetadata" do
+      optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
+      optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
+      optional :progress_bytes, :message, 3, "google.datastore.admin.v1.Progress"
+      optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
+      optional :input_url, :string, 5
+    end
+    add_message "google.datastore.admin.v1.EntityFilter" do
+      repeated :kinds, :string, 1
+      repeated :namespace_ids, :string, 2
+    end
+    add_message "google.datastore.admin.v1.GetIndexRequest" do
+      optional :project_id, :string, 1
+      optional :index_id, :string, 3
+    end
+    add_message "google.datastore.admin.v1.ListIndexesRequest" do
+      optional :project_id, :string, 1
+      optional :filter, :string, 3
+      optional :page_size, :int32, 4
+      optional :page_token, :string, 5
+    end
+    add_message "google.datastore.admin.v1.ListIndexesResponse" do
+      repeated :indexes, :message, 1, "google.datastore.admin.v1.Index"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.datastore.admin.v1.IndexOperationMetadata" do
+      optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
+      optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
+      optional :index_id, :string, 3
+    end
+    add_enum "google.datastore.admin.v1.OperationType" do
+      value :OPERATION_TYPE_UNSPECIFIED, 0
+      value :EXPORT_ENTITIES, 1
+      value :IMPORT_ENTITIES, 2
+      value :CREATE_INDEX, 3
+      value :DELETE_INDEX, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          CommonMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.CommonMetadata").msgclass
+          CommonMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.CommonMetadata.State").enummodule
+          Progress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Progress").msgclass
+          ExportEntitiesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesRequest").msgclass
+          ImportEntitiesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ImportEntitiesRequest").msgclass
+          ExportEntitiesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesResponse").msgclass
+          ExportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesMetadata").msgclass
+          ImportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ImportEntitiesMetadata").msgclass
+          EntityFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.EntityFilter").msgclass
+          GetIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.GetIndexRequest").msgclass
+          ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesRequest").msgclass
+          ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesResponse").msgclass
+          IndexOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.IndexOperationMetadata").msgclass
+          OperationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.OperationType").enummodule
+        end
+      end
+    end
+  end
+end

data/lib/google/datastore/admin/v1/datastore_admin_services_pb.rb

@@ -0,0 +1,126 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/datastore/admin/v1/datastore_admin.proto for package 'Google.Cloud.Datastore.Admin.V1'
+# Original file comments:
+# Copyright 2019 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/datastore/admin/v1/datastore_admin_pb'
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          module DatastoreAdmin
+            # Google Cloud Datastore Admin API
+            #
+            #
+            # The Datastore Admin API provides several admin services for Cloud Datastore.
+            #
+            # -----------------------------------------------------------------------------
+            # ## Concepts
+            #
+            # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
+            # API.
+            #
+            # Operation: An Operation represents work being performed in the background.
+            #
+            # EntityFilter: Allows specifying a subset of entities in a project. This is
+            # specified as a combination of kinds and namespaces (either or both of which
+            # may be all).
+            #
+            # -----------------------------------------------------------------------------
+            # ## Services
+            #
+            # # Export/Import
+            #
+            # The Export/Import service provides the ability to copy all or a subset of
+            # entities to/from Google Cloud Storage.
+            #
+            # Exported data may be imported into Cloud Datastore for any Google Cloud
+            # Platform project. It is not restricted to the export source project. It is
+            # possible to export from one project and then import into another.
+            #
+            # Exported data can also be loaded into Google BigQuery for analysis.
+            #
+            # Exports and imports are performed asynchronously. An Operation resource is
+            # created for each export/import. The state (including any errors encountered)
+            # of the export/import may be queried via the Operation resource.
+            #
+            # # Index
+            #
+            # The index service manages Cloud Datastore composite indexes.
+            #
+            # Index creation and deletion are performed asynchronously.
+            # An Operation resource is created for each such asynchronous operation.
+            # The state of the operation (including any errors encountered)
+            # may be queried via the Operation resource.
+            #
+            # # Operation
+            #
+            # The Operations collection provides a record of actions performed for the
+            # specified project (including any operations in progress). Operations are not
+            # created directly but through calls on other collections or resources.
+            #
+            # An operation that is not yet done may be cancelled. The request to cancel is
+            # asynchronous and the operation may continue to run for some time after the
+            # request to cancel is made.
+            #
+            # An operation that is done may be deleted so that it is no longer listed as
+            # part of the Operation collection.
+            #
+            # ListOperations returns all pending operations, but not completed operations.
+            #
+            # Operations are created by service DatastoreAdmin,
+            # but are accessed via service google.longrunning.Operations.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.datastore.admin.v1.DatastoreAdmin'
+
+              # Exports a copy of all or a subset of entities from Google Cloud Datastore
+              # to another storage system, such as Google Cloud Storage. Recent updates to
+              # entities may not be reflected in the export. The export occurs in the
+              # background and its progress can be monitored and managed via the
+              # Operation resource that is created. The output of an export may only be
+              # used once the associated operation is done. If an export operation is
+              # cancelled before completion it may leave partial data behind in Google
+              # Cloud Storage.
+              rpc :ExportEntities, Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest, Google::Longrunning::Operation
+              # Imports entities into Google Cloud Datastore. Existing entities with the
+              # same key are overwritten. The import occurs in the background and its
+              # progress can be monitored and managed via the Operation resource that is
+              # created. If an ImportEntities operation is cancelled, it is possible
+              # that a subset of the data has already been imported to Cloud Datastore.
+              rpc :ImportEntities, Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, Google::Longrunning::Operation
+              # Gets an index.
+              rpc :GetIndex, Google::Cloud::Datastore::Admin::V1::GetIndexRequest, Google::Cloud::Datastore::Admin::V1::Index
+              # Lists the indexes that match the specified filters.  Datastore uses an
+              # eventually consistent query to fetch the list of indexes and may
+              # occasionally return stale results.
+              rpc :ListIndexes, Google::Cloud::Datastore::Admin::V1::ListIndexesRequest, Google::Cloud::Datastore::Admin::V1::ListIndexesResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/datastore/admin/v1/index_pb.rb

@@ -0,0 +1,56 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/admin/v1/index.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/datastore/admin/v1/index.proto", :syntax => :proto3) do
+    add_message "google.datastore.admin.v1.Index" do
+      optional :project_id, :string, 1
+      optional :index_id, :string, 3
+      optional :kind, :string, 4
+      optional :ancestor, :enum, 5, "google.datastore.admin.v1.Index.AncestorMode"
+      repeated :properties, :message, 6, "google.datastore.admin.v1.Index.IndexedProperty"
+      optional :state, :enum, 7, "google.datastore.admin.v1.Index.State"
+    end
+    add_message "google.datastore.admin.v1.Index.IndexedProperty" do
+      optional :name, :string, 1
+      optional :direction, :enum, 2, "google.datastore.admin.v1.Index.Direction"
+    end
+    add_enum "google.datastore.admin.v1.Index.AncestorMode" do
+      value :ANCESTOR_MODE_UNSPECIFIED, 0
+      value :NONE, 1
+      value :ALL_ANCESTORS, 2
+    end
+    add_enum "google.datastore.admin.v1.Index.Direction" do
+      value :DIRECTION_UNSPECIFIED, 0
+      value :ASCENDING, 1
+      value :DESCENDING, 2
+    end
+    add_enum "google.datastore.admin.v1.Index.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :READY, 2
+      value :DELETING, 3
+      value :ERROR, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          Index = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index").msgclass
+          Index::IndexedProperty = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.IndexedProperty").msgclass
+          Index::AncestorMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.AncestorMode").enummodule
+          Index::Direction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.Direction").enummodule
+          Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.State").enummodule
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Firestore in Datastore mode Admin 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