Class Federation (2.13.0) 

public final class Federation extends GeneratedMessageV3 implements FederationOrBuilder

Represents a federation of multiple backend metastores.

Protobuf type google.cloud.metastore.v1beta.Federation

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Federation

Implements

FederationOrBuilder

Static Fields

BACKEND_METASTORES_FIELD_NUMBER

public static final int BACKEND_METASTORES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_URI_FIELD_NUMBER

public static final int ENDPOINT_URI_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Federation getDefaultInstance()
Returns
Type Description
Federation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Federation.Builder newBuilder()
Returns
Type Description
Federation.Builder

newBuilder(Federation prototype)

public static Federation.Builder newBuilder(Federation prototype)
Parameter
Name Description
prototype Federation
Returns
Type Description
Federation.Builder

parseDelimitedFrom(InputStream input)

public static Federation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Federation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Federation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Federation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Federation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Federation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Federation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Federation> parser()
Returns
Type Description
Parser<Federation>

Methods

containsBackendMetastores(int key)

public boolean containsBackendMetastores(int key)

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.

map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;

Parameter
Name Description
key int
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackendMetastores()

public Map<Integer,BackendMetastore> getBackendMetastores()

Use #getBackendMetastoresMap() instead.

Returns
Type Description
Map<java.lang.Integer,BackendMetastore>

getBackendMetastoresCount()

public int getBackendMetastoresCount()

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.

map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;

Returns
Type Description
int

getBackendMetastoresMap()

public Map<Integer,BackendMetastore> getBackendMetastoresMap()

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.

map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;

Returns
Type Description
Map<java.lang.Integer,BackendMetastore>

getBackendMetastoresOrDefault(int key, BackendMetastore defaultValue)

public BackendMetastore getBackendMetastoresOrDefault(int key, BackendMetastore defaultValue)

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.

map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;

Parameters
Name Description
key int
defaultValue BackendMetastore
Returns
Type Description
BackendMetastore

getBackendMetastoresOrThrow(int key)

public BackendMetastore getBackendMetastoresOrThrow(int key)

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.

map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;

Parameter
Name Description
key int
Returns
Type Description
BackendMetastore

getCreateTime()

public Timestamp getCreateTime()

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

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Federation getDefaultInstanceForType()
Returns
Type Description
Federation

getEndpointUri()

public String getEndpointUri()

Output only. The federation endpoint.

string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The endpointUri.

getEndpointUriBytes()

public ByteString getEndpointUriBytes()

Output only. The federation endpoint.

string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for endpointUri.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Federation> getParserForType()
Returns
Type Description
Parser<Federation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Federation.State getState()

Output only. The current state of the federation.

.google.cloud.metastore.v1beta.Federation.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Federation.State

The state.

getStateMessage()

public String getStateMessage()

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

string state_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

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

string state_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

Output only. The current state of the federation.

.google.cloud.metastore.v1beta.Federation.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

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

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

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

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getVersion()

public String getVersion()

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

string version = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The version.

getVersionBytes()

public ByteString getVersionBytes()

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

string version = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for version.

hasCreateTime()

public boolean hasCreateTime()

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

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Federation.Builder newBuilderForType()
Returns
Type Description
Federation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Federation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Federation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Federation.Builder toBuilder()
Returns
Type Description
Federation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException