Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132769111.5 KB
projects

Creates a metastore federation in a project and location.

post/v1/{+parent}/federations

Path parameters

parentstring required

Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.

Query parameters

federationIdstring

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

requestIdstring

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 (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Request body

updateTimestring google-datetime

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

stateMessagestring

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

versionstring

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

createTimestring google-datetime

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

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'ERROR'

Output only. The current state of the federation.

namestring

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

labelsobject

User-defined labels for the metastore federation.

backendMetastoresobject

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

uidstring

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

endpointUristring

Output only. The federation endpoint.

Response

Successful response