Console
    Contact Us Start free

    REST Resource: projects.locations.federations

    Resource: Federation

    Represents a federation of multiple backend metastores.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "version" 
 : 
 string 
 , 
 "backendMetastores" 
 : 
 { 
 integer 
 : 
 { 
 object (  BackendMetastore 
 
) 
 } 
 , 
 ... 
 } 
 , 
 "endpointUri" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "stateMessage" 
 : 
 string 
 , 
 "uid" 
 : 
 string 
 }
    Fields
    name

    string

    Immutable. The relative resource name of the federation, of the form: projects/{projectNumber}/locations/{locationId}/federations/{federationId}`.
    createTime

    string ( Timestamp format)

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

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    updateTime

    string ( Timestamp format)

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

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    labels

    map (key: string, value: string)

    User-defined labels for the metastore federation.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    version

    string

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

    map (key: integer, value: object ( BackendMetastore ))

    A map from BackendMetastore rank to BackendMetastore s from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastore s 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.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    endpointUri

    string

    Output only. The federation endpoint.
    state

    enum ( State )

    Output only. The current state of the federation.
    stateMessage

    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.

    BackendMetastore

    Represents a backend metastore for the federation.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "metastoreType" 
 : 
 enum (  MetastoreType 
 
) 
 }
    Fields
    name

    string

    The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below:

    • BigQuery
      • projects/{projectId}
    • Dataproc Metastore
      • projects/{projectId}/locations/{location}/services/{serviceId}
    metastoreType

    enum ( MetastoreType )

    The type of the backend metastore.

    MetastoreType

    The type of the backend metastore.

    Enums
    METASTORE_TYPE_UNSPECIFIED The metastore type is not set.
    BIGQUERY The backend metastore is BigQuery.
    DATAPROC_METASTORE The backend metastore is Dataproc Metastore.

    State

    The current state of the federation.

    Enums
    STATE_UNSPECIFIED The state of the metastore federation is unknown.
    CREATING The metastore federation is in the process of being created.
    ACTIVE The metastore federation is running and ready to serve queries.
    UPDATING The metastore federation is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.
    DELETING The metastore federation is undergoing deletion. It cannot be used.
    ERROR The metastore federation has encountered an error and cannot be used. The metastore federation should be deleted.

    Methods

    create

    		Creates a metastore federation in a project and location.

    delete

    		Deletes a single federation.

    get

    		Gets the details of a single federation.

    getIamPolicy

    		Gets the access control policy for a resource.

    list

    		Lists federations in a project and location.

    patch

    		Updates the fields of a federation.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: