Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class Federation.
Represents a federation of multiple backend metastores.
Generated from protobuf message google.cloud.metastore.v1.Federation
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
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
Output only. The time when the metastore federation was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the metastore federation was last updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
User-defined labels for the metastore federation. |
↳ version |
string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. |
↳ backend_metastores |
array|Google\Protobuf\Internal\MapField
A map from |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the metastore federation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the metastore federation was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the metastore federation was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
User-defined labels for the metastore federation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
User-defined labels for the metastore federation.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVersion
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 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setBackendMetastores
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpointUri
Output only. The federation endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setEndpointUri
Output only. The federation endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the federation.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the federation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateMessage
Output only. Additional information about the current state of the metastore federation, if available.
| Returns | |
|---|---|
| Type | Description |
string | |
setStateMessage
Output only. Additional information about the current state of the metastore federation, if available.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. The globally unique resource identifier of the metastore federation.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. The globally unique resource identifier of the metastore federation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |