google-cloud-vm_migration-v1 0.1.0

data/lib/google/cloud/vmmigration/v1/vmmigration_services_pb.rb

@@ -0,0 +1,157 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/vmmigration/v1/vmmigration.proto for package 'Google.Cloud.VMMigration.V1'
+# 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/vmmigration/v1/vmmigration_pb'
+
+module Google
+  module Cloud
+    module VMMigration
+      module V1
+        module VmMigration
+          # VM Migration Service
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.vmmigration.v1.VmMigration'
+
+            # Lists Sources in a given project and location.
+            rpc :ListSources, ::Google::Cloud::VMMigration::V1::ListSourcesRequest, ::Google::Cloud::VMMigration::V1::ListSourcesResponse
+            # Gets details of a single Source.
+            rpc :GetSource, ::Google::Cloud::VMMigration::V1::GetSourceRequest, ::Google::Cloud::VMMigration::V1::Source
+            # Creates a new Source in a given project and location.
+            rpc :CreateSource, ::Google::Cloud::VMMigration::V1::CreateSourceRequest, ::Google::Longrunning::Operation
+            # Updates the parameters of a single Source.
+            rpc :UpdateSource, ::Google::Cloud::VMMigration::V1::UpdateSourceRequest, ::Google::Longrunning::Operation
+            # Deletes a single Source.
+            rpc :DeleteSource, ::Google::Cloud::VMMigration::V1::DeleteSourceRequest, ::Google::Longrunning::Operation
+            # List remote source's inventory of VMs.
+            # The remote source is the onprem vCenter (remote in the sense it's not in
+            # Compute Engine). The inventory describes the list of existing VMs in that
+            # source. Note that this operation lists the VMs on the remote source, as
+            # opposed to listing the MigratingVms resources in the vmmigration service.
+            rpc :FetchInventory, ::Google::Cloud::VMMigration::V1::FetchInventoryRequest, ::Google::Cloud::VMMigration::V1::FetchInventoryResponse
+            # Lists Utilization Reports of the given Source.
+            rpc :ListUtilizationReports, ::Google::Cloud::VMMigration::V1::ListUtilizationReportsRequest, ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse
+            # Gets a single Utilization Report.
+            rpc :GetUtilizationReport, ::Google::Cloud::VMMigration::V1::GetUtilizationReportRequest, ::Google::Cloud::VMMigration::V1::UtilizationReport
+            # Creates a new UtilizationReport.
+            rpc :CreateUtilizationReport, ::Google::Cloud::VMMigration::V1::CreateUtilizationReportRequest, ::Google::Longrunning::Operation
+            # Deletes a single Utilization Report.
+            rpc :DeleteUtilizationReport, ::Google::Cloud::VMMigration::V1::DeleteUtilizationReportRequest, ::Google::Longrunning::Operation
+            # Lists DatacenterConnectors in a given Source.
+            rpc :ListDatacenterConnectors, ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsRequest, ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse
+            # Gets details of a single DatacenterConnector.
+            rpc :GetDatacenterConnector, ::Google::Cloud::VMMigration::V1::GetDatacenterConnectorRequest, ::Google::Cloud::VMMigration::V1::DatacenterConnector
+            # Creates a new DatacenterConnector in a given Source.
+            rpc :CreateDatacenterConnector, ::Google::Cloud::VMMigration::V1::CreateDatacenterConnectorRequest, ::Google::Longrunning::Operation
+            # Deletes a single DatacenterConnector.
+            rpc :DeleteDatacenterConnector, ::Google::Cloud::VMMigration::V1::DeleteDatacenterConnectorRequest, ::Google::Longrunning::Operation
+            # Creates a new MigratingVm in a given Source.
+            rpc :CreateMigratingVm, ::Google::Cloud::VMMigration::V1::CreateMigratingVmRequest, ::Google::Longrunning::Operation
+            # Lists MigratingVms in a given Source.
+            rpc :ListMigratingVms, ::Google::Cloud::VMMigration::V1::ListMigratingVmsRequest, ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse
+            # Gets details of a single MigratingVm.
+            rpc :GetMigratingVm, ::Google::Cloud::VMMigration::V1::GetMigratingVmRequest, ::Google::Cloud::VMMigration::V1::MigratingVm
+            # Updates the parameters of a single MigratingVm.
+            rpc :UpdateMigratingVm, ::Google::Cloud::VMMigration::V1::UpdateMigratingVmRequest, ::Google::Longrunning::Operation
+            # Deletes a single MigratingVm.
+            rpc :DeleteMigratingVm, ::Google::Cloud::VMMigration::V1::DeleteMigratingVmRequest, ::Google::Longrunning::Operation
+            # Starts migration for a VM. Starts the process of uploading
+            # data and creating snapshots, in replication cycles scheduled by the policy.
+            rpc :StartMigration, ::Google::Cloud::VMMigration::V1::StartMigrationRequest, ::Google::Longrunning::Operation
+            # Resumes a migration for a VM. When called on a paused migration, will start
+            # the process of uploading data and creating snapshots; when called on a
+            # completed cut-over migration, will update the migration to active state and
+            # start the process of uploading data and creating snapshots.
+            rpc :ResumeMigration, ::Google::Cloud::VMMigration::V1::ResumeMigrationRequest, ::Google::Longrunning::Operation
+            # Pauses a migration for a VM. If cycle tasks are running they will be
+            # cancelled, preserving source task data. Further replication cycles will not
+            # be triggered while the VM is paused.
+            rpc :PauseMigration, ::Google::Cloud::VMMigration::V1::PauseMigrationRequest, ::Google::Longrunning::Operation
+            # Marks a migration as completed, deleting migration resources that are no
+            # longer being used. Only applicable after cutover is done.
+            rpc :FinalizeMigration, ::Google::Cloud::VMMigration::V1::FinalizeMigrationRequest, ::Google::Longrunning::Operation
+            # Initiates a Clone of a specific migrating VM.
+            rpc :CreateCloneJob, ::Google::Cloud::VMMigration::V1::CreateCloneJobRequest, ::Google::Longrunning::Operation
+            # Initiates the cancellation of a running clone job.
+            rpc :CancelCloneJob, ::Google::Cloud::VMMigration::V1::CancelCloneJobRequest, ::Google::Longrunning::Operation
+            # Lists CloneJobs of a given migrating VM.
+            rpc :ListCloneJobs, ::Google::Cloud::VMMigration::V1::ListCloneJobsRequest, ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse
+            # Gets details of a single CloneJob.
+            rpc :GetCloneJob, ::Google::Cloud::VMMigration::V1::GetCloneJobRequest, ::Google::Cloud::VMMigration::V1::CloneJob
+            # Initiates a Cutover of a specific migrating VM.
+            # The returned LRO is completed when the cutover job resource is created
+            # and the job is initiated.
+            rpc :CreateCutoverJob, ::Google::Cloud::VMMigration::V1::CreateCutoverJobRequest, ::Google::Longrunning::Operation
+            # Initiates the cancellation of a running cutover job.
+            rpc :CancelCutoverJob, ::Google::Cloud::VMMigration::V1::CancelCutoverJobRequest, ::Google::Longrunning::Operation
+            # Lists CutoverJobs of a given migrating VM.
+            rpc :ListCutoverJobs, ::Google::Cloud::VMMigration::V1::ListCutoverJobsRequest, ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse
+            # Gets details of a single CutoverJob.
+            rpc :GetCutoverJob, ::Google::Cloud::VMMigration::V1::GetCutoverJobRequest, ::Google::Cloud::VMMigration::V1::CutoverJob
+            # Lists Groups in a given project and location.
+            rpc :ListGroups, ::Google::Cloud::VMMigration::V1::ListGroupsRequest, ::Google::Cloud::VMMigration::V1::ListGroupsResponse
+            # Gets details of a single Group.
+            rpc :GetGroup, ::Google::Cloud::VMMigration::V1::GetGroupRequest, ::Google::Cloud::VMMigration::V1::Group
+            # Creates a new Group in a given project and location.
+            rpc :CreateGroup, ::Google::Cloud::VMMigration::V1::CreateGroupRequest, ::Google::Longrunning::Operation
+            # Updates the parameters of a single Group.
+            rpc :UpdateGroup, ::Google::Cloud::VMMigration::V1::UpdateGroupRequest, ::Google::Longrunning::Operation
+            # Deletes a single Group.
+            rpc :DeleteGroup, ::Google::Cloud::VMMigration::V1::DeleteGroupRequest, ::Google::Longrunning::Operation
+            # Adds a MigratingVm to a Group.
+            rpc :AddGroupMigration, ::Google::Cloud::VMMigration::V1::AddGroupMigrationRequest, ::Google::Longrunning::Operation
+            # Removes a MigratingVm from a Group.
+            rpc :RemoveGroupMigration, ::Google::Cloud::VMMigration::V1::RemoveGroupMigrationRequest, ::Google::Longrunning::Operation
+            # Lists TargetProjects in a given project.
+            #
+            # NOTE: TargetProject is a global resource; hence the only supported value
+            # for location is `global`.
+            rpc :ListTargetProjects, ::Google::Cloud::VMMigration::V1::ListTargetProjectsRequest, ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse
+            # Gets details of a single TargetProject.
+            #
+            # NOTE: TargetProject is a global resource; hence the only supported value
+            # for location is `global`.
+            rpc :GetTargetProject, ::Google::Cloud::VMMigration::V1::GetTargetProjectRequest, ::Google::Cloud::VMMigration::V1::TargetProject
+            # Creates a new TargetProject in a given project.
+            #
+            # NOTE: TargetProject is a global resource; hence the only supported value
+            # for location is `global`.
+            rpc :CreateTargetProject, ::Google::Cloud::VMMigration::V1::CreateTargetProjectRequest, ::Google::Longrunning::Operation
+            # Updates the parameters of a single TargetProject.
+            #
+            # NOTE: TargetProject is a global resource; hence the only supported value
+            # for location is `global`.
+            rpc :UpdateTargetProject, ::Google::Cloud::VMMigration::V1::UpdateTargetProjectRequest, ::Google::Longrunning::Operation
+            # Deletes a single TargetProject.
+            #
+            # NOTE: TargetProject is a global resource; hence the only supported value
+            # for location is `global`.
+            rpc :DeleteTargetProject, ::Google::Cloud::VMMigration::V1::DeleteTargetProjectRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google-cloud-vm_migration-v1.rb

@@ -0,0 +1,21 @@
+# 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!
+
+# 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/vm_migration/v1"

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Migrate for Compute Engine 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,71 @@
+# 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
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    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