Sign in

v1

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

Updates the fields of a federation.

patch/v1/{+name}

Path parameters

namestring required

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

Query parameters

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.

updateMaskstring

Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

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