Package com.google.cloud.metastore.v1beta

Class Federation

  • All Implemented Interfaces:
    FederationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Federation
extends com.google.protobuf.GeneratedMessageV3
implements FederationOrBuilder
     Represents a federation of multiple backend metastores.
    Protobuf type google.cloud.metastore.v1beta.Federation
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface FederationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface FederationOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        hasCreateTime in interface FederationOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the metastore federation was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface FederationOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the metastore federation was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface FederationOrBuilder

      • 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];
        Specified by:
        hasUpdateTime in interface FederationOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getUpdateTime in interface FederationOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateTimeOrBuilder in interface FederationOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         User-defined labels for the metastore federation.
        map<string, string> labels = 4;
        Specified by:
        containsLabels in interface FederationOrBuilder

      • 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];
        Specified by:
        getVersion in interface FederationOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public com.google.protobuf.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];
        Specified by:
        getVersionBytes in interface FederationOrBuilder
        Returns:
        The bytes for version.

      • getBackendMetastoresCount

        public int getBackendMetastoresCount()
        Description copied from interface: FederationOrBuilder
         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.
        map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;
        Specified by:
        getBackendMetastoresCount in interface FederationOrBuilder

      • containsBackendMetastores

        public boolean containsBackendMetastores​(int key)
         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.
        map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;
        Specified by:
        containsBackendMetastores in interface FederationOrBuilder

      • getBackendMetastoresMap

        public Map<Integer,​BackendMetastore> getBackendMetastoresMap()
         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.
        map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;
        Specified by:
        getBackendMetastoresMap in interface FederationOrBuilder

      • getBackendMetastoresOrDefault

        public BackendMetastore getBackendMetastoresOrDefault​(int key,
                                                      BackendMetastore defaultValue)
         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.
        map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;
        Specified by:
        getBackendMetastoresOrDefault in interface FederationOrBuilder

      • getBackendMetastoresOrThrow

        public BackendMetastore getBackendMetastoresOrThrow​(int key)
         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.
        map<int32, .google.cloud.metastore.v1beta.BackendMetastore> backend_metastores = 6;
        Specified by:
        getBackendMetastoresOrThrow in interface FederationOrBuilder

      • getEndpointUri

        public String getEndpointUri()
         Output only. The federation endpoint.
        string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointUri in interface FederationOrBuilder
        Returns:
        The endpointUri.

      • getEndpointUriBytes

        public com.google.protobuf.ByteString getEndpointUriBytes()
         Output only. The federation endpoint.
        string endpoint_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointUriBytes in interface FederationOrBuilder
        Returns:
        The bytes for endpointUri.

      • 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];
        Specified by:
        getStateValue in interface FederationOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface FederationOrBuilder
        Returns:
        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];
        Specified by:
        getStateMessage in interface FederationOrBuilder
        Returns:
        The stateMessage.

      • getStateMessageBytes

        public com.google.protobuf.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];
        Specified by:
        getStateMessageBytes in interface FederationOrBuilder
        Returns:
        The bytes for stateMessage.

      • getUid

        public String getUid()
         Output only. The globally unique resource identifier of the metastore
 federation.
        string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface FederationOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. The globally unique resource identifier of the metastore
 federation.
        string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface FederationOrBuilder
        Returns:
        The bytes for uid.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Federation parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Federation parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Federation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Federation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Federation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Federation getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Federation> parser()

      • getParserForType

        public com.google.protobuf.Parser<Federation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Federation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder