Skip to main content

services

Overview

Nameservices
TypeResource
Idgoogle.metastore.services

Fields

NameDatatypeDescription
namestringImmutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
stateMessagestringOutput only. Additional information about the current state of the metastore service, if available.
encryptionConfigobjectEncryption settings for the service.
createTimestringOutput only. The time when the metastore service was created.
databaseTypestringImmutable. The database type that the Metastore service stores its data.
portintegerThe TCP port at which the metastore service is reached. Default: 9083.
artifactGcsUristringOutput only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
networkstringImmutable. 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}.
maintenanceWindowobjectMaintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.
networkConfigobjectNetwork configuration for the Dataproc Metastore service.Next available ID: 4
statestringOutput only. The current state of the metastore service.
uidstringOutput only. The globally unique resource identifier of the metastore service.
endpointUristringOutput only. The URI of the endpoint used to access the metastore service.
telemetryConfigobjectTelemetry Configuration for the Dataproc Metastore service.
updateTimestringOutput only. The time when the metastore service was last updated.
labelsobjectUser-defined labels for the metastore service.
tierstringThe tier of the service.
releaseChannelstringImmutable. The release channel of the service. If unspecified, defaults to STABLE.
metadataManagementActivityobjectThe metadata management activities of the metastore service.
hiveMetastoreConfigobjectSpecifies configuration information specific to running Hive metastore software as the metastore service.
scalingConfigobjectRepresents the scaling configuration of a metastore service.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, servicesIdGets the details of a single service.
listSELECTlocationsId, projectsIdLists services in a project and location.
createINSERTlocationsId, projectsIdCreates a metastore service in a project and location.
deleteDELETElocationsId, projectsId, servicesIdDeletes a single service.
_listEXEClocationsId, projectsIdLists services in a project and location.
alter_locationEXEClocationsId, projectsId, servicesIdAlter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
export_metadataEXEClocationsId, projectsId, servicesIdExports metadata from a service.
move_table_to_databaseEXEClocationsId, projectsId, servicesIdMove a table to another database.
patchEXEClocationsId, projectsId, servicesIdUpdates the parameters of a single service.
query_metadataEXEClocationsId, projectsId, servicesIdQuery DPMS metadata.
restoreEXEClocationsId, projectsId, servicesIdRestores a service from a backup.