google-cloud-metastore-v1 0.1.0

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Dataproc Metastore 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,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

data/proto_docs/google/cloud/metastore/v1/metastore.rb

@@ -0,0 +1,756 @@
+# 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 Cloud
+    module Metastore
+      module V1
+        # A managed metastore service that serves metadata queries.
+        # @!attribute [rw] hive_metastore_config
+        #   @return [::Google::Cloud::Metastore::V1::HiveMetastoreConfig]
+        #     Configuration information specific to running Hive metastore
+        #     software as the metastore service.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The relative resource name of the metastore service, of the form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the metastore service was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the metastore service was last updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     User-defined labels for the metastore service.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Immutable. The relative resource name of the VPC network on which the instance can be
+        #     accessed. It is specified in the following form:
+        #
+        #     `projects/{project_number}/global/networks/{network_id}`.
+        # @!attribute [r] endpoint_uri
+        #   @return [::String]
+        #     Output only. The URI of the endpoint used to access the metastore service.
+        # @!attribute [rw] port
+        #   @return [::Integer]
+        #     The TCP port at which the metastore service is reached. Default: 9083.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Metastore::V1::Service::State]
+        #     Output only. The current state of the metastore service.
+        # @!attribute [r] state_message
+        #   @return [::String]
+        #     Output only. Additional information about the current state of the metastore service, if
+        #     available.
+        # @!attribute [r] artifact_gcs_uri
+        #   @return [::String]
+        #     Output only. A Cloud Storage URI (starting with `gs://`) that specifies where artifacts
+        #     related to the metastore service are stored.
+        # @!attribute [rw] tier
+        #   @return [::Google::Cloud::Metastore::V1::Service::Tier]
+        #     The tier of the service.
+        # @!attribute [rw] maintenance_window
+        #   @return [::Google::Cloud::Metastore::V1::MaintenanceWindow]
+        #     The one hour maintenance window of the metastore service. This specifies
+        #     when the service can be restarted for maintenance purposes in UTC time.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. The globally unique resource identifier of the metastore service.
+        # @!attribute [r] metadata_management_activity
+        #   @return [::Google::Cloud::Metastore::V1::MetadataManagementActivity]
+        #     Output only. The metadata management activities of the metastore service.
+        # @!attribute [rw] release_channel
+        #   @return [::Google::Cloud::Metastore::V1::Service::ReleaseChannel]
+        #     Immutable. The release channel of the service.
+        #     If unspecified, defaults to `STABLE`.
+        class Service
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The current state of the metastore service.
+          module State
+            # The state of the metastore service is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The metastore service is in the process of being created.
+            CREATING = 1
+
+            # The metastore service is running and ready to serve queries.
+            ACTIVE = 2
+
+            # The metastore service is entering suspension. Its query-serving
+            # availability may cease unexpectedly.
+            SUSPENDING = 3
+
+            # The metastore service is suspended and unable to serve queries.
+            SUSPENDED = 4
+
+            # The metastore service is being updated. It remains usable but cannot
+            # accept additional update requests or be deleted at this time.
+            UPDATING = 5
+
+            # The metastore service is undergoing deletion. It cannot be used.
+            DELETING = 6
+
+            # The metastore service has encountered an error and cannot be used. The
+            # metastore service should be deleted.
+            ERROR = 7
+          end
+
+          # Available service tiers.
+          module Tier
+            # The tier is not set.
+            TIER_UNSPECIFIED = 0
+
+            # The developer tier provides limited scalability and no fault tolerance.
+            # Good for low-cost proof-of-concept.
+            DEVELOPER = 1
+
+            # The enterprise tier provides multi-zone high availability, and sufficient
+            # scalability for enterprise-level Dataproc Metastore workloads.
+            ENTERPRISE = 3
+          end
+
+          # Release channels bundle features of varying levels of stability. Newer
+          # features may be introduced initially into less stable release channels and
+          # can be automatically promoted into more stable release channels.
+          module ReleaseChannel
+            # Release channel is not specified.
+            RELEASE_CHANNEL_UNSPECIFIED = 0
+
+            # The `CANARY` release channel contains the newest features, which may be
+            # unstable and subject to unresolved issues with no known workarounds.
+            # Services using the `CANARY` release channel are not subject to any SLAs.
+            CANARY = 1
+
+            # The `STABLE` release channel contains features that are considered stable
+            # and have been validated for production use.
+            STABLE = 2
+          end
+        end
+
+        # Maintenance window. This specifies when Dataproc Metastore
+        # may perform system maintenance operation to the service.
+        # @!attribute [rw] hour_of_day
+        #   @return [::Google::Protobuf::Int32Value]
+        #     The hour of day (0-23) when the window starts.
+        # @!attribute [rw] day_of_week
+        #   @return [::Google::Type::DayOfWeek]
+        #     The day of week, when the window starts.
+        class MaintenanceWindow
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies configuration information specific to running Hive metastore
+        # software as the metastore service.
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     Immutable. The Hive metastore schema version.
+        # @!attribute [rw] config_overrides
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A mapping of Hive metastore configuration key-value pairs to apply to the
+        #     Hive metastore (configured in `hive-site.xml`). The mappings
+        #     override system defaults (some keys cannot be overridden).
+        # @!attribute [rw] kerberos_config
+        #   @return [::Google::Cloud::Metastore::V1::KerberosConfig]
+        #     Information used to configure the Hive metastore service as a service
+        #     principal in a Kerberos realm. To disable Kerberos, use the `UpdateService`
+        #     method and specify this field's path
+        #     (`hive_metastore_config.kerberos_config`) in the request's `update_mask`
+        #     while omitting this field from the request's `service`.
+        class HiveMetastoreConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class ConfigOverridesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Configuration information for a Kerberos principal.
+        # @!attribute [rw] keytab
+        #   @return [::Google::Cloud::Metastore::V1::Secret]
+        #     A Kerberos keytab file that can be used to authenticate a service principal
+        #     with a Kerberos Key Distribution Center (KDC).
+        # @!attribute [rw] principal
+        #   @return [::String]
+        #     A Kerberos principal that exists in the both the keytab the KDC
+        #     to authenticate as. A typical principal is of the form
+        #     `primary/instance@REALM`, but there is no exact format.
+        # @!attribute [rw] krb5_config_gcs_uri
+        #   @return [::String]
+        #     A Cloud Storage URI that specifies the path to a
+        #     krb5.conf file. It is of the form `gs://{bucket_name}/path/to/krb5.conf`,
+        #     although the file does not need to be named krb5.conf explicitly.
+        class KerberosConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A securely stored value.
+        # @!attribute [rw] cloud_secret
+        #   @return [::String]
+        #     The relative resource name of a Secret Manager secret version, in the
+        #     following form:
+        #
+        #     `projects/{project_number}/secrets/{secret_id}/versions/{version_id}`.
+        class Secret
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The metadata management activities of the metastore service.
+        # @!attribute [r] metadata_exports
+        #   @return [::Array<::Google::Cloud::Metastore::V1::MetadataExport>]
+        #     Output only. The latest metadata exports of the metastore service.
+        class MetadataManagementActivity
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A metastore resource that imports metadata.
+        # @!attribute [rw] database_dump
+        #   @return [::Google::Cloud::Metastore::V1::MetadataImport::DatabaseDump]
+        #     Immutable. A database dump from a pre-existing metastore's database.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The relative resource name of the metadata import, of the form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}`.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the metadata import.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the metadata import was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the metadata import was last updated.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Metastore::V1::MetadataImport::State]
+        #     Output only. The current state of the metadata import.
+        class MetadataImport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A specification of the location of and metadata about a database dump from
+          # a relational database management system.
+          # @!attribute [rw] database_type
+          #   @return [::Google::Cloud::Metastore::V1::MetadataImport::DatabaseDump::DatabaseType]
+          #     The type of the database.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     A Cloud Storage object or folder URI that specifies the source from which
+          #     to import metadata. It must begin with `gs://`.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Metastore::V1::DatabaseDumpSpec::Type]
+          #     Optional. The type of the database dump. If unspecified, defaults to `MYSQL`.
+          class DatabaseDump
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the database.
+            module DatabaseType
+              # The type of the source database is unknown.
+              DATABASE_TYPE_UNSPECIFIED = 0
+
+              # The type of the source database is MySQL.
+              MYSQL = 1
+            end
+          end
+
+          # The current state of the metadata import.
+          module State
+            # The state of the metadata import is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The metadata import is running.
+            RUNNING = 1
+
+            # The metadata import completed successfully.
+            SUCCEEDED = 2
+
+            # The metadata import is being updated.
+            UPDATING = 3
+
+            # The metadata import failed, and attempted metadata changes were rolled
+            # back.
+            FAILED = 4
+          end
+        end
+
+        # The details of a metadata export operation.
+        # @!attribute [r] destination_gcs_uri
+        #   @return [::String]
+        #     Output only. A Cloud Storage URI of a folder that metadata are exported to, in the
+        #     form of `gs://<bucket_name>/<path_inside_bucket>/<export_folder>`, where
+        #     `<export_folder>` is automatically generated.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the export started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the export ended.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Metastore::V1::MetadataExport::State]
+        #     Output only. The current state of the export.
+        # @!attribute [r] database_dump_type
+        #   @return [::Google::Cloud::Metastore::V1::DatabaseDumpSpec::Type]
+        #     Output only. The type of the database dump.
+        class MetadataExport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The current state of the metadata export.
+          module State
+            # The state of the metadata export is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The metadata export is running.
+            RUNNING = 1
+
+            # The metadata export completed successfully.
+            SUCCEEDED = 2
+
+            # The metadata export failed.
+            FAILED = 3
+
+            # The metadata export is cancelled.
+            CANCELLED = 4
+          end
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The relative resource name of the location of metastore services to
+        #     list, in the following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of services to return. The response may contain less
+        #     than the maximum number. If unspecified, no more than 500 services are
+        #     returned. The maximum value is 1000; values above 1000 are changed to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
+        #     call. Provide this token to retrieve the subsequent page.
+        #
+        #     To retrieve the first page, supply an empty page token.
+        #
+        #     When paginating, other parameters provided to
+        #     {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices} must match the call that provided the
+        #     page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. The filter to apply to list results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Specify the ordering of results as described in [Sorting
+        #     Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
+        #     If not specified, the results will be sorted in the default order.
+        class ListServicesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
+        # @!attribute [rw] services
+        #   @return [::Array<::Google::Cloud::Metastore::V1::Service>]
+        #     The services in the specified location.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page. If this
+        #     field is omitted, there are no subsequent pages.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListServicesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_service DataprocMetastore.GetService}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to retrieve, in the
+        #     following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
+        class GetServiceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_service DataprocMetastore.CreateService}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The relative resource name of the location in which to create a metastore
+        #     service, in the following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}`.
+        # @!attribute [rw] service_id
+        #   @return [::String]
+        #     Required. The ID of the metastore service, which is used as the final
+        #     component of the metastore service's name.
+        #
+        #     This value must be between 2 and 63 characters long inclusive, begin with a
+        #     letter, end with a letter or number, and consist of alpha-numeric
+        #     ASCII characters or hyphens.
+        # @!attribute [rw] service
+        #   @return [::Google::Cloud::Metastore::V1::Service]
+        #     Required. The Metastore service to create. The `name` field is
+        #     ignored. The ID of the created metastore service must be provided in
+        #     the request's `service_id` field.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        class CreateServiceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_service DataprocMetastore.UpdateService}.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. A field mask used to specify the fields to be overwritten in the
+        #     metastore service resource by the update.
+        #     Fields specified in the `update_mask` are relative to the resource (not
+        #     to the full request). A field is overwritten if it is in the mask.
+        # @!attribute [rw] service
+        #   @return [::Google::Cloud::Metastore::V1::Service]
+        #     Required. The metastore service to update. The server only merges fields
+        #     in the service if they are specified in `update_mask`.
+        #
+        #     The metastore service's `name` field is used to identify the metastore
+        #     service to be updated.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        class UpdateServiceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#delete_service DataprocMetastore.DeleteService}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to delete, in the
+        #     following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        class DeleteServiceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The relative resource name of the service whose metadata imports to
+        #     list, in the following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of imports to return. The response may contain less
+        #     than the maximum number. If unspecified, no more than 500 imports are
+        #     returned. The maximum value is 1000; values above 1000 are changed to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
+        #     call. Provide this token to retrieve the subsequent page.
+        #
+        #     To retrieve the first page, supply an empty page token.
+        #
+        #     When paginating, other parameters provided to
+        #     {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices} must match the call that provided the
+        #     page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. The filter to apply to list results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Specify the ordering of results as described in [Sorting
+        #     Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
+        #     If not specified, the results will be sorted in the default order.
+        class ListMetadataImportsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
+        # @!attribute [rw] metadata_imports
+        #   @return [::Array<::Google::Cloud::Metastore::V1::MetadataImport>]
+        #     The imports in the specified service.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page. If this
+        #     field is omitted, there are no subsequent pages.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListMetadataImportsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_metadata_import DataprocMetastore.GetMetadataImport}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The relative resource name of the metadata import to retrieve, in the
+        #     following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}`.
+        class GetMetadataImportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_metadata_import DataprocMetastore.CreateMetadataImport}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The relative resource name of the service in which to create a metastore
+        #     import, in the following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] metadata_import_id
+        #   @return [::String]
+        #     Required. The ID of the metadata import, which is used as the final component of the
+        #     metadata import's name.
+        #
+        #     This value must be between 1 and 64 characters long, begin with a letter,
+        #     end with a letter or number, and consist of alpha-numeric ASCII characters
+        #     or hyphens.
+        # @!attribute [rw] metadata_import
+        #   @return [::Google::Cloud::Metastore::V1::MetadataImport]
+        #     Required. The metadata import to create. The `name` field is ignored. The ID of the
+        #     created metadata import must be provided in the request's
+        #     `metadata_import_id` field.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        class CreateMetadataImportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_metadata_import DataprocMetastore.UpdateMetadataImport}.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. A field mask used to specify the fields to be overwritten in the
+        #     metadata import resource by the update.
+        #     Fields specified in the `update_mask` are relative to the resource (not
+        #     to the full request). A field is overwritten if it is in the mask.
+        # @!attribute [rw] metadata_import
+        #   @return [::Google::Cloud::Metastore::V1::MetadataImport]
+        #     Required. The metadata import to update. The server only merges fields
+        #     in the import if they are specified in `update_mask`.
+        #
+        #     The metadata import's `name` field is used to identify the metastore
+        #     import to be updated.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        class UpdateMetadataImportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#export_metadata DataprocMetastore.ExportMetadata}.
+        # @!attribute [rw] destination_gcs_folder
+        #   @return [::String]
+        #     A Cloud Storage URI of a folder, in the format
+        #     `gs://<bucket_name>/<path_inside_bucket>`. A sub-folder
+        #     `<export_folder>` containing exported files will be created below it.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to run export, in the
+        #     following form:
+        #
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID. Specify a unique request ID to allow the server to ignore the
+        #     request if it has completed. The server will ignore subsequent requests
+        #     that provide a duplicate request ID for at least 60 minutes after the first
+        #     request.
+        #
+        #     For example, if an initial request times out, followed by another request
+        #     with the same request ID, the server ignores the second request to prevent
+        #     the creation of duplicate commitments.
+        #
+        #     The request ID must be a valid
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format).
+        #     A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
+        # @!attribute [rw] database_dump_type
+        #   @return [::Google::Cloud::Metastore::V1::DatabaseDumpSpec::Type]
+        #     Optional. The type of the database dump. If unspecified, defaults to `MYSQL`.
+        class ExportMetadataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents the metadata of a long-running operation.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation was created.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation finished running.
+        # @!attribute [r] target
+        #   @return [::String]
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] verb
+        #   @return [::String]
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] status_message
+        #   @return [::String]
+        #     Output only. Human-readable status of the operation, if any.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the caller has requested cancellation
+        #     of the operation. Operations that have successfully been cancelled
+        #     have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+        #     corresponding to `Code.CANCELLED`.
+        # @!attribute [r] api_version
+        #   @return [::String]
+        #     Output only. API version used to start the operation.
+        class OperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata about the service in a location.
+        # @!attribute [rw] supported_hive_metastore_versions
+        #   @return [::Array<::Google::Cloud::Metastore::V1::LocationMetadata::HiveMetastoreVersion>]
+        #     The versions of Hive Metastore that can be used when creating a new
+        #     metastore service in this location. The server guarantees that exactly one
+        #     `HiveMetastoreVersion` in the list will set `is_default`.
+        class LocationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A specification of a supported version of the Hive Metastore software.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     The semantic version of the Hive Metastore software.
+          # @!attribute [rw] is_default
+          #   @return [::Boolean]
+          #     Whether `version` will be chosen by the server if a metastore service is
+          #     created with a `HiveMetastoreConfig` that omits the `version`.
+          class HiveMetastoreVersion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The specification of database dump to import from or export to.
+        class DatabaseDumpSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of the database dump.
+          module Type
+            # The type of the database dump is unknown.
+            TYPE_UNSPECIFIED = 0
+
+            # Database dump is a MySQL dump file.
+            MYSQL = 1
+          end
+        end
+      end
+    end
+  end
+end