google-cloud-metastore-v1beta 0.2.0 → 0.4.0

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

@@ -28,8 +28,8 @@ module Google
         #     software as the metastore service.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Immutable. The relative resource name of the metastore service, of the
-        #     form:
+        #     Immutable. The relative resource name of the metastore service, in the
+        #     following format:
         #
         #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
         # @!attribute [r] create_time
@@ -75,6 +75,8 @@ module Google
         #   @return [::Google::Cloud::Metastore::V1beta::MaintenanceWindow]
         #     The one hour maintenance window of the metastore service. This specifies
         #     when the service can be restarted for maintenance purposes in UTC time.
+        #     Maintenance window is not needed for services with the SPANNER
+        #     database type.
         # @!attribute [r] uid
         #   @return [::String]
         #     Output only. The globally unique resource identifier of the metastore
@@ -86,6 +88,21 @@ module Google
         #   @return [::Google::Cloud::Metastore::V1beta::Service::ReleaseChannel]
         #     Immutable. The release channel of the service.
         #     If unspecified, defaults to `STABLE`.
+        # @!attribute [rw] encryption_config
+        #   @return [::Google::Cloud::Metastore::V1beta::EncryptionConfig]
+        #     Immutable. Information used to configure the Dataproc Metastore service to
+        #     encrypt customer data at rest. Cannot be updated.
+        # @!attribute [rw] network_config
+        #   @return [::Google::Cloud::Metastore::V1beta::NetworkConfig]
+        #     The configuration specifying the network settings for the
+        #     Dataproc Metastore service.
+        # @!attribute [rw] database_type
+        #   @return [::Google::Cloud::Metastore::V1beta::Service::DatabaseType]
+        #     Immutable. The database type that the Metastore service stores its data.
+        # @!attribute [rw] telemetry_config
+        #   @return [::Google::Cloud::Metastore::V1beta::TelemetryConfig]
+        #     The configuration specifying telemetry settings for the Dataproc Metastore
+        #     service. If unspecified defaults to `JSON`.
         class Service
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -159,12 +176,27 @@ module Google
             # and have been validated for production use.
             STABLE = 2
           end
+
+          # The backend database type for the metastore service.
+          module DatabaseType
+            # The DATABASE_TYPE is not set.
+            DATABASE_TYPE_UNSPECIFIED = 0
+
+            # MySQL is used to persist the metastore data.
+            MYSQL = 1
+
+            # Spanner is used to persist the metastore data.
+            SPANNER = 2
+          end
         end
 
         # Specifies how metastore metadata should be integrated with external services.
         # @!attribute [rw] data_catalog_config
         #   @return [::Google::Cloud::Metastore::V1beta::DataCatalogConfig]
         #     The integration config for the Data Catalog service.
+        # @!attribute [rw] dataplex_config
+        #   @return [::Google::Cloud::Metastore::V1beta::DataplexConfig]
+        #     The integration config for the Dataplex service.
         class MetadataIntegration
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -181,6 +213,38 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Specifies how metastore metadata should be integrated with the Dataplex
+        # service.
+        # @!attribute [rw] lake_resources
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Metastore::V1beta::Lake}]
+        #     A reference to the Lake resources that this metastore service is attached
+        #     to. The key is the lake resource name. Example:
+        #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
+        class DataplexConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Metastore::V1beta::Lake]
+          class LakeResourcesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Represents a Lake resource
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The Lake resource name.
+        #     Example:
+        #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
+        class Lake
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Maintenance window. This specifies when Dataproc Metastore
         # may perform system maintenance operation to the service.
         # @!attribute [rw] hour_of_day
@@ -203,7 +267,9 @@ module Google
         #   @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).
+        #     override system defaults (some keys cannot be overridden). These
+        #     overrides are also applied to auxiliary versions and can be further
+        #     customized in the auxiliary version's `AuxiliaryVersionConfig`.
         # @!attribute [rw] kerberos_config
         #   @return [::Google::Cloud::Metastore::V1beta::KerberosConfig]
         #     Information used to configure the Hive metastore service as a service
@@ -211,6 +277,20 @@ module Google
         #     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`.
+        # @!attribute [rw] endpoint_protocol
+        #   @return [::Google::Cloud::Metastore::V1beta::HiveMetastoreConfig::EndpointProtocol]
+        #     The protocol to use for the metastore service endpoint. If unspecified,
+        #     defaults to `THRIFT`.
+        # @!attribute [rw] auxiliary_versions
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Metastore::V1beta::AuxiliaryVersionConfig}]
+        #     A mapping of Hive metastore version to the auxiliary version
+        #     configuration. When specified, a secondary Hive metastore service is
+        #     created along with the primary service. All auxiliary versions must be less
+        #     than the service's primary version. The key is the auxiliary service name
+        #     and it must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. This
+        #     means that the first character must be a lowercase letter, and all the
+        #     following characters must be hyphens, lowercase letters, or digits, except
+        #     the last character, which cannot be a hyphen.
         class HiveMetastoreConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -223,6 +303,27 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Metastore::V1beta::AuxiliaryVersionConfig]
+          class AuxiliaryVersionsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Protocols available for serving the metastore service endpoint.
+          module EndpointProtocol
+            # The protocol is not set.
+            ENDPOINT_PROTOCOL_UNSPECIFIED = 0
+
+            # Use the legacy Apache Thrift protocol for the metastore service endpoint.
+            THRIFT = 1
+
+            # Use the modernized gRPC protocol for the metastore service endpoint.
+            GRPC = 2
+          end
         end
 
         # Configuration information for a Kerberos principal.
@@ -238,7 +339,7 @@ module Google
         # @!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,
+        #     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
@@ -257,6 +358,98 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Encryption settings for the service.
+        # @!attribute [rw] kms_key
+        #   @return [::String]
+        #     The fully qualified customer provided Cloud KMS key name to use for
+        #     customer data encryption, in the following form:
+        #
+        #     `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`.
+        class EncryptionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration information for the auxiliary service versions.
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     The Hive metastore version of the auxiliary service. It must be less
+        #     than the primary Hive metastore service's version.
+        # @!attribute [rw] config_overrides
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A mapping of Hive metastore configuration key-value pairs to apply to the
+        #     auxiliary Hive metastore (configured in `hive-site.xml`) in addition to
+        #     the primary version's overrides. If keys are present in both the auxiliary
+        #     version's overrides and the primary version's overrides, the value from
+        #     the auxiliary version's overrides takes precedence.
+        # @!attribute [r] network_config
+        #   @return [::Google::Cloud::Metastore::V1beta::NetworkConfig]
+        #     Output only. The network configuration contains the endpoint URI(s) of the
+        #     auxiliary Hive metastore service.
+        class AuxiliaryVersionConfig
+          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
+
+        # Network configuration for the Dataproc Metastore service.
+        # @!attribute [rw] consumers
+        #   @return [::Array<::Google::Cloud::Metastore::V1beta::NetworkConfig::Consumer>]
+        #     Immutable. The consumer-side network configuration for the Dataproc
+        #     Metastore instance.
+        class NetworkConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains information of the customer's network configurations.
+          # @!attribute [rw] subnetwork
+          #   @return [::String]
+          #     Immutable. The subnetwork of the customer project from which an IP
+          #     address is reserved and used as the Dataproc Metastore service's
+          #     endpoint. It is accessible to hosts in the subnet and to all
+          #     hosts in a subnet in the same region and same network. There must
+          #     be at least one IP address available in the subnet's primary range. The
+          #     subnet is specified in the following form:
+          #
+          #     `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}`
+          # @!attribute [r] endpoint_uri
+          #   @return [::String]
+          #     Output only. The URI of the endpoint used to access the metastore
+          #     service.
+          class Consumer
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Telemetry Configuration for the Dataproc Metastore service.
+        # @!attribute [rw] log_format
+        #   @return [::Google::Cloud::Metastore::V1beta::TelemetryConfig::LogFormat]
+        #     The output format of the Dataproc Metastore service's logs.
+        class TelemetryConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module LogFormat
+            # The LOG_FORMAT is not set.
+            LOG_FORMAT_UNSPECIFIED = 0
+
+            # Logging output uses the legacy `textPayload` format.
+            LEGACY = 1
+
+            # Logging output uses the `jsonPayload` format.
+            JSON = 2
+          end
+        end
+
         # The metadata management activities of the metastore service.
         # @!attribute [r] metadata_exports
         #   @return [::Array<::Google::Cloud::Metastore::V1beta::MetadataExport>]
@@ -283,10 +476,13 @@ module Google
         #     The description of the metadata import.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time when the metadata import was created.
+        #     Output only. The time when the metadata import was started.
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time when the metadata import was last updated.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the metadata import finished.
         # @!attribute [r] state
         #   @return [::Google::Cloud::Metastore::V1beta::MetadataImport::State]
         #     Output only. The current state of the metadata import.
@@ -407,6 +603,9 @@ module Google
         # @!attribute [rw] description
         #   @return [::String]
         #     The description of the backup.
+        # @!attribute [r] restoring_services
+        #   @return [::Array<::String>]
+        #     Output only. Services that are restoring from the backup.
         class Backup
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -427,6 +626,9 @@ module Google
 
             # The backup failed.
             FAILED = 4
+
+            # The backup is being restored.
+            RESTORING = 5
           end
         end
 
@@ -445,7 +647,7 @@ module Google
         #     Output only. The relative resource name of the metastore service backup to
         #     restore from, in the following form:
         #
-        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
         # @!attribute [r] type
         #   @return [::Google::Cloud::Metastore::V1beta::Restore::RestoreType]
         #     Output only. The type of restore.
@@ -475,7 +677,7 @@ module Google
             CANCELLED = 4
           end
 
-          # The type of restore.
+          # The type of restore. If unspecified, defaults to `METADATA_ONLY`.
           module RestoreType
             # The restore type is unknown.
             RESTORE_TYPE_UNSPECIFIED = 0
@@ -731,7 +933,7 @@ module Google
         #     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}`
+        #     `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
@@ -872,7 +1074,7 @@ module Google
         #     Required. The relative resource name of the service in which to create a
         #     backup of the following form:
         #
-        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`
+        #     `projects/{project_number}/locations/{location_id}/services/{service_id}`.
         # @!attribute [rw] backup_id
         #   @return [::String]
         #     Required. The ID of the backup, which is used as the final component of the
@@ -943,7 +1145,7 @@ module Google
         #     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}`
+        #     `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
@@ -973,13 +1175,13 @@ module Google
         #     Required. The relative resource name of the metastore service to run
         #     restore, in the following form:
         #
-        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`.
         # @!attribute [rw] backup
         #   @return [::String]
         #     Required. The relative resource name of the metastore service backup to
         #     restore from, in the following form:
         #
-        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
         # @!attribute [rw] restore_type
         #   @return [::Google::Cloud::Metastore::V1beta::Restore::RestoreType]
         #     Optional. The type of restore. If unspecified, defaults to `METADATA_ONLY`.
@@ -1069,8 +1271,131 @@ module Google
 
             # Database dump is a MySQL dump file.
             MYSQL = 1
+
+            # Database dump contains Avro files.
+            AVRO = 2
           end
         end
+
+        # Request message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#remove_iam_policy DataprocMetastore.RemoveIamPolicy}.
+        # @!attribute [rw] resource
+        #   @return [::String]
+        #     Required. The relative resource name of the dataplane resource to remove
+        #     IAM policy, in the following form:
+        #
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}`
+        #     or
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}`.
+        # @!attribute [rw] asynchronous
+        #   @return [::Boolean]
+        #     Optional. Removes IAM policy attached to database or table asynchronously
+        #     when it is set. The default is false.
+        class RemoveIamPolicyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#remove_iam_policy DataprocMetastore.RemoveIamPolicy}.
+        # @!attribute [rw] success
+        #   @return [::Boolean]
+        #     True if the policy is successfully removed.
+        class RemoveIamPolicyResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#query_metadata DataprocMetastore.QueryMetadata}.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to query
+        #     metadata, in the following format:
+        #
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. A read-only SQL query to execute against the metadata database.
+        #     The query cannot change or mutate the data.
+        class QueryMetadataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#query_metadata DataprocMetastore.QueryMetadata}.
+        # @!attribute [rw] result_manifest_uri
+        #   @return [::String]
+        #     The manifest URI  is link to a JSON instance in Cloud Storage.
+        #     This instance manifests immediately along with QueryMetadataResponse. The
+        #     content of the URI is not retriable until the long-running operation query
+        #     against the metadata finishes.
+        class QueryMetadataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#move_table_to_database DataprocMetastore.MoveTableToDatabase}.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to mutate
+        #     metadata, in the following format:
+        #
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] table_name
+        #   @return [::String]
+        #     Required. The name of the table to be moved.
+        # @!attribute [rw] db_name
+        #   @return [::String]
+        #     Required. The name of the database where the table resides.
+        # @!attribute [rw] destination_db_name
+        #   @return [::String]
+        #     Required. The name of the database where the table should be moved.
+        class MoveTableToDatabaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#move_table_to_database DataprocMetastore.MoveTableToDatabase}.
+        class MoveTableToDatabaseResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#alter_metadata_resource_location DataprocMetastore.AlterMetadataResourceLocation}.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Required. The relative resource name of the metastore service to mutate
+        #     metadata, in the following format:
+        #
+        #     `projects/{project_id}/locations/{location_id}/services/{service_id}`.
+        # @!attribute [rw] resource_name
+        #   @return [::String]
+        #     Required. The relative metadata resource name in the following format.
+        #
+        #     `databases/{database_id}`
+        #     or
+        #     `databases/{database_id}/tables/{table_id}`
+        #     or
+        #     `databases/{database_id}/tables/{table_id}/partitions/{partition_id}`
+        # @!attribute [rw] location_uri
+        #   @return [::String]
+        #     Required. The new location URI for the metadata resource.
+        class AlterMetadataResourceLocationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Metastore::V1beta::DataprocMetastore::Client#alter_metadata_resource_location DataprocMetastore.AlterMetadataResourceLocation}.
+        class AlterMetadataResourceLocationResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end