Skip to main content

federations

Overview

Namefederations
TypeResource
Idgoogle.metastore.federations

Fields

NameDatatypeDescription
namestringImmutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
uidstringOutput only. The globally unique resource identifier of the metastore federation.
labelsobjectUser-defined labels for the metastore federation.
versionstringImmutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
endpointUristringOutput only. The federation endpoint.
backendMetastoresobjectA 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.
statestringOutput only. The current state of the federation.
stateMessagestringOutput only. Additional information about the current state of the metastore federation, if available.
createTimestringOutput only. The time when the metastore federation was created.
updateTimestringOutput only. The time when the metastore federation was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTfederationsId, locationsId, projectsIdGets the details of a single federation.
listSELECTlocationsId, projectsIdLists federations in a project and location.
createINSERTlocationsId, projectsIdCreates a metastore federation in a project and location.
deleteDELETEfederationsId, locationsId, projectsIdDeletes a single federation.
_listEXEClocationsId, projectsIdLists federations in a project and location.
patchEXECfederationsId, locationsId, projectsIdUpdates the fields of a federation.