Package com.google.cloud.dataplex.v1

Class Lake

  • All Implemented Interfaces:
    LakeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Lake
extends com.google.protobuf.GeneratedMessageV3
implements LakeOrBuilder
     A lake is a centralized repository for managing enterprise data across the
 organization distributed across many cloud projects, and stored in a variety
 of storage services such as Google Cloud Storage and BigQuery. The resources
 attached to a lake are referred to as managed resources. Data within these
 managed resources can be structured or unstructured. A lake provides data
 admins with tools to organize, secure and manage their data at scale, and
 provides data scientists and data engineers an integrated experience to
 easily search, discover, analyze and transform data and associated metadata.
    Protobuf type google.cloud.dataplex.v1.Lake
    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()
         Output only. The relative resource name of the lake, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface LakeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The relative resource name of the lake, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface LakeOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Optional. User friendly display name.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface LakeOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. User friendly display name.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface LakeOrBuilder
        Returns:
        The bytes for displayName.

      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the lake. This ID will
 be different if the lake is deleted and re-created with the same name.
        string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface LakeOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the lake. This ID will
 be different if the lake is deleted and re-created with the same name.
        string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface LakeOrBuilder
        Returns:
        The bytes for uid.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the lake was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface LakeOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time when the lake was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface LakeOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the lake was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface LakeOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the lake was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface LakeOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: LakeOrBuilder
         Optional. User-defined labels for the lake.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface LakeOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. User-defined labels for the lake.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface LakeOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. User-defined labels for the lake.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface LakeOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. User-defined labels for the lake.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface LakeOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. User-defined labels for the lake.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface LakeOrBuilder

      • getDescription

        public String getDescription()
         Optional. Description of the lake.
        string description = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface LakeOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Description of the lake.
        string description = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface LakeOrBuilder
        Returns:
        The bytes for description.

      • getStateValue

        public int getStateValue()
         Output only. Current state of the lake.
        .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface LakeOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public State getState()
         Output only. Current state of the lake.
        .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface LakeOrBuilder
        Returns:
        The state.

      • getServiceAccount

        public String getServiceAccount()
         Output only. Service account associated with this lake. This service
 account must be authorized to access or operate on resources managed by the
 lake.
        string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getServiceAccount in interface LakeOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public com.google.protobuf.ByteString getServiceAccountBytes()
         Output only. Service account associated with this lake. This service
 account must be authorized to access or operate on resources managed by the
 lake.
        string service_account = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getServiceAccountBytes in interface LakeOrBuilder
        Returns:
        The bytes for serviceAccount.

      • hasMetastore

        public boolean hasMetastore()
         Optional. Settings to manage lake and Dataproc Metastore service instance
 association.
        .google.cloud.dataplex.v1.Lake.Metastore metastore = 102 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasMetastore in interface LakeOrBuilder
        Returns:
        Whether the metastore field is set.

      • getMetastore

        public Lake.Metastore getMetastore()
         Optional. Settings to manage lake and Dataproc Metastore service instance
 association.
        .google.cloud.dataplex.v1.Lake.Metastore metastore = 102 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetastore in interface LakeOrBuilder
        Returns:
        The metastore.

      • getMetastoreOrBuilder

        public Lake.MetastoreOrBuilder getMetastoreOrBuilder()
         Optional. Settings to manage lake and Dataproc Metastore service instance
 association.
        .google.cloud.dataplex.v1.Lake.Metastore metastore = 102 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetastoreOrBuilder in interface LakeOrBuilder

      • hasAssetStatus

        public boolean hasAssetStatus()
         Output only. Aggregated status of the underlying assets of the lake.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 103 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAssetStatus in interface LakeOrBuilder
        Returns:
        Whether the assetStatus field is set.

      • getAssetStatus

        public AssetStatus getAssetStatus()
         Output only. Aggregated status of the underlying assets of the lake.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 103 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAssetStatus in interface LakeOrBuilder
        Returns:
        The assetStatus.

      • getAssetStatusOrBuilder

        public AssetStatusOrBuilder getAssetStatusOrBuilder()
         Output only. Aggregated status of the underlying assets of the lake.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 103 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAssetStatusOrBuilder in interface LakeOrBuilder

      • hasMetastoreStatus

        public boolean hasMetastoreStatus()
         Output only. Metastore status of the lake.
        .google.cloud.dataplex.v1.Lake.MetastoreStatus metastore_status = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetastoreStatus in interface LakeOrBuilder
        Returns:
        Whether the metastoreStatus field is set.

      • getMetastoreStatus

        public Lake.MetastoreStatus getMetastoreStatus()
         Output only. Metastore status of the lake.
        .google.cloud.dataplex.v1.Lake.MetastoreStatus metastore_status = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetastoreStatus in interface LakeOrBuilder
        Returns:
        The metastoreStatus.

      • 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 Lake parseFrom​(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Lake getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Lake> 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 Lake getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder