Google Cloud Dataproc Metastore V1 Client - Class Federation (0.4.1)

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
NameDescription
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 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.

↳ 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}`.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
string

setName

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

User-defined labels for the metastore federation.

Generated from protobuf field map<string, string> labels = 4;

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

User-defined labels for the metastore federation.

Generated from protobuf field map<string, string> labels = 4;

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getVersion

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

Generated from protobuf field string version = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
string

setVersion

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

Generated from protobuf field string version = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field map<int32, .google.cloud.metastore.v1.BackendMetastore> backend_metastores = 6;

Returns
TypeDescription
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.

Generated from protobuf field map<int32, .google.cloud.metastore.v1.BackendMetastore> backend_metastores = 6;

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEndpointUri

Output only. The federation endpoint.

Generated from protobuf field string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setEndpointUri

Output only. The federation endpoint.

Generated from protobuf field string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state of the federation.

Generated from protobuf field .google.cloud.metastore.v1.Federation.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

setState

Output only. The current state of the federation.

Generated from protobuf field .google.cloud.metastore.v1.Federation.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateMessage

Output only. Additional information about the current state of the metastore federation, if available.

Generated from protobuf field string state_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setStateMessage

Output only. Additional information about the current state of the metastore federation, if available.

Generated from protobuf field string state_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

Output only. The globally unique resource identifier of the metastore federation.

Generated from protobuf field string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setUid

Output only. The globally unique resource identifier of the metastore federation.

Generated from protobuf field string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this