A map fromBackendMetastorerank toBackendMetastores from which the federation service serves metadata at query time. The map key represents the order in whichBackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. ABackendMetastorewith a lower number will be evaluated before aBackendMetastorewith a higher number.
↳ endpoint_uri
string
Output only. The federation endpoint.
↳ state
int
Output only. The current state of the federation.
↳ state_message
string
Output only. Additional information about the current state of the metastore federation, if available.
↳ uid
string
Output only. The globally unique resource identifier of the metastore federation.
getName
Immutable. The relative resource name of the federation, of the
form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Returns
Type
Description
string
setName
Immutable. The relative resource name of the federation, of the
form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCreateTime
Output only. The time when the metastore federation was created.
Immutable. The Apache Hive metastore version of the federation. All backend
metastore versions must be compatible with the federation version.
Returns
Type
Description
string
setVersion
Immutable. The Apache Hive metastore version of the federation. All backend
metastore versions must be compatible with the federation version.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBackendMetastores
A map fromBackendMetastorerank toBackendMetastores from which the
federation service serves metadata at query time. The map key represents
the order in whichBackendMetastores should be evaluated to resolve
database names at query time and should be greater than or equal to zero. ABackendMetastorewith a lower number will be evaluated before aBackendMetastorewith a higher number.
A map fromBackendMetastorerank toBackendMetastores from which the
federation service serves metadata at query time. The map key represents
the order in whichBackendMetastores should be evaluated to resolve
database names at query time and should be greater than or equal to zero. ABackendMetastorewith a lower number will be evaluated before aBackendMetastorewith a higher number.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc Metastore V1alpha Client - Class Federation (1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/php/docs/reference/cloud-dataproc-metastore/latest/V1alpha.Federation)\n- [1.1.0](/php/docs/reference/cloud-dataproc-metastore/1.1.0/V1alpha.Federation)\n- [1.0.4](/php/docs/reference/cloud-dataproc-metastore/1.0.4/V1alpha.Federation)\n- [0.11.5](/php/docs/reference/cloud-dataproc-metastore/0.11.5/V1alpha.Federation)\n- [0.10.2](/php/docs/reference/cloud-dataproc-metastore/0.10.2/V1alpha.Federation)\n- [0.9.0](/php/docs/reference/cloud-dataproc-metastore/0.9.0/V1alpha.Federation)\n- [0.8.1](/php/docs/reference/cloud-dataproc-metastore/0.8.1/V1alpha.Federation)\n- [0.7.0](/php/docs/reference/cloud-dataproc-metastore/0.7.0/V1alpha.Federation)\n- [0.6.1](/php/docs/reference/cloud-dataproc-metastore/0.6.1/V1alpha.Federation)\n- [0.5.1](/php/docs/reference/cloud-dataproc-metastore/0.5.1/V1alpha.Federation)\n- [0.4.1](/php/docs/reference/cloud-dataproc-metastore/0.4.1/V1alpha.Federation) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Dataproc Metastore V1alpha Client class Federation.\n\nRepresents a federation of multiple backend metastores.\n\nGenerated from protobuf message `google.cloud.metastore.v1alpha.Federation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Metastore \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nImmutable. The relative resource name of the federation, of the\nform:\nprojects/{project_number}/locations/{location_id}/federations/{federation_id}\\`.\n\n### setName\n\nImmutable. The relative resource name of the federation, of the\nform:\nprojects/{project_number}/locations/{location_id}/federations/{federation_id}\\`.\n\n### getCreateTime\n\nOutput only. The time when the metastore federation was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the metastore federation was created.\n\n### getUpdateTime\n\nOutput only. The time when the metastore federation was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The time when the metastore federation was last updated.\n\n### getLabels\n\nUser-defined labels for the metastore federation.\n\n### setLabels\n\nUser-defined labels for the metastore federation.\n\n### getVersion\n\nImmutable. The Apache Hive metastore version of the federation. All backend\nmetastore versions must be compatible with the federation version.\n\n### setVersion\n\nImmutable. The Apache Hive metastore version of the federation. All backend\nmetastore versions must be compatible with the federation version.\n\n### getBackendMetastores\n\nA map from `BackendMetastore` rank to `BackendMetastore`s from which the\nfederation service serves metadata at query time. The map key represents\nthe order in which `BackendMetastore`s should be evaluated to resolve\ndatabase names at query time and should be greater than or equal to zero. A\n`BackendMetastore` with a lower number will be evaluated before a\n`BackendMetastore` with a higher number.\n\n### setBackendMetastores\n\nA map from `BackendMetastore` rank to `BackendMetastore`s from which the\nfederation service serves metadata at query time. The map key represents\nthe order in which `BackendMetastore`s should be evaluated to resolve\ndatabase names at query time and should be greater than or equal to zero. A\n`BackendMetastore` with a lower number will be evaluated before a\n`BackendMetastore` with a higher number.\n\n### getEndpointUri\n\nOutput only. The federation endpoint.\n\n### setEndpointUri\n\nOutput only. The federation endpoint.\n\n### getState\n\nOutput only. The current state of the federation.\n\n### setState\n\nOutput only. The current state of the federation.\n\n### getStateMessage\n\nOutput only. Additional information about the current state of the\nmetastore federation, if available.\n\n### setStateMessage\n\nOutput only. Additional information about the current state of the\nmetastore federation, if available.\n\n### getUid\n\nOutput only. The globally unique resource identifier of the metastore\nfederation.\n\n### setUid\n\nOutput only. The globally unique resource identifier of the metastore\nfederation."]]
