Class Federation (1.10.0)

Federation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a federation of multiple backend metastores.

Attributes

Name	Description
`name`	`str` Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time when the metastore federation was created.
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time when the metastore federation was last updated.
`labels`	`MutableMapping[str, str]` User-defined labels for the metastore federation.
`version`	`str` Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
`backend_metastores`	`MutableMapping[int, google.cloud.metastore_v1alpha.types.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.
`endpoint_uri`	`str` Output only. The federation endpoint.
`state`	`google.cloud.metastore_v1alpha.types.Federation.State` Output only. The current state of the federation.
`state_message`	`str` Output only. Additional information about the current state of the metastore federation, if available.
`uid`	`str` Output only. The globally unique resource identifier of the metastore federation.

Classes

BackendMetastoresEntry

BackendMetastoresEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

State

State(value)

The current state of the federation.

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