package google.events.cloud.metastore.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Configuration information for the auxiliary service versions.

Used in: HiveMetastoreConfig

• string version = 1

  The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

• map<string, string> config_overrides = 2

  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.

• optional NetworkConfig network_config = 3

  Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.

Represents a backend metastore for the federation.

Used in: Federation

• string name = 1

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

• BackendMetastore.MetastoreType metastore_type = 2

  The type of the backend metastore.

The type of the backend metastore.

Used in: BackendMetastore

• METASTORE_TYPE_UNSPECIFIED = 0

  The metastore type is not set.

• DATAPROC_METASTORE = 3

  The backend metastore is Dataproc Metastore.

The details of a backup resource.

Used in: BackupEventData

• string name = 1

  Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}`

• optional protobuf.Timestamp create_time = 2

  Output only. The time when the backup was started.

• optional protobuf.Timestamp end_time = 3

  Output only. The time when the backup finished creating.

• Backup.State state = 4

  Output only. The current state of the backup.

• optional Service service_revision = 5

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

• string description = 6

  The description of the backup.

• repeated string restoring_services = 7

  Output only. Services that are restoring from the backup.

The current state of the backup.

Used in: Backup

• STATE_UNSPECIFIED = 0

  The state of the backup is unknown.

• CREATING = 1

  The backup is being created.

• DELETING = 2

  The backup is being deleted.

• ACTIVE = 3

  The backup is active and ready to use.

• FAILED = 4

  The backup failed.

• RESTORING = 5

  The backup is being restored.

The CloudEvent raised when a Backup is created.

• optional BackupEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Backup is deleted.

• optional BackupEventData data = 1

  The data associated with the event.

The data within all Backup events.

Used in: BackupCreatedEvent, BackupDeletedEvent

• optional Backup payload = 1

  Optional. The Backup event payload. Unset for deletion events.

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

(message has no fields)

The type of the database dump.

Used in: MetadataExport, MetadataImport.DatabaseDump

• TYPE_UNSPECIFIED = 0

  The type of the database dump is unknown.

• MYSQL = 1

  Database dump is a MySQL dump file.

• AVRO = 2

  Database dump contains Avro files.

Encryption settings for the service.

Used in: Service

• string kms_key = 1

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

Represents a federation of multiple backend metastores.

Used in: FederationEventData

• string name = 1

  Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

• optional protobuf.Timestamp create_time = 2

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

• optional protobuf.Timestamp update_time = 3

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

• map<string, string> labels = 4

  User-defined labels for the metastore federation.

• string version = 5

  Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

• map<int32, BackendMetastore> backend_metastores = 6

  A map from `BackendMetastore` rank to `BackendMetastore`s from which the federation service serves metadata at query time. The map key represents the order in which `BackendMetastore`s 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.

• string endpoint_uri = 7

  Output only. The federation endpoint.

• Federation.State state = 8

  Output only. The current state of the federation.

• string state_message = 9

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

• string uid = 10

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

The current state of the federation.

Used in: Federation

• STATE_UNSPECIFIED = 0

  The state of the metastore federation is unknown.

• CREATING = 1

  The metastore federation is in the process of being created.

• ACTIVE = 2

  The metastore federation is running and ready to serve queries.

• UPDATING = 3

  The metastore federation is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.

• DELETING = 4

  The metastore federation is undergoing deletion. It cannot be used.

• ERROR = 5

  The metastore federation has encountered an error and cannot be used. The metastore federation should be deleted.

The CloudEvent raised when a Federation is created.

• optional FederationEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Federation is deleted.

• optional FederationEventData data = 1

  The data associated with the event.

The data within all Federation events.

Used in: FederationCreatedEvent, FederationDeletedEvent, FederationUpdatedEvent

• optional Federation payload = 1

  Optional. The Federation event payload. Unset for deletion events.

The CloudEvent raised when a Federation is updated.

• optional FederationEventData data = 1

  The data associated with the event.

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

Used in: Service

• string version = 1

  Immutable. The Hive metastore schema version.

• map<string, string> config_overrides = 2

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

• optional KerberosConfig kerberos_config = 3

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

• map<string, AuxiliaryVersionConfig> auxiliary_versions = 5

  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.

Configuration information for a Kerberos principal.

Used in: HiveMetastoreConfig

• optional Secret keytab = 1

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

• string principal = 2

  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.

• string krb5_config_gcs_uri = 3

  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.

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

Used in: Service

• optional protobuf.Int32Value hour_of_day = 1

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

• type.DayOfWeek day_of_week = 2

  The day of week, when the window starts.

The details of a metadata export operation.

Used in: MetadataManagementActivity

• oneof destination

  • string destination_gcs_uri = 4

    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.

• optional protobuf.Timestamp start_time = 1

  Output only. The time when the export started.

• optional protobuf.Timestamp end_time = 2

  Output only. The time when the export ended.

• MetadataExport.State state = 3

  Output only. The current state of the export.

• DatabaseDumpSpec.Type database_dump_type = 5

  Output only. The type of the database dump.

The current state of the metadata export.

Used in: MetadataExport

• STATE_UNSPECIFIED = 0

  The state of the metadata export is unknown.

• RUNNING = 1

  The metadata export is running.

• SUCCEEDED = 2

  The metadata export completed successfully.

• FAILED = 3

  The metadata export failed.

• CANCELLED = 4

  The metadata export is cancelled.

A metastore resource that imports metadata.

Used in: MetadataImportEventData

• oneof metadata

  The metadata to be imported.

  • MetadataImport.DatabaseDump database_dump = 6

    Immutable. A database dump from a pre-existing metastore's database.

• string name = 1

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

• string description = 2

  The description of the metadata import.

• optional protobuf.Timestamp create_time = 3

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

• optional protobuf.Timestamp update_time = 4

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

• optional protobuf.Timestamp end_time = 7

  Output only. The time when the metadata import finished.

• MetadataImport.State state = 5

  Output only. The current state of the metadata import.

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

Used in: MetadataImport

• DatabaseDump.DatabaseType database_type = 1

  The type of the database.

• string gcs_uri = 2

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

• string source_database = 3

  The name of the source database.

• DatabaseDumpSpec.Type type = 4

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

The type of the database.

Used in: DatabaseDump

• DATABASE_TYPE_UNSPECIFIED = 0

  The type of the source database is unknown.

• MYSQL = 1

  The type of the source database is MySQL.

The current state of the metadata import.

Used in: MetadataImport

• STATE_UNSPECIFIED = 0

  The state of the metadata import is unknown.

• RUNNING = 1

  The metadata import is running.

• SUCCEEDED = 2

  The metadata import completed successfully.

• UPDATING = 3

  The metadata import is being updated.

• FAILED = 4

  The metadata import failed, and attempted metadata changes were rolled back.

The CloudEvent raised when a MetadataImport is created.

• optional MetadataImportEventData data = 1

  The data associated with the event.

The data within all MetadataImport events.

Used in: MetadataImportCreatedEvent, MetadataImportUpdatedEvent

• optional MetadataImport payload = 1

  The MetadataImport event payload.

The CloudEvent raised when a MetadataImport is updated.

• optional MetadataImportEventData data = 1

  The data associated with the event.

The metadata management activities of the metastore service.

Used in: Service

• repeated MetadataExport metadata_exports = 1

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

• repeated Restore restores = 2

  Output only. The latest restores of the metastore service.

Network configuration for the Dataproc Metastore service.

Used in: AuxiliaryVersionConfig, Service

• repeated NetworkConfig.Consumer consumers = 1

  Immutable. The consumer-side network configuration for the Dataproc Metastore instance.

Contains information of the customer's network configurations.

Used in: NetworkConfig

• oneof vpc_resource

  • string subnetwork = 1

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

• string endpoint_uri = 3

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

The details of a metadata restore operation.

Used in: MetadataManagementActivity

• optional protobuf.Timestamp start_time = 1

  Output only. The time when the restore started.

• optional protobuf.Timestamp end_time = 2

  Output only. The time when the restore ended.

• Restore.State state = 3

  Output only. The current state of the restore.

• string backup = 4

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

• Restore.RestoreType type = 5

  Output only. The type of restore.

• string details = 6

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

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

Used in: Restore

• RESTORE_TYPE_UNSPECIFIED = 0

  The restore type is unknown.

• FULL = 1

  The service's metadata and configuration are restored.

• METADATA_ONLY = 2

  Only the service's metadata is restored.

The current state of the restore.

Used in: Restore

• STATE_UNSPECIFIED = 0

  The state of the metadata restore is unknown.

• RUNNING = 1

  The metadata restore is running.

• SUCCEEDED = 2

  The metadata restore completed successfully.

• FAILED = 3

  The metadata restore failed.

• CANCELLED = 4

  The metadata restore is cancelled.

Represents the scaling configuration of a metastore service.

Used in: Service

• oneof scaling_model

  Represents either a predetermined instance size or a numeric scaling factor.

  • ScalingConfig.InstanceSize instance_size = 1

    An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))

  • float scaling_factor = 2

    Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.

Metastore instance sizes.

Used in: ScalingConfig

• INSTANCE_SIZE_UNSPECIFIED = 0

  Unspecified instance size

• EXTRA_SMALL = 1

  Extra small instance size, maps to a scaling factor of 0.1.

• SMALL = 2

  Small instance size, maps to a scaling factor of 0.5.

• MEDIUM = 3

  Medium instance size, maps to a scaling factor of 1.0.

• LARGE = 4

  Large instance size, maps to a scaling factor of 3.0.

• EXTRA_LARGE = 5

  Extra large instance size, maps to a scaling factor of 6.0.

A securely stored value.

Used in: KerberosConfig

• oneof value

  • string cloud_secret = 2

    The relative resource name of a Secret Manager secret version, in the following form: `projects/{project_number}/secrets/{secret_id}/versions/{version_id}`.

A managed metastore service that serves metadata queries.

Used in: Backup, ServiceEventData

• oneof metastore_config

  Configuration properties specific to the underlying metastore service technology (the software that serves metastore queries).

  • HiveMetastoreConfig hive_metastore_config = 5

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

• string name = 1

  Immutable. The relative resource name of the metastore service, in the following format: `projects/{project_number}/locations/{location_id}/services/{service_id}`.

• optional protobuf.Timestamp create_time = 2

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

• optional protobuf.Timestamp update_time = 3

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

• map<string, string> labels = 4

  User-defined labels for the metastore service.

• string network = 7

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

• string endpoint_uri = 8

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

• int32 port = 9

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

• Service.State state = 10

  Output only. The current state of the metastore service.

• string state_message = 11

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

• string artifact_gcs_uri = 12

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

• Service.Tier tier = 13

  The tier of the service.

• optional MaintenanceWindow maintenance_window = 15

  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.

• string uid = 16

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

• optional MetadataManagementActivity metadata_management_activity = 17

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

• Service.ReleaseChannel release_channel = 19

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

• optional EncryptionConfig encryption_config = 20

  Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

• optional NetworkConfig network_config = 21

  The configuration specifying the network settings for the Dataproc Metastore service.

• Service.DatabaseType database_type = 22

  Immutable. The database type that the Metastore service stores its data.

• optional TelemetryConfig telemetry_config = 23

  The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to `JSON`.

• optional ScalingConfig scaling_config = 24

  Scaling configuration of the metastore service.

The backend database type for the metastore service.

Used in: Service

• DATABASE_TYPE_UNSPECIFIED = 0

  The DATABASE_TYPE is not set.

• MYSQL = 1

  MySQL is used to persist the metastore data.

• SPANNER = 2

  Spanner is used to persist the metastore data.

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.

Used in: Service

• RELEASE_CHANNEL_UNSPECIFIED = 0

  Release channel is not specified.

• CANARY = 1

  The `CANARY` release channel contains the newest features, which may be unstable and subject to unresolved issues with no known workarounds. Services using the `CANARY` release channel are not subject to any SLAs.

• STABLE = 2

  The `STABLE` release channel contains features that are considered stable and have been validated for production use.

The current state of the metastore service.

Used in: Service

• STATE_UNSPECIFIED = 0

  The state of the metastore service is unknown.

• CREATING = 1

  The metastore service is in the process of being created.

• ACTIVE = 2

  The metastore service is running and ready to serve queries.

• SUSPENDING = 3

  The metastore service is entering suspension. Its query-serving availability may cease unexpectedly.

• SUSPENDED = 4

  The metastore service is suspended and unable to serve queries.

• UPDATING = 5

  The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.

• DELETING = 6

  The metastore service is undergoing deletion. It cannot be used.

• ERROR = 7

  The metastore service has encountered an error and cannot be used. The metastore service should be deleted.

Available service tiers.

Used in: Service

• TIER_UNSPECIFIED = 0

  The tier is not set.

• DEVELOPER = 1

  The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept.

• ENTERPRISE = 3

  The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads.

The CloudEvent raised when a Service is created.

• optional ServiceEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Service is deleted.

• optional ServiceEventData data = 1

  The data associated with the event.

The data within all Service events.

Used in: ServiceCreatedEvent, ServiceDeletedEvent, ServiceUpdatedEvent

• optional Service payload = 1

  Optional. The Service event payload. Unset for deletion events.

The CloudEvent raised when a Service is updated.

• optional ServiceEventData data = 1

  The data associated with the event.

Telemetry Configuration for the Dataproc Metastore service.

Used in: Service

• TelemetryConfig.LogFormat log_format = 1

  The output format of the Dataproc Metastore service's logs.

Used in: TelemetryConfig

• LOG_FORMAT_UNSPECIFIED = 0

  The LOG_FORMAT is not set.

• LEGACY = 1

  Logging output uses the legacy `textPayload` format.

• JSON = 2

  Logging output uses the `jsonPayload` format.