As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Metastore v1alpha API

class google.cloud.metastore_v1alpha.types.Backup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The details of a backup resource.

name

Immutable. The relative resource name of the backup, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}

Type

str

create_time

Output only. The time when the backup was started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time when the backup finished creating.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of the backup.

Type

google.cloud.metastore_v1alpha.types.Backup.State

service_revision

Output only. The revision of the service at the time of backup.

Type

google.cloud.metastore_v1alpha.types.Service

description

The description of the backup.

Type

str

class State(value)[source]

Bases: proto.enums.Enum

The current state of the backup.

ACTIVE = 3
CREATING = 1
DELETING = 2
FAILED = 4
STATE_UNSPECIFIED = 0
class google.cloud.metastore_v1alpha.types.CreateBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup].

parent

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}

Type

str

backup_id

Required. The ID of the backup, which is used as the final component of the backup’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.

Type

str

backup

Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request’s backup_id field.

Type

google.cloud.metastore_v1alpha.types.Backup

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.CreateMetadataImportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport].

parent

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}

Type

str

metadata_import_id

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.

Type

str

metadata_import

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.

Type

google.cloud.metastore_v1alpha.types.MetadataImport

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.CreateServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1alpha.DataprocMetastore.CreateService].

parent

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}.

Type

str

service_id

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.

Type

str

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.

Type

google.cloud.metastore_v1alpha.types.Service

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.DataCatalogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies how metastore metadata should be integrated with the Data Catalog service.

enabled

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

Type

bool

class google.cloud.metastore_v1alpha.types.DatabaseDumpSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The specification of database dump to import from or export to.

class Type(value)[source]

Bases: proto.enums.Enum

The type of the database dump.

MYSQL = 1
TYPE_UNSPECIFIED = 0
class google.cloud.metastore_v1alpha.types.DeleteBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup].

name

Required. The relative resource name of the backup to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Type

str

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.DeleteServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService].

name

Required. The relative resource name of the metastore service to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Type

str

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.ExportMetadataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.ExportMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata].

destination_gcs_folder

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.

Type

str

service

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}

Type

str

request_id

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. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

database_dump_type

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

Type

google.cloud.metastore_v1alpha.types.DatabaseDumpSpec.Type

class google.cloud.metastore_v1alpha.types.GetBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup].

name

Required. The relative resource name of the backup to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Type

str

class google.cloud.metastore_v1alpha.types.GetMetadataImportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport].

name

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}.

Type

str

class google.cloud.metastore_v1alpha.types.GetServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1alpha.DataprocMetastore.GetService].

name

Required. The relative resource name of the metastore service to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Type

str

class google.cloud.metastore_v1alpha.types.HiveMetastoreConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies configuration information specific to running Hive metastore software as the metastore service.

version

Immutable. The Hive metastore schema version.

Type

str

config_overrides

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).

Type

Sequence[google.cloud.metastore_v1alpha.types.HiveMetastoreConfig.ConfigOverridesEntry]

kerberos_config

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.

Type

google.cloud.metastore_v1alpha.types.KerberosConfig

class ConfigOverridesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.metastore_v1alpha.types.KerberosConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration information for a Kerberos principal.

keytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).

Type

google.cloud.metastore_v1alpha.types.Secret

principal

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.

Type

str

krb5_config_gcs_uri

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.

Type

str

class google.cloud.metastore_v1alpha.types.ListBackupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].

parent

Required. The relative resource name of the service whose backups to list, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups.

Type

str

page_size

Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000.

Type

int

page_token

Optional. A page token, received from a previous [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] 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 [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] must match the call that provided the page token.

Type

str

filter

Optional. The filter to apply to list results.

Type

str

order_by

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

Type

str

class google.cloud.metastore_v1alpha.types.ListBackupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].

backups

The backups of the specified service.

Type

Sequence[google.cloud.metastore_v1alpha.types.Backup]

next_page_token

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

unreachable

Locations that could not be reached.

Type

Sequence[str]

property raw_page
class google.cloud.metastore_v1alpha.types.ListMetadataImportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].

parent

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.

Type

str

page_size

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.

Type

int

page_token

Optional. A page token, received from a previous [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.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 [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] must match the call that provided the page token.

Type

str

filter

Optional. The filter to apply to list results.

Type

str

order_by

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

Type

str

class google.cloud.metastore_v1alpha.types.ListMetadataImportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].

metadata_imports

The imports in the specified service.

Type

Sequence[google.cloud.metastore_v1alpha.types.MetadataImport]

next_page_token

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

unreachable

Locations that could not be reached.

Type

Sequence[str]

property raw_page
class google.cloud.metastore_v1alpha.types.ListServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].

parent

Required. The relative resource name of the location of metastore services to list, in the following form:

projects/{project_number}/locations/{location_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A page token, received from a previous [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.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 [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] must match the call that provided the page token.

Type

str

filter

Optional. The filter to apply to list results.

Type

str

order_by

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

Type

str

class google.cloud.metastore_v1alpha.types.ListServicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].

services

The services in the specified location.

Type

Sequence[google.cloud.metastore_v1alpha.types.Service]

next_page_token

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

unreachable

Locations that could not be reached.

Type

Sequence[str]

property raw_page
class google.cloud.metastore_v1alpha.types.LocationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata about the service in a location.

supported_hive_metastore_versions

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.

Type

Sequence[google.cloud.metastore_v1alpha.types.LocationMetadata.HiveMetastoreVersion]

class HiveMetastoreVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A specification of a supported version of the Hive Metastore software.

version

The semantic version of the Hive Metastore software.

Type

str

is_default

Whether version will be chosen by the server if a metastore service is created with a HiveMetastoreConfig that omits the version.

Type

bool

class google.cloud.metastore_v1alpha.types.MaintenanceWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.

hour_of_day

The hour of day (0-23) when the window starts.

Type

google.protobuf.wrappers_pb2.Int32Value

day_of_week

The day of week, when the window starts.

Type

google.type.dayofweek_pb2.DayOfWeek

class google.cloud.metastore_v1alpha.types.MetadataExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The details of a metadata export operation.

destination_gcs_uri

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.

Type

str

start_time

Output only. The time when the export started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time when the export ended.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of the export.

Type

google.cloud.metastore_v1alpha.types.MetadataExport.State

database_dump_type

Output only. The type of the database dump.

Type

google.cloud.metastore_v1alpha.types.DatabaseDumpSpec.Type

class State(value)[source]

Bases: proto.enums.Enum

The current state of the metadata export.

CANCELLED = 4
FAILED = 3
RUNNING = 1
STATE_UNSPECIFIED = 0
SUCCEEDED = 2
class google.cloud.metastore_v1alpha.types.MetadataImport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A metastore resource that imports metadata.

database_dump

Immutable. A database dump from a pre- xisting metastore’s database.

Type

google.cloud.metastore_v1alpha.types.MetadataImport.DatabaseDump

name

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}.

Type

str

description

The description of the metadata import.

Type

str

create_time

Output only. The time when the metadata import was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the metadata import was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of the metadata import.

Type

google.cloud.metastore_v1alpha.types.MetadataImport.State

class DatabaseDump(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A specification of the location of and metadata about a database dump from a relational database management system.

database_type

The type of the database.

Type

google.cloud.metastore_v1alpha.types.MetadataImport.DatabaseDump.DatabaseType

gcs_uri

A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.

Type

str

source_database

The name of the source database.

Type

str

type_

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

Type

google.cloud.metastore_v1alpha.types.DatabaseDumpSpec.Type

class DatabaseType(value)[source]

Bases: proto.enums.Enum

The type of the database.

DATABASE_TYPE_UNSPECIFIED = 0
MYSQL = 1
class State(value)[source]

Bases: proto.enums.Enum

The current state of the metadata import.

FAILED = 4
RUNNING = 1
STATE_UNSPECIFIED = 0
SUCCEEDED = 2
UPDATING = 3
class google.cloud.metastore_v1alpha.types.MetadataIntegration(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies how metastore metadata should be integrated with external services.

data_catalog_config

The integration config for the Data Catalog service.

Type

google.cloud.metastore_v1alpha.types.DataCatalogConfig

class google.cloud.metastore_v1alpha.types.MetadataManagementActivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The metadata management activities of the metastore service.

metadata_exports

Output only. The latest metadata exports of the metastore service.

Type

Sequence[google.cloud.metastore_v1alpha.types.MetadataExport]

restores

Output only. The latest restores of the metastore service.

Type

Sequence[google.cloud.metastore_v1alpha.types.Restore]

class google.cloud.metastore_v1alpha.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the metadata of a long-running operation.

create_time

Output only. The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Output only. Server-defined resource path for the target of the operation.

Type

str

verb

Output only. Name of the verb executed by the operation.

Type

str

status_message

Output only. Human-readable status of the operation, if any.

Type

str

requested_cancellation

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.

Type

bool

api_version

Output only. API version used to start the operation.

Type

str

class google.cloud.metastore_v1alpha.types.Restore(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The details of a metadata restore operation.

start_time

Output only. The time when the restore started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time when the restore ended.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of the restore.

Type

google.cloud.metastore_v1alpha.types.Restore.State

backup

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}

Type

str

type_

Output only. The type of restore.

Type

google.cloud.metastore_v1alpha.types.Restore.RestoreType

details

Output only. The restore details containing the revision of the service to be restored to, in format of JSON.

Type

str

class RestoreType(value)[source]

Bases: proto.enums.Enum

The type of restore.

FULL = 1
METADATA_ONLY = 2
RESTORE_TYPE_UNSPECIFIED = 0
class State(value)[source]

Bases: proto.enums.Enum

The current state of the restore.

CANCELLED = 4
FAILED = 3
RUNNING = 1
STATE_UNSPECIFIED = 0
SUCCEEDED = 2
class google.cloud.metastore_v1alpha.types.RestoreServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.Restore][].

service

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}

Type

str

backup

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}

Type

str

restore_type

Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.

Type

google.cloud.metastore_v1alpha.types.Restore.RestoreType

request_id

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. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.Secret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A securely stored value.

cloud_secret

The relative resource name of a Secret Manager secret version, in the following form:

projects/{project_number}/secrets/{secret_id}/versions/{version_id}.

Type

str

class google.cloud.metastore_v1alpha.types.Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A managed metastore service that serves metadata queries.

hive_metastore_config

Configuration information specific to running Hive metastore software as the metastore service.

Type

google.cloud.metastore_v1alpha.types.HiveMetastoreConfig

name

Immutable. The relative resource name of the metastore service, of the form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Type

str

create_time

Output only. The time when the metastore service was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the metastore service was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

labels

User-defined labels for the metastore service.

Type

Sequence[google.cloud.metastore_v1alpha.types.Service.LabelsEntry]

network

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}.

Type

str

endpoint_uri

Output only. The URI of the endpoint used to access the metastore service.

Type

str

port

The TCP port at which the metastore service is reached. Default: 9083.

Type

int

state

Output only. The current state of the metastore service.

Type

google.cloud.metastore_v1alpha.types.Service.State

state_message

Output only. Additional information about the current state of the metastore service, if available.

Type

str

artifact_gcs_uri

Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

Type

str

tier

The tier of the service.

Type

google.cloud.metastore_v1alpha.types.Service.Tier

metadata_integration

The setting that defines how metastore metadata should be integrated with external services and systems.

Type

google.cloud.metastore_v1alpha.types.MetadataIntegration

maintenance_window

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time.

Type

google.cloud.metastore_v1alpha.types.MaintenanceWindow

uid

Output only. The globally unique resource identifier of the metastore service.

Type

str

metadata_management_activity

Output only. The metadata management activities of the metastore service.

Type

google.cloud.metastore_v1alpha.types.MetadataManagementActivity

release_channel

Immutable. The release channel of the service. If unspecified, defaults to STABLE.

Type

google.cloud.metastore_v1alpha.types.Service.ReleaseChannel

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class ReleaseChannel(value)[source]

Bases: proto.enums.Enum

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.

CANARY = 1
RELEASE_CHANNEL_UNSPECIFIED = 0
STABLE = 2
class State(value)[source]

Bases: proto.enums.Enum

The current state of the metastore service.

ACTIVE = 2
CREATING = 1
DELETING = 6
ERROR = 7
STATE_UNSPECIFIED = 0
SUSPENDED = 4
SUSPENDING = 3
UPDATING = 5
class Tier(value)[source]

Bases: proto.enums.Enum

Available service tiers.

DEVELOPER = 1
ENTERPRISE = 3
TIER_UNSPECIFIED = 0
class google.cloud.metastore_v1alpha.types.UpdateMetadataImportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport].

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

metadata_import

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.

Type

google.cloud.metastore_v1alpha.types.MetadataImport

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str

class google.cloud.metastore_v1alpha.types.UpdateServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService].

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

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.

Type

google.cloud.metastore_v1alpha.types.Service

request_id

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 A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Type

str