google-cloud-video_intelligence-v1beta2 0.1.0

data/lib/google/cloud/videointelligence/v1beta2/video_intelligence_pb.rb

@@ -0,0 +1,170 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/videointelligence/v1beta2/video_intelligence.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/rpc/status_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/videointelligence/v1beta2/video_intelligence.proto", :syntax => :proto3) do
+    add_message "google.cloud.videointelligence.v1beta2.AnnotateVideoRequest" do
+      optional :input_uri, :string, 1
+      optional :input_content, :bytes, 6
+      repeated :features, :enum, 2, "google.cloud.videointelligence.v1beta2.Feature"
+      optional :video_context, :message, 3, "google.cloud.videointelligence.v1beta2.VideoContext"
+      optional :output_uri, :string, 4
+      optional :location_id, :string, 5
+    end
+    add_message "google.cloud.videointelligence.v1beta2.VideoContext" do
+      repeated :segments, :message, 1, "google.cloud.videointelligence.v1beta2.VideoSegment"
+      optional :label_detection_config, :message, 2, "google.cloud.videointelligence.v1beta2.LabelDetectionConfig"
+      optional :shot_change_detection_config, :message, 3, "google.cloud.videointelligence.v1beta2.ShotChangeDetectionConfig"
+      optional :explicit_content_detection_config, :message, 4, "google.cloud.videointelligence.v1beta2.ExplicitContentDetectionConfig"
+      optional :face_detection_config, :message, 5, "google.cloud.videointelligence.v1beta2.FaceDetectionConfig"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.LabelDetectionConfig" do
+      optional :label_detection_mode, :enum, 1, "google.cloud.videointelligence.v1beta2.LabelDetectionMode"
+      optional :stationary_camera, :bool, 2
+      optional :model, :string, 3
+    end
+    add_message "google.cloud.videointelligence.v1beta2.ShotChangeDetectionConfig" do
+      optional :model, :string, 1
+    end
+    add_message "google.cloud.videointelligence.v1beta2.ExplicitContentDetectionConfig" do
+      optional :model, :string, 1
+    end
+    add_message "google.cloud.videointelligence.v1beta2.FaceDetectionConfig" do
+      optional :model, :string, 1
+      optional :include_bounding_boxes, :bool, 2
+    end
+    add_message "google.cloud.videointelligence.v1beta2.VideoSegment" do
+      optional :start_time_offset, :message, 1, "google.protobuf.Duration"
+      optional :end_time_offset, :message, 2, "google.protobuf.Duration"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.LabelSegment" do
+      optional :segment, :message, 1, "google.cloud.videointelligence.v1beta2.VideoSegment"
+      optional :confidence, :float, 2
+    end
+    add_message "google.cloud.videointelligence.v1beta2.LabelFrame" do
+      optional :time_offset, :message, 1, "google.protobuf.Duration"
+      optional :confidence, :float, 2
+    end
+    add_message "google.cloud.videointelligence.v1beta2.Entity" do
+      optional :entity_id, :string, 1
+      optional :description, :string, 2
+      optional :language_code, :string, 3
+    end
+    add_message "google.cloud.videointelligence.v1beta2.LabelAnnotation" do
+      optional :entity, :message, 1, "google.cloud.videointelligence.v1beta2.Entity"
+      repeated :category_entities, :message, 2, "google.cloud.videointelligence.v1beta2.Entity"
+      repeated :segments, :message, 3, "google.cloud.videointelligence.v1beta2.LabelSegment"
+      repeated :frames, :message, 4, "google.cloud.videointelligence.v1beta2.LabelFrame"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.ExplicitContentFrame" do
+      optional :time_offset, :message, 1, "google.protobuf.Duration"
+      optional :pornography_likelihood, :enum, 2, "google.cloud.videointelligence.v1beta2.Likelihood"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.ExplicitContentAnnotation" do
+      repeated :frames, :message, 1, "google.cloud.videointelligence.v1beta2.ExplicitContentFrame"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.NormalizedBoundingBox" do
+      optional :left, :float, 1
+      optional :top, :float, 2
+      optional :right, :float, 3
+      optional :bottom, :float, 4
+    end
+    add_message "google.cloud.videointelligence.v1beta2.FaceSegment" do
+      optional :segment, :message, 1, "google.cloud.videointelligence.v1beta2.VideoSegment"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.FaceFrame" do
+      repeated :normalized_bounding_boxes, :message, 1, "google.cloud.videointelligence.v1beta2.NormalizedBoundingBox"
+      optional :time_offset, :message, 2, "google.protobuf.Duration"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.FaceAnnotation" do
+      optional :thumbnail, :bytes, 1
+      repeated :segments, :message, 2, "google.cloud.videointelligence.v1beta2.FaceSegment"
+      repeated :frames, :message, 3, "google.cloud.videointelligence.v1beta2.FaceFrame"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.VideoAnnotationResults" do
+      optional :input_uri, :string, 1
+      repeated :segment_label_annotations, :message, 2, "google.cloud.videointelligence.v1beta2.LabelAnnotation"
+      repeated :shot_label_annotations, :message, 3, "google.cloud.videointelligence.v1beta2.LabelAnnotation"
+      repeated :frame_label_annotations, :message, 4, "google.cloud.videointelligence.v1beta2.LabelAnnotation"
+      repeated :face_annotations, :message, 5, "google.cloud.videointelligence.v1beta2.FaceAnnotation"
+      repeated :shot_annotations, :message, 6, "google.cloud.videointelligence.v1beta2.VideoSegment"
+      optional :explicit_annotation, :message, 7, "google.cloud.videointelligence.v1beta2.ExplicitContentAnnotation"
+      optional :error, :message, 9, "google.rpc.Status"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.AnnotateVideoResponse" do
+      repeated :annotation_results, :message, 1, "google.cloud.videointelligence.v1beta2.VideoAnnotationResults"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.VideoAnnotationProgress" do
+      optional :input_uri, :string, 1
+      optional :progress_percent, :int32, 2
+      optional :start_time, :message, 3, "google.protobuf.Timestamp"
+      optional :update_time, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.videointelligence.v1beta2.AnnotateVideoProgress" do
+      repeated :annotation_progress, :message, 1, "google.cloud.videointelligence.v1beta2.VideoAnnotationProgress"
+    end
+    add_enum "google.cloud.videointelligence.v1beta2.Feature" do
+      value :FEATURE_UNSPECIFIED, 0
+      value :LABEL_DETECTION, 1
+      value :SHOT_CHANGE_DETECTION, 2
+      value :EXPLICIT_CONTENT_DETECTION, 3
+      value :FACE_DETECTION, 4
+    end
+    add_enum "google.cloud.videointelligence.v1beta2.LabelDetectionMode" do
+      value :LABEL_DETECTION_MODE_UNSPECIFIED, 0
+      value :SHOT_MODE, 1
+      value :FRAME_MODE, 2
+      value :SHOT_AND_FRAME_MODE, 3
+    end
+    add_enum "google.cloud.videointelligence.v1beta2.Likelihood" do
+      value :LIKELIHOOD_UNSPECIFIED, 0
+      value :VERY_UNLIKELY, 1
+      value :UNLIKELY, 2
+      value :POSSIBLE, 3
+      value :LIKELY, 4
+      value :VERY_LIKELY, 5
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module VideoIntelligence
+      module V1beta2
+        AnnotateVideoRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.AnnotateVideoRequest").msgclass
+        VideoContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.VideoContext").msgclass
+        LabelDetectionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.LabelDetectionConfig").msgclass
+        ShotChangeDetectionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.ShotChangeDetectionConfig").msgclass
+        ExplicitContentDetectionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.ExplicitContentDetectionConfig").msgclass
+        FaceDetectionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.FaceDetectionConfig").msgclass
+        VideoSegment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.VideoSegment").msgclass
+        LabelSegment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.LabelSegment").msgclass
+        LabelFrame = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.LabelFrame").msgclass
+        Entity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.Entity").msgclass
+        LabelAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.LabelAnnotation").msgclass
+        ExplicitContentFrame = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.ExplicitContentFrame").msgclass
+        ExplicitContentAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.ExplicitContentAnnotation").msgclass
+        NormalizedBoundingBox = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.NormalizedBoundingBox").msgclass
+        FaceSegment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.FaceSegment").msgclass
+        FaceFrame = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.FaceFrame").msgclass
+        FaceAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.FaceAnnotation").msgclass
+        VideoAnnotationResults = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.VideoAnnotationResults").msgclass
+        AnnotateVideoResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.AnnotateVideoResponse").msgclass
+        VideoAnnotationProgress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.VideoAnnotationProgress").msgclass
+        AnnotateVideoProgress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.AnnotateVideoProgress").msgclass
+        Feature = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.Feature").enummodule
+        LabelDetectionMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.LabelDetectionMode").enummodule
+        Likelihood = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.videointelligence.v1beta2.Likelihood").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/videointelligence/v1beta2/video_intelligence_services_pb.rb

@@ -0,0 +1,49 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/videointelligence/v1beta2/video_intelligence.proto for package 'Google.Cloud.VideoIntelligence.V1beta2'
+# 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/cloud/videointelligence/v1beta2/video_intelligence_pb'
+
+module Google
+  module Cloud
+    module VideoIntelligence
+      module V1beta2
+        module VideoIntelligenceService
+          # Service that implements Google Cloud Video Intelligence API.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.videointelligence.v1beta2.VideoIntelligenceService'
+
+            # Performs asynchronous video annotation. Progress and results can be
+            # retrieved through the `google.longrunning.Operations` interface.
+            # `Operation.metadata` contains `AnnotateVideoProgress` (progress).
+            # `Operation.response` contains `AnnotateVideoResponse` (results).
+            rpc :AnnotateVideo, Google::Cloud::VideoIntelligence::V1beta2::AnnotateVideoRequest, Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google-cloud-video_intelligence-v1beta2.rb

@@ -0,0 +1,21 @@
+# 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!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/video_intelligence/v1beta2"

data/proto_docs/README.md

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