gcp_metastore_service

ancestors

Type: UNORDERED_LIST_STRING

artifact_gcs_uri

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

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time when the metastore service was created.

database_type

Type: STRING
Provider name: databaseType
Description: Immutable. The database type that the Metastore service stores its data.
Possible values:

  • DATABASE_TYPE_UNSPECIFIED - The DATABASE_TYPE is not set.
  • MYSQL - MySQL is used to persist the metastore data.
  • SPANNER - Spanner is used to persist the metastore data.

deletion_protection

Type: BOOLEAN
Provider name: deletionProtection
Description: Optional. Indicates if the dataproc metastore should be protected against accidental deletions.

encryption_config

Type: STRUCT
Provider name: encryptionConfig
Description: Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

  • kms_key
    Type: STRING
    Provider name: kmsKey
    Description: 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}.

endpoint_uri

Type: STRING
Provider name: endpointUri
Description: Output only. The URI of the endpoint used to access the metastore service.

hive_metastore_config

Type: STRUCT
Provider name: hiveMetastoreConfig
Description: Configuration information specific to running Hive metastore software as the metastore service.

  • endpoint_protocol
    Type: STRING
    Provider name: endpointProtocol
    Description: Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
    Possible values:
    • ENDPOINT_PROTOCOL_UNSPECIFIED - The protocol is not set.
    • THRIFT - Use the legacy Apache Thrift protocol for the metastore service endpoint.
    • GRPC - Use the modernized gRPC protocol for the metastore service endpoint.
  • kerberos_config
    Type: STRUCT
    Provider name: kerberosConfig
    Description: 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.
    • keytab
      Type: STRUCT
      Provider name: keytab
      Description: Optional. A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
      • cloud_secret
        Type: STRING
        Provider name: cloudSecret
        Description: Optional. The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.
    • krb5_config_gcs_uri
      Type: STRING
      Provider name: krb5ConfigGcsUri
      Description: 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.
    • principal
      Type: STRING
      Provider name: principal
      Description: 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.
  • version
    Type: STRING
    Provider name: version
    Description: Immutable. The Hive metastore schema version.

labels

Type: UNORDERED_LIST_STRING

maintenance_window

Type: STRUCT
Provider name: maintenanceWindow
Description: Optional. 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.

  • day_of_week
    Type: STRING
    Provider name: dayOfWeek
    Description: Optional. The day of week, when the window starts.
    Possible values:
    • DAY_OF_WEEK_UNSPECIFIED - The day of the week is unspecified.
    • MONDAY - Monday
    • TUESDAY - Tuesday
    • WEDNESDAY - Wednesday
    • THURSDAY - Thursday
    • FRIDAY - Friday
    • SATURDAY - Saturday
    • SUNDAY - Sunday
  • hour_of_day
    Type: INT32
    Provider name: hourOfDay
    Description: Optional. The hour of day (0-23) when the window starts.

metadata_integration

Type: STRUCT
Provider name: metadataIntegration
Description: Optional. The setting that defines how metastore metadata should be integrated with external services and systems.

  • data_catalog_config
    Type: STRUCT
    Provider name: dataCatalogConfig
    Description: Optional. The integration config for the Data Catalog service.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

metadata_management_activity

Type: STRUCT
Provider name: metadataManagementActivity
Description: Output only. The metadata management activities of the metastore service.

  • metadata_exports
    Type: UNORDERED_LIST_STRUCT
    Provider name: metadataExports
    Description: Output only. The latest metadata exports of the metastore service.
    • database_dump_type
      Type: STRING
      Provider name: databaseDumpType
      Description: Output only. The type of the database dump.
      Possible values:
      • TYPE_UNSPECIFIED - The type of the database dump is unknown.
      • MYSQL - Database dump is a MySQL dump file.
      • AVRO - Database dump contains Avro files.
    • destination_gcs_uri
      Type: STRING
      Provider name: destinationGcsUri
      Description: Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
    • end_time
      Type: TIMESTAMP
      Provider name: endTime
      Description: Output only. The time when the export ended.
    • start_time
      Type: TIMESTAMP
      Provider name: startTime
      Description: Output only. The time when the export started.
    • state
      Type: STRING
      Provider name: state
      Description: Output only. The current state of the export.
      Possible values:
      • STATE_UNSPECIFIED - The state of the metadata export is unknown.
      • RUNNING - The metadata export is running.
      • SUCCEEDED - The metadata export completed successfully.
      • FAILED - The metadata export failed.
      • CANCELLED - The metadata export is cancelled.
  • restores
    Type: UNORDERED_LIST_STRUCT
    Provider name: restores
    Description: Output only. The latest restores of the metastore service.
    • backup
      Type: STRING
      Provider name: backup
      Description: 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}.
    • backup_location
      Type: STRING
      Provider name: backupLocation
      Description: Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.
    • details
      Type: STRING
      Provider name: details
      Description: Output only. The restore details containing the revision of the service to be restored to, in format of JSON.
    • end_time
      Type: TIMESTAMP
      Provider name: endTime
      Description: Output only. The time when the restore ended.
    • start_time
      Type: TIMESTAMP
      Provider name: startTime
      Description: Output only. The time when the restore started.
    • state
      Type: STRING
      Provider name: state
      Description: Output only. The current state of the restore.
      Possible values:
      • STATE_UNSPECIFIED - The state of the metadata restore is unknown.
      • RUNNING - The metadata restore is running.
      • SUCCEEDED - The metadata restore completed successfully.
      • FAILED - The metadata restore failed.
      • CANCELLED - The metadata restore is cancelled.
    • type
      Type: STRING
      Provider name: type
      Description: Output only. The type of restore.
      Possible values:
      • RESTORE_TYPE_UNSPECIFIED - The restore type is unknown.
      • FULL - The service’s metadata and configuration are restored.
      • METADATA_ONLY - Only the service’s metadata is restored.

name

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

network

Type: STRING
Provider name: network
Description: 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}.

network_config

Type: STRUCT
Provider name: networkConfig
Description: Optional. The configuration specifying the network settings for the Dataproc Metastore service.

  • consumers
    Type: UNORDERED_LIST_STRUCT
    Provider name: consumers
    Description: Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
    • endpoint_location
      Type: STRING
      Provider name: endpointLocation
      Description: Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
    • endpoint_uri
      Type: STRING
      Provider name: endpointUri
      Description: Output only. The URI of the endpoint used to access the metastore service.
    • subnetwork
      Type: STRING
      Provider name: subnetwork
      Description: 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}

organization_id

Type: STRING

parent

Type: STRING

port

Type: INT32
Provider name: port
Description: Optional. The TCP port at which the metastore service is reached. Default: 9083.

project_id

Type: STRING

project_number

Type: STRING

release_channel

Type: STRING
Provider name: releaseChannel
Description: Immutable. The release channel of the service. If unspecified, defaults to STABLE.
Possible values:

  • RELEASE_CHANNEL_UNSPECIFIED - Release channel is not specified.
  • CANARY - 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 - The STABLE release channel contains features that are considered stable and have been validated for production use.

resource_name

Type: STRING

scaling_config

Type: STRUCT
Provider name: scalingConfig
Description: Optional. Scaling configuration of the metastore service.

  • autoscaling_config
    Type: STRUCT
    Provider name: autoscalingConfig
    Description: Optional. The autoscaling configuration.
    • autoscaling_enabled
      Type: BOOLEAN
      Provider name: autoscalingEnabled
      Description: Optional. Whether or not autoscaling is enabled for this service.
    • autoscaling_factor
      Type: FLOAT
      Provider name: autoscalingFactor
      Description: Output only. The scaling factor of a service with autoscaling enabled.
    • limit_config
      Type: STRUCT
      Provider name: limitConfig
      Description: Optional. The LimitConfig of the service.
      • max_scaling_factor
        Type: FLOAT
        Provider name: maxScalingFactor
        Description: Optional. The highest scaling factor that the service should be autoscaled to.
      • min_scaling_factor
        Type: FLOAT
        Provider name: minScalingFactor
        Description: Optional. The lowest scaling factor that the service should be autoscaled to.
  • instance_size
    Type: STRING
    Provider name: instanceSize
    Description: An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
    Possible values:
    • INSTANCE_SIZE_UNSPECIFIED - Unspecified instance size
    • EXTRA_SMALL - Extra small instance size, maps to a scaling factor of 0.1.
    • SMALL - Small instance size, maps to a scaling factor of 0.5.
    • MEDIUM - Medium instance size, maps to a scaling factor of 1.0.
    • LARGE - Large instance size, maps to a scaling factor of 3.0.
    • EXTRA_LARGE - Extra large instance size, maps to a scaling factor of 6.0.
  • scaling_factor
    Type: FLOAT
    Provider name: scalingFactor
    Description: Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.

scheduled_backup

Type: STRUCT
Provider name: scheduledBackup
Description: Optional. The configuration of scheduled backup for the metastore service.

  • backup_location
    Type: STRING
    Provider name: backupLocation
    Description: Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
  • cron_schedule
    Type: STRING
    Provider name: cronSchedule
    Description: Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: Optional. Defines whether the scheduled backup is enabled. The default value is false.
  • latest_backup
    Type: STRUCT
    Provider name: latestBackup
    Description: Output only. The details of the latest scheduled backup.
    • backup_id
      Type: STRING
      Provider name: backupId
      Description: Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
    • duration
      Type: STRING
      Provider name: duration
      Description: Output only. The duration of the backup completion.
    • start_time
      Type: TIMESTAMP
      Provider name: startTime
      Description: Output only. The time when the backup was started.
    • state
      Type: STRING
      Provider name: state
      Description: Output only. The current state of the backup.
      Possible values:
      • STATE_UNSPECIFIED - The state of the backup is unknown.
      • IN_PROGRESS - The backup is in progress.
      • SUCCEEDED - The backup completed.
      • FAILED - The backup failed.
  • next_scheduled_time
    Type: TIMESTAMP
    Provider name: nextScheduledTime
    Description: Output only. The time when the next backups execution is scheduled to start.
  • time_zone
    Type: STRING
    Provider name: timeZone
    Description: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.

state

Type: STRING
Provider name: state
Description: Output only. The current state of the metastore service.
Possible values:

  • STATE_UNSPECIFIED - The state of the metastore service is unknown.
  • CREATING - The metastore service is in the process of being created.
  • ACTIVE - The metastore service is running and ready to serve queries.
  • SUSPENDING - The metastore service is entering suspension. Its query-serving availability may cease unexpectedly.
  • SUSPENDED - The metastore service is suspended and unable to serve queries.
  • UPDATING - The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.
  • DELETING - The metastore service is undergoing deletion. It cannot be used.
  • ERROR - The metastore service has encountered an error and cannot be used. The metastore service should be deleted.
  • AUTOSCALING - The Dataproc Metastore service 2 is being scaled up or down.
  • MIGRATING - The metastore service is processing a managed migration.

state_message

Type: STRING
Provider name: stateMessage
Description: Output only. Additional information about the current state of the metastore service, if available.

tags

Type: UNORDERED_LIST_STRING

telemetry_config

Type: STRUCT
Provider name: telemetryConfig
Description: Optional. The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

  • log_format
    Type: STRING
    Provider name: logFormat
    Description: Optional. The output format of the Dataproc Metastore service’s logs.
    Possible values:
    • LOG_FORMAT_UNSPECIFIED - The LOG_FORMAT is not set.
    • LEGACY - Logging output uses the legacy textPayload format.
    • JSON - Logging output uses the jsonPayload format.

tier

Type: STRING
Provider name: tier
Description: Optional. The tier of the service.
Possible values:

  • TIER_UNSPECIFIED - The tier is not set.
  • DEVELOPER - The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept.
  • ENTERPRISE - The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads.

uid

Type: STRING
Provider name: uid
Description: Output only. The globally unique resource identifier of the metastore service.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time when the metastore service was last updated.

PREVIEWING: guacbot/translation-pipeline