googleapis
Version:
Google APIs Client Library for Node.js
1,016 lines • 328 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace metastore_v1beta {
export interface Options extends GlobalOptions {
version: 'v1beta';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Dataproc Metastore API
*
* The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.
*
* @example
* ```js
* const {google} = require('googleapis');
* const metastore = google.metastore('v1beta');
* ```
*/
export class Metastore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for DataprocMetastore.AlterMetadataResourceLocation.
*/
export interface Schema$AlterMetadataResourceLocationRequest {
/**
* Required. The new location URI for the metadata resource.
*/
locationUri?: string | null;
/**
* 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\}
*/
resourceName?: string | null;
}
/**
* Response message for DataprocMetastore.AlterMetadataResourceLocation.
*/
export interface Schema$AlterMetadataResourceLocationResponse {
}
/**
* Request message for DataprocMetastore.AlterTableProperties.
*/
export interface Schema$AlterTablePropertiesRequest {
/**
* A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask
*/
properties?: {
[key: string]: string;
} | null;
/**
* Required. The name of the table containing the properties you're altering in the following format.databases/{database_id\}/tables/{table_id\}
*/
tableName?: string | null;
/**
* A field mask that specifies the metadata table properties that are overwritten 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.For example, given the target properties: properties { a: 1 b: 2 \} And an update properties: properties { a: 2 b: 3 c: 4 \} then if the field mask is:paths: "properties.b", "properties.c"then the result will be: properties { a: 1 b: 3 c: 4 \}
*/
updateMask?: string | null;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Represents the autoscaling configuration of a metastore service.
*/
export interface Schema$AutoscalingConfig {
/**
* Optional. Whether or not autoscaling is enabled for this service.
*/
autoscalingEnabled?: boolean | null;
/**
* Output only. The scaling factor of a service with autoscaling enabled.
*/
autoscalingFactor?: number | null;
/**
* Optional. The LimitConfig of the service.
*/
limitConfig?: Schema$LimitConfig;
}
/**
* Configuration information for the auxiliary service versions.
*/
export interface Schema$AuxiliaryVersionConfig {
/**
* Optional. 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.
*/
configOverrides?: {
[key: string]: string;
} | null;
/**
* Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.
*/
networkConfig?: Schema$NetworkConfig;
/**
* Optional. The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.
*/
version?: string | null;
}
/**
* Represents a backend metastore for the federation.
*/
export interface Schema$BackendMetastore {
/**
* The type of the backend metastore.
*/
metastoreType?: string | null;
/**
* The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: BigQuery projects/{project_id\} Dataproc Metastore projects/{project_id\}/locations/{location\}/services/{service_id\}
*/
name?: string | null;
}
/**
* The details of a backup resource.
*/
export interface Schema$Backup {
/**
* Output only. The time when the backup was started.
*/
createTime?: string | null;
/**
* Optional. The description of the backup.
*/
description?: string | null;
/**
* Output only. The time when the backup finished creating.
*/
endTime?: string | null;
/**
* Immutable. Identifier. The relative resource name of the backup, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}
*/
name?: string | null;
/**
* Output only. Services that are restoring from the backup.
*/
restoringServices?: string[] | null;
/**
* Output only. The revision of the service at the time of backup.
*/
serviceRevision?: Schema$Service;
/**
* Output only. The current state of the backup.
*/
state?: string | null;
}
/**
* Associates members, or principals, with a role.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid\}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid\}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid\}: An email address that represents a Google group. For example, admins@example.com. domain:{domain\}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x: All identities in a workload identity pool. deleted:user:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid\} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid\} and the undeleted service account retains the role in the binding. deleted:group:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid\} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Request message for DataprocMetastore.CancelMigration.
*/
export interface Schema$CancelMigrationRequest {
}
/**
* Response message for DataprocMetastore.CancelMigration.
*/
export interface Schema$CancelMigrationResponse {
/**
* The relative resource name of the migration execution, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}.
*/
migrationExecution?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore.
*/
export interface Schema$CdcConfig {
/**
* Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used.
*/
bucket?: string | null;
/**
* Required. Input only. The password for the user that Datastream service should use for the MySQL connection. This field is not returned on request.
*/
password?: string | null;
/**
* Required. The URL of the subnetwork resource to create the VM instance hosting the reverse proxy in. More context in https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy The subnetwork should reside in the network provided in the request that Datastream will peer to and should be in the same region as Datastream, in the following format. projects/{project_id\}/regions/{region_id\}/subnetworks/{subnetwork_id\}
*/
reverseProxySubnet?: string | null;
/**
* Optional. The root path inside the Cloud Storage bucket. The stream event data will be written to this path. The default value is /migration.
*/
rootPath?: string | null;
/**
* Required. A /29 CIDR IP range for peering with datastream.
*/
subnetIpRange?: string | null;
/**
* Required. The username that the Datastream service should use for the MySQL connection.
*/
username?: string | null;
/**
* Required. Fully qualified name of the Cloud SQL instance's VPC network or the shared VPC network that Datastream will peer to, in the following format: projects/{project_id\}/locations/global/networks/{network_id\}. More context in https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity
*/
vpcNetwork?: string | null;
}
/**
* Configuration information to establish customer database connection before the cutover phase of migration
*/
export interface Schema$CloudSQLConnectionConfig {
/**
* Required. The hive database name.
*/
hiveDatabaseName?: string | null;
/**
* Required. Cloud SQL database connection name (project_id:region:instance_name)
*/
instanceConnectionName?: string | null;
/**
* Required. The private IP address of the Cloud SQL instance.
*/
ipAddress?: string | null;
/**
* Required. The relative resource name of the subnetwork to be used for Private Service Connect. Note that this cannot be a regular subnet and is used only for NAT. (https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets) This subnet is used to publish the SOCKS5 proxy service. The subnet size must be at least /29 and it should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{project_id\}/regions/{region_id\}/subnetworks/{subnetwork_id\}
*/
natSubnet?: string | null;
/**
* Required. Input only. The password for the user that Dataproc Metastore service will be using to connect to the database. This field is not returned on request.
*/
password?: string | null;
/**
* Required. The network port of the database.
*/
port?: number | null;
/**
* Required. The relative resource name of the subnetwork to deploy the SOCKS5 proxy service in. The subnetwork should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{project_id\}/regions/{region_id\}/subnetworks/{subnetwork_id\}
*/
proxySubnet?: string | null;
/**
* Required. The username that Dataproc Metastore service will use to connect to the database.
*/
username?: string | null;
}
/**
* Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore.
*/
export interface Schema$CloudSQLMigrationConfig {
/**
* Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration.
*/
cdcConfig?: Schema$CdcConfig;
/**
* Required. Configuration information to establish customer database connection before the cutover phase of migration
*/
cloudSqlConnectionConfig?: Schema$CloudSQLConnectionConfig;
}
/**
* Request message for DataprocMetastore.CompleteMigration.
*/
export interface Schema$CompleteMigrationRequest {
}
/**
* Response message for DataprocMetastore.CompleteMigration.
*/
export interface Schema$CompleteMigrationResponse {
/**
* The relative resource name of the migration execution, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}.
*/
migrationExecution?: string | null;
}
/**
* Contains information of the customer's network configurations.
*/
export interface Schema$Consumer {
/**
* Output only. The location of the endpoint URI. Format: projects/{project\}/locations/{location\}.
*/
endpointLocation?: string | null;
/**
* Output only. The URI of the endpoint used to access the metastore service.
*/
endpointUri?: string | null;
/**
* 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\}
*/
subnetwork?: string | null;
}
/**
* Deprecated: Use a single region service instead. Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.
*/
export interface Schema$CustomRegionConfig {
/**
* Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.
*/
readOnlyRegions?: string[] | null;
/**
* Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.
*/
readWriteRegions?: string[] | null;
}
/**
* Deprecated: Use a single region service instead. Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.
*/
export interface Schema$CustomRegionMetadata {
/**
* The read-only regions for this custom region.
*/
optionalReadOnlyRegions?: string[] | null;
/**
* The read-write regions for this custom region.
*/
requiredReadWriteRegions?: string[] | null;
/**
* The Spanner witness region for this custom region.
*/
witnessRegion?: string | null;
}
/**
* A specification of the location of and metadata about a database dump from a relational database management system.
*/
export interface Schema$DatabaseDump {
/**
* The type of the database.
*/
databaseType?: string | null;
/**
* Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
*/
gcsUri?: string | null;
/**
* Optional. The name of the source database.
*/
sourceDatabase?: string | null;
/**
* Optional. The type of the database dump. If unspecified, defaults to MYSQL.
*/
type?: string | null;
}
/**
* Specifies how metastore metadata should be integrated with the Data Catalog service.
*/
export interface Schema$DataCatalogConfig {
/**
* Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
*/
enabled?: boolean | null;
}
/**
* Specifies how metastore metadata should be integrated with the Dataplex service.
*/
export interface Schema$DataplexConfig {
/**
* Optional. 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\}.
*/
lakeResources?: {
[key: string]: Schema$Lake;
} | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Encryption settings for the service.
*/
export interface Schema$EncryptionConfig {
/**
* Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}.
*/
kmsKey?: string | null;
/**
* Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}.
*/
kmsKeys?: string[] | null;
}
/**
* Error details in public error message for DataprocMetastore.QueryMetadata.
*/
export interface Schema$ErrorDetails {
/**
* Additional structured details about this error.Keys define the failure items. Value describes the exception or details of the item.
*/
details?: {
[key: string]: string;
} | null;
}
/**
* Request message for DataprocMetastore.ExportMetadata.
*/
export interface Schema$ExportMetadataRequest {
/**
* Optional. The type of the database dump. If unspecified, defaults to MYSQL.
*/
databaseDumpType?: string | null;
/**
* A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing exported files will be created below it.
*/
destinationGcsFolder?: string | null;
/**
* 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.
*/
requestId?: string | null;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Represents a federation of multiple backend metastores.
*/
export interface Schema$Federation {
/**
* A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
*/
backendMetastores?: {
[key: string]: Schema$BackendMetastore;
} | null;
/**
* Output only. The time when the metastore federation was created.
*/
createTime?: string | null;
/**
* Output only. The federation endpoint.
*/
endpointUri?: string | null;
/**
* User-defined labels for the metastore federation.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Immutable. The relative resource name of the federation, of the form: projects/{project_number\}/locations/{location_id\}/federations/{federation_id\}`.
*/
name?: string | null;
/**
* Output only. The current state of the federation.
*/
state?: string | null;
/**
* Output only. Additional information about the current state of the metastore federation, if available.
*/
stateMessage?: string | null;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
*/
tags?: {
[key: string]: string;
} | null;
/**
* Output only. The globally unique resource identifier of the metastore federation.
*/
uid?: string | null;
/**
* Output only. The time when the metastore federation was last updated.
*/
updateTime?: string | null;
/**
* Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
*/
version?: string | null;
}
/**
* Specifies configuration information specific to running Hive metastore software as the metastore service.
*/
export interface Schema$HiveMetastoreConfig {
/**
* Optional. 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?. 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.
*/
auxiliaryVersions?: {
[key: string]: Schema$AuxiliaryVersionConfig;
} | null;
/**
* Optional. 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). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
*/
configOverrides?: {
[key: string]: string;
} | null;
/**
* Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
*/
endpointProtocol?: string | null;
/**
* Optional. 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.
*/
kerberosConfig?: Schema$KerberosConfig;
/**
* Immutable. The Hive metastore schema version.
*/
version?: string | null;
}
/**
* A specification of a supported version of the Hive Metastore software.
*/
export interface Schema$HiveMetastoreVersion {
/**
* Whether version will be chosen by the server if a metastore service is created with a HiveMetastoreConfig that omits the version.
*/
isDefault?: boolean | null;
/**
* The semantic version of the Hive Metastore software.
*/
version?: string | null;
}
/**
* Configuration information for a Kerberos principal.
*/
export interface Schema$KerberosConfig {
/**
* Optional. A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
*/
keytab?: Schema$Secret;
/**
* Optional. 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.
*/
krb5ConfigGcsUri?: string | null;
/**
* Optional. 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.
*/
principal?: string | null;
}
/**
* Represents a Lake resource
*/
export interface Schema$Lake {
/**
* The Lake resource name. Example: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}
*/
name?: string | null;
}
/**
* The details of the latest scheduled backup.
*/
export interface Schema$LatestBackup {
/**
* Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
*/
backupId?: string | null;
/**
* Output only. The duration of the backup completion.
*/
duration?: string | null;
/**
* Output only. The time when the backup was started.
*/
startTime?: string | null;
/**
* Output only. The current state of the backup.
*/
state?: string | null;
}
/**
* Represents the autoscaling limit configuration of a metastore service.
*/
export interface Schema$LimitConfig {
/**
* Optional. The highest scaling factor that the service should be autoscaled to.
*/
maxScalingFactor?: number | null;
/**
* Optional. The lowest scaling factor that the service should be autoscaled to.
*/
minScalingFactor?: number | null;
}
/**
* Response message for DataprocMetastore.ListBackups.
*/
export interface Schema$ListBackupsResponse {
/**
* The backups of the specified service.
*/
backups?: Schema$Backup[];
/**
* A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ListFederations
*/
export interface Schema$ListFederationsResponse {
/**
* The services in the specified location.
*/
federations?: Schema$Federation[];
/**
* A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* Response message for DataprocMetastore.ListMetadataImports.
*/
export interface Schema$ListMetadataImportsResponse {
/**
* The imports in the specified service.
*/
metadataImports?: Schema$MetadataImport[];
/**
* A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for DataprocMetastore.ListMigrationExecutions.
*/
export interface Schema$ListMigrationExecutionsResponse {
/**
* The migration executions on the specified service.
*/
migrationExecutions?: Schema$MigrationExecution[];
/**
* A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
/**
* Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.
*/
unreachable?: string[] | null;
}
/**
* Response message for DataprocMetastore.ListServices.
*/
export interface Schema$ListServicesResponse {
/**
* A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The services in the specified location.
*/
services?: Schema$Service[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: "us-east1".
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string | null;
}
/**
* Metadata about the service in a location.
*/
export interface Schema$LocationMetadata {
/**
* Deprecated: Use a single region service instead. Possible configurations supported if the current region is a custom region.
*/
customRegionMetadata?: Schema$CustomRegionMetadata[];
/**
* Deprecated: Use a single region service instead. The multi-region metadata if the current region is a multi-region.
*/
multiRegionMetadata?: Schema$MultiRegionMetadata;
/**
* 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.
*/
supportedHiveMetastoreVersions?: Schema$HiveMetastoreVersion[];
}
/**
* Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.
*/
export interface Schema$MaintenanceWindow {
/**
* Optional. The day of week, when the window starts.
*/
dayOfWeek?: string | null;
/**
* Optional. The hour of day (0-23) when the window starts.
*/
hourOfDay?: number | null;
}
/**
* This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.
*/
export interface Schema$MessageSet {
}
/**
* The details of a metadata export operation.
*/
export interface Schema$MetadataExport {
/**
* Output only. The type of the database dump.
*/
databaseDumpType?: string | null;
/**
* Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
*/
destinationGcsUri?: string | null;
/**
* Output only. The time when the export ended.
*/
endTime?: string | null;
/**
* Output only. The time when the export started.
*/
startTime?: string | null;
/**
* Output only. The current state of the export.
*/
state?: string | null;
}
/**
* A metastore resource that imports metadata.
*/
export interface Schema$MetadataImport {
/**
* Output only. The time when the metadata import was started.
*/
createTime?: string | null;
/**
* Immutable. A database dump from a pre-existing metastore's database.
*/
databaseDump?: Schema$DatabaseDump;
/**
* Optional. The description of the metadata import.
*/
description?: string | null;
/**
* Output only. The time when the metadata import finished.
*/
endTime?: string | null;
/**
* Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/metadataImports/{metadata_import_id\}.
*/
name?: string | null;
/**
* Output only. The current state of the metadata import.
*/
state?: string | null;
/**
* Output only. The time when the metadata import was last updated.
*/
updateTime?: string | null;
}
/**
* Specifies how metastore metadata should be integrated with external services.
*/
export interface Schema$MetadataIntegration {
/**
* Optional. The integration config for the Data Catalog service.
*/
dataCatalogConfig?: Schema$DataCatalogConfig;
/**
* Optional. The integration config for the Dataplex service.
*/
dataplexConfig?: Schema$DataplexConfig;
}
/**
* The metadata management activities of the metastore service.
*/
export interface Schema$MetadataManagementActivity {
/**
* Output only. The latest metadata exports of the metastore service.
*/
metadataExports?: Schema$MetadataExport[];
/**
* Output only. The latest restores of the metastore service.
*/
restores?: Schema$Restore[];
}
/**
* The details of a migration execution resource.
*/
export interface Schema$MigrationExecution {
/**
* Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore.
*/
cloudSqlMigrationConfig?: Schema$CloudSQLMigrationConfig;
/**
* Output only. The time when the migration execution was started.
*/
createTime?: string | null;
/**
* Output only. The time when the migration execution finished.
*/
endTime?: string | null;
/**
* Output only. The relative resource name of the migration execution, in the following form: projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}
*/
name?: string | null;
/**
* Output only. The current phase of the migration execution.
*/
phase?: string | null;
/**
* Output only. The current state of the migration execution.
*/
state?: string | null;
/**
* Output only. Additional information about the current state of the migration execution.
*/
stateMessage?: string | null;
}
/**
* Request message for DataprocMetastore.MoveTableToDatabase.
*/
export interface Schema$MoveTableToDatabaseRequest {
/**
* Required. The name of the database where the table resides.
*/
dbName?: string | null;
/**
* Required. The name of the database where the table should be moved.
*/
destinationDbName?: string | null;
/**
* Required. The name of the table to be moved.
*/
tableName?: string | null;
}
/**
* Response message for DataprocMetastore.MoveTableToDatabase.
*/
export interface Schema$MoveTableToDatabaseResponse {
}
/**
* Deprecated: Use a single region service instead. The multi-region config for the Dataproc Metastore service.
*/
export interface Schema$MultiRegionConfig {
/**
* Output only. Deprecated: Use a single region service instead. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.
*/
certificates?: Schema$RootCACertificate[];
/**
* Immutable. Deprecated: Use a single region service instead.
*/
customRegionConfig?: Schema$CustomRegionConfig;
}
/**
* Deprecated: Use a single region service instead. The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.
*/
export interface Schema$MultiRegionMetadata {
/**
* The regions constituting the multi-region.
*/
constituentRegions?: string[] | null;
/**
* The continent for this multi-region.
*/
continent?: string | null;
/**
* The Spanner witness region for this multi-region.
*/
witnessRegion?: string | null;
}
/**
* Network configuration for the Dataproc Metastore service.
*/
export interface Schema$NetworkConfig {
/**
* Im