google-cloud-life_sciences-v2beta 0.1.0

data/lib/google/cloud/lifesciences/v2beta/workflows_pb.rb

@@ -0,0 +1,221 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/lifesciences/v2beta/workflows.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_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/code_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/lifesciences/v2beta/workflows.proto", :syntax => :proto3) do
+    add_message "google.cloud.lifesciences.v2beta.RunPipelineRequest" do
+      optional :parent, :string, 4
+      optional :pipeline, :message, 1, "google.cloud.lifesciences.v2beta.Pipeline"
+      map :labels, :string, :string, 2
+      optional :pub_sub_topic, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.RunPipelineResponse" do
+    end
+    add_message "google.cloud.lifesciences.v2beta.Pipeline" do
+      repeated :actions, :message, 1, "google.cloud.lifesciences.v2beta.Action"
+      optional :resources, :message, 2, "google.cloud.lifesciences.v2beta.Resources"
+      map :environment, :string, :string, 3
+      optional :timeout, :message, 4, "google.protobuf.Duration"
+    end
+    add_message "google.cloud.lifesciences.v2beta.Action" do
+      optional :container_name, :string, 1
+      optional :image_uri, :string, 2
+      repeated :commands, :string, 3
+      optional :entrypoint, :string, 4
+      map :environment, :string, :string, 5
+      optional :pid_namespace, :string, 6
+      map :port_mappings, :int32, :int32, 8
+      repeated :mounts, :message, 9, "google.cloud.lifesciences.v2beta.Mount"
+      map :labels, :string, :string, 10
+      optional :credentials, :message, 11, "google.cloud.lifesciences.v2beta.Secret"
+      optional :timeout, :message, 12, "google.protobuf.Duration"
+      optional :ignore_exit_status, :bool, 13
+      optional :run_in_background, :bool, 14
+      optional :always_run, :bool, 15
+      optional :enable_fuse, :bool, 16
+      optional :publish_exposed_ports, :bool, 17
+      optional :disable_image_prefetch, :bool, 18
+      optional :disable_standard_error_capture, :bool, 19
+      optional :block_external_network, :bool, 20
+    end
+    add_message "google.cloud.lifesciences.v2beta.Secret" do
+      optional :key_name, :string, 1
+      optional :cipher_text, :string, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.Mount" do
+      optional :disk, :string, 1
+      optional :path, :string, 2
+      optional :read_only, :bool, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.Resources" do
+      repeated :regions, :string, 2
+      repeated :zones, :string, 3
+      optional :virtual_machine, :message, 4, "google.cloud.lifesciences.v2beta.VirtualMachine"
+    end
+    add_message "google.cloud.lifesciences.v2beta.VirtualMachine" do
+      optional :machine_type, :string, 1
+      optional :preemptible, :bool, 2
+      map :labels, :string, :string, 3
+      repeated :disks, :message, 4, "google.cloud.lifesciences.v2beta.Disk"
+      optional :network, :message, 5, "google.cloud.lifesciences.v2beta.Network"
+      repeated :accelerators, :message, 6, "google.cloud.lifesciences.v2beta.Accelerator"
+      optional :service_account, :message, 7, "google.cloud.lifesciences.v2beta.ServiceAccount"
+      optional :boot_disk_size_gb, :int32, 8
+      optional :cpu_platform, :string, 9
+      optional :boot_image, :string, 10
+      optional :nvidia_driver_version, :string, 11
+      optional :enable_stackdriver_monitoring, :bool, 12
+      repeated :docker_cache_images, :string, 13
+      repeated :volumes, :message, 14, "google.cloud.lifesciences.v2beta.Volume"
+    end
+    add_message "google.cloud.lifesciences.v2beta.ServiceAccount" do
+      optional :email, :string, 1
+      repeated :scopes, :string, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.Accelerator" do
+      optional :type, :string, 1
+      optional :count, :int64, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.Network" do
+      optional :network, :string, 1
+      optional :use_private_address, :bool, 2
+      optional :subnetwork, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.Disk" do
+      optional :name, :string, 1
+      optional :size_gb, :int32, 2
+      optional :type, :string, 3
+      optional :source_image, :string, 4
+    end
+    add_message "google.cloud.lifesciences.v2beta.Volume" do
+      optional :volume, :string, 1
+      oneof :storage do
+        optional :persistent_disk, :message, 2, "google.cloud.lifesciences.v2beta.PersistentDisk"
+        optional :existing_disk, :message, 3, "google.cloud.lifesciences.v2beta.ExistingDisk"
+        optional :nfs_mount, :message, 4, "google.cloud.lifesciences.v2beta.NFSMount"
+      end
+    end
+    add_message "google.cloud.lifesciences.v2beta.PersistentDisk" do
+      optional :size_gb, :int32, 1
+      optional :type, :string, 2
+      optional :source_image, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.ExistingDisk" do
+      optional :disk, :string, 1
+    end
+    add_message "google.cloud.lifesciences.v2beta.NFSMount" do
+      optional :target, :string, 1
+    end
+    add_message "google.cloud.lifesciences.v2beta.Metadata" do
+      optional :pipeline, :message, 1, "google.cloud.lifesciences.v2beta.Pipeline"
+      map :labels, :string, :string, 2
+      repeated :events, :message, 3, "google.cloud.lifesciences.v2beta.Event"
+      optional :create_time, :message, 4, "google.protobuf.Timestamp"
+      optional :start_time, :message, 5, "google.protobuf.Timestamp"
+      optional :end_time, :message, 6, "google.protobuf.Timestamp"
+      optional :pub_sub_topic, :string, 7
+    end
+    add_message "google.cloud.lifesciences.v2beta.Event" do
+      optional :timestamp, :message, 1, "google.protobuf.Timestamp"
+      optional :description, :string, 2
+      oneof :details do
+        optional :delayed, :message, 17, "google.cloud.lifesciences.v2beta.DelayedEvent"
+        optional :worker_assigned, :message, 18, "google.cloud.lifesciences.v2beta.WorkerAssignedEvent"
+        optional :worker_released, :message, 19, "google.cloud.lifesciences.v2beta.WorkerReleasedEvent"
+        optional :pull_started, :message, 20, "google.cloud.lifesciences.v2beta.PullStartedEvent"
+        optional :pull_stopped, :message, 21, "google.cloud.lifesciences.v2beta.PullStoppedEvent"
+        optional :container_started, :message, 22, "google.cloud.lifesciences.v2beta.ContainerStartedEvent"
+        optional :container_stopped, :message, 23, "google.cloud.lifesciences.v2beta.ContainerStoppedEvent"
+        optional :container_killed, :message, 24, "google.cloud.lifesciences.v2beta.ContainerKilledEvent"
+        optional :unexpected_exit_status, :message, 25, "google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent"
+        optional :failed, :message, 26, "google.cloud.lifesciences.v2beta.FailedEvent"
+      end
+    end
+    add_message "google.cloud.lifesciences.v2beta.DelayedEvent" do
+      optional :cause, :string, 1
+      repeated :metrics, :string, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.WorkerAssignedEvent" do
+      optional :zone, :string, 1
+      optional :instance, :string, 2
+      optional :machine_type, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.WorkerReleasedEvent" do
+      optional :zone, :string, 1
+      optional :instance, :string, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.PullStartedEvent" do
+      optional :image_uri, :string, 1
+    end
+    add_message "google.cloud.lifesciences.v2beta.PullStoppedEvent" do
+      optional :image_uri, :string, 1
+    end
+    add_message "google.cloud.lifesciences.v2beta.ContainerStartedEvent" do
+      optional :action_id, :int32, 1
+      map :port_mappings, :int32, :int32, 2
+      optional :ip_address, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.ContainerStoppedEvent" do
+      optional :action_id, :int32, 1
+      optional :exit_status, :int32, 2
+      optional :stderr, :string, 3
+    end
+    add_message "google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent" do
+      optional :action_id, :int32, 1
+      optional :exit_status, :int32, 2
+    end
+    add_message "google.cloud.lifesciences.v2beta.ContainerKilledEvent" do
+      optional :action_id, :int32, 1
+    end
+    add_message "google.cloud.lifesciences.v2beta.FailedEvent" do
+      optional :code, :enum, 1, "google.rpc.Code"
+      optional :cause, :string, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module LifeSciences
+      module V2beta
+        RunPipelineRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.RunPipelineRequest").msgclass
+        RunPipelineResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.RunPipelineResponse").msgclass
+        Pipeline = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Pipeline").msgclass
+        Action = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Action").msgclass
+        Secret = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Secret").msgclass
+        Mount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Mount").msgclass
+        Resources = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Resources").msgclass
+        VirtualMachine = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.VirtualMachine").msgclass
+        ServiceAccount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.ServiceAccount").msgclass
+        Accelerator = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Accelerator").msgclass
+        Network = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Network").msgclass
+        Disk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Disk").msgclass
+        Volume = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Volume").msgclass
+        PersistentDisk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.PersistentDisk").msgclass
+        ExistingDisk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.ExistingDisk").msgclass
+        NFSMount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.NFSMount").msgclass
+        Metadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Metadata").msgclass
+        Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.Event").msgclass
+        DelayedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.DelayedEvent").msgclass
+        WorkerAssignedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.WorkerAssignedEvent").msgclass
+        WorkerReleasedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.WorkerReleasedEvent").msgclass
+        PullStartedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.PullStartedEvent").msgclass
+        PullStoppedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.PullStoppedEvent").msgclass
+        ContainerStartedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.ContainerStartedEvent").msgclass
+        ContainerStoppedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.ContainerStoppedEvent").msgclass
+        UnexpectedExitStatusEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent").msgclass
+        ContainerKilledEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.ContainerKilledEvent").msgclass
+        FailedEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.lifesciences.v2beta.FailedEvent").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/lifesciences/v2beta/workflows_services_pb.rb

@@ -0,0 +1,62 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/lifesciences/v2beta/workflows.proto for package 'Google.Cloud.LifeSciences.V2beta'
+# Original file comments:
+# Copyright 2021 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/lifesciences/v2beta/workflows_pb'
+
+module Google
+  module Cloud
+    module LifeSciences
+      module V2beta
+        module WorkflowsServiceV2Beta
+          # A service for running workflows, such as pipelines consisting of Docker
+          # containers.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta'
+
+            # Runs a pipeline.  The returned Operation's [metadata]
+            # [google.longrunning.Operation.metadata] field will contain a
+            # [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata] object describing the status
+            # of the pipeline execution. The
+            # [response][google.longrunning.Operation.response] field will contain a
+            # [google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse] object if the
+            # pipeline completes successfully.
+            #
+            # **Note:** Before you can use this method, the *Life Sciences Service Agent*
+            # must have access to your project. This is done automatically when the
+            # Cloud Life Sciences API is first enabled, but if you delete this permission
+            # you must disable and re-enable the API to grant the Life Sciences
+            # Service Agent the required permissions.
+            # Authorization requires the following [Google
+            # IAM](https://cloud.google.com/iam/) permission:
+            #
+            # * `lifesciences.workflows.run`
+            rpc :RunPipeline, ::Google::Cloud::LifeSciences::V2beta::RunPipelineRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Life Sciences V2beta 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,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. 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/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!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.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    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
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      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"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!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