Class Federation (2.21.0)

public final class Federation extends GeneratedMessageV3 implements FederationOrBuilder

Represents a federation of multiple backend metastores.

Protobuf type google.cloud.metastore.v1alpha.Federation

Implements

FederationOrBuilder

Static Fields

BACKEND_METASTORES_FIELD_NUMBER

public static final int BACKEND_METASTORES_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINT_URI_FIELD_NUMBER

public static final int ENDPOINT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Federation getDefaultInstance()
Returns
TypeDescription
Federation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Federation.Builder newBuilder()
Returns
TypeDescription
Federation.Builder

newBuilder(Federation prototype)

public static Federation.Builder newBuilder(Federation prototype)
Parameter
NameDescription
prototypeFederation
Returns
TypeDescription
Federation.Builder

parseDelimitedFrom(InputStream input)

public static Federation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Federation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Federation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Federation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Federation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Federation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Federation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Federation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Federation> parser()
Returns
TypeDescription
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.v1alpha.BackendMetastore> backend_metastores = 6;

Parameter
NameDescription
keyint
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackendMetastores()

public Map<Integer,BackendMetastore> getBackendMetastores()
Returns
TypeDescription
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.v1alpha.BackendMetastore> backend_metastores = 6;

Returns
TypeDescription
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.v1alpha.BackendMetastore> backend_metastores = 6;

Returns
TypeDescription
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.v1alpha.BackendMetastore> backend_metastores = 6;

Parameters
NameDescription
keyint
defaultValueBackendMetastore
Returns
TypeDescription
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.v1alpha.BackendMetastore> backend_metastores = 6;

Parameter
NameDescription
keyint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Federation getDefaultInstanceForType()
Returns
TypeDescription
Federation

getEndpointUri()

public String getEndpointUri()

Output only. The federation endpoint.

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

Returns
TypeDescription
String

The endpointUri.

getEndpointUriBytes()

public ByteString getEndpointUriBytes()

Output only. The federation endpoint.

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

Returns
TypeDescription
ByteString

The bytes for endpointUri.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined labels for the metastore federation.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Federation> getParserForType()
Returns
TypeDescription
Parser<Federation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Federation.State getState()

Output only. The current state of the federation.

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

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

The bytes for stateMessage.

getStateValue()

public int getStateValue()

Output only. The current state of the federation.

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

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

The bytes for uid.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Federation.Builder newBuilderForType()
Returns
TypeDescription
Federation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Federation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Federation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Federation.Builder toBuilder()
Returns
TypeDescription
Federation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException