Package com.google.cloud.dataplex.v1

Class Entity

  • All Implemented Interfaces:
    EntityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Entity
extends com.google.protobuf.GeneratedMessageV3
implements EntityOrBuilder
     Represents tables and fileset metadata contained within a zone.
    Protobuf type google.cloud.dataplex.v1.Entity
    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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface EntityOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • getDisplayName

        public String getDisplayName()
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface EntityOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface EntityOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface EntityOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface EntityOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • getId

        public String getId()
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getId in interface EntityOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getIdBytes in interface EntityOrBuilder
        Returns:
        The bytes for id.

      • getEtag

        public String getEtag()
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface EntityOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface EntityOrBuilder
        Returns:
        The bytes for etag.

      • getTypeValue

        public int getTypeValue()
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface EntityOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public Entity.Type getType()
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface EntityOrBuilder
        Returns:
        The type.

      • getAsset

        public String getAsset()
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAsset in interface EntityOrBuilder
        Returns:
        The asset.

      • getAssetBytes

        public com.google.protobuf.ByteString getAssetBytes()
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAssetBytes in interface EntityOrBuilder
        Returns:
        The bytes for asset.

      • getDataPath

        public String getDataPath()
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataPath in interface EntityOrBuilder
        Returns:
        The dataPath.

      • getDataPathBytes

        public com.google.protobuf.ByteString getDataPathBytes()
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataPathBytes in interface EntityOrBuilder
        Returns:
        The bytes for dataPath.

      • getDataPathPattern

        public String getDataPathPattern()
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataPathPattern in interface EntityOrBuilder
        Returns:
        The dataPathPattern.

      • getDataPathPatternBytes

        public com.google.protobuf.ByteString getDataPathPatternBytes()
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataPathPatternBytes in interface EntityOrBuilder
        Returns:
        The bytes for dataPathPattern.

      • getCatalogEntry

        public String getCatalogEntry()
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCatalogEntry in interface EntityOrBuilder
        Returns:
        The catalogEntry.

      • getCatalogEntryBytes

        public com.google.protobuf.ByteString getCatalogEntryBytes()
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCatalogEntryBytes in interface EntityOrBuilder
        Returns:
        The bytes for catalogEntry.

      • getSystemValue

        public int getSystemValue()
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSystemValue in interface EntityOrBuilder
        Returns:
        The enum numeric value on the wire for system.

      • getSystem

        public StorageSystem getSystem()
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSystem in interface EntityOrBuilder
        Returns:
        The system.

      • hasFormat

        public boolean hasFormat()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasFormat in interface EntityOrBuilder
        Returns:
        Whether the format field is set.

      • getFormat

        public StorageFormat getFormat()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFormat in interface EntityOrBuilder
        Returns:
        The format.

      • getFormatOrBuilder

        public StorageFormatOrBuilder getFormatOrBuilder()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFormatOrBuilder in interface EntityOrBuilder

      • hasCompatibility

        public boolean hasCompatibility()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCompatibility in interface EntityOrBuilder
        Returns:
        Whether the compatibility field is set.

      • getCompatibility

        public Entity.CompatibilityStatus getCompatibility()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompatibility in interface EntityOrBuilder
        Returns:
        The compatibility.

      • hasAccess

        public boolean hasAccess()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAccess in interface EntityOrBuilder
        Returns:
        Whether the access field is set.

      • getAccess

        public StorageAccess getAccess()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAccess in interface EntityOrBuilder
        Returns:
        The access.

      • getAccessOrBuilder

        public StorageAccessOrBuilder getAccessOrBuilder()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAccessOrBuilder in interface EntityOrBuilder

      • getUid

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

      • getUidBytes

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

      • hasSchema

        public boolean hasSchema()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasSchema in interface EntityOrBuilder
        Returns:
        Whether the schema field is set.

      • getSchema

        public Schema getSchema()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSchema in interface EntityOrBuilder
        Returns:
        The schema.

      • getSchemaOrBuilder

        public SchemaOrBuilder getSchemaOrBuilder()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSchemaOrBuilder in interface EntityOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Entity getDefaultInstance()

      • parser

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

      • getParserForType

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