Package com.google.cloud.dataplex.v1

Interface EntityOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Entity, Entity.Builder
@Generated public interface EntityOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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) = { ... }
      Returns:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getDescription

      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];
      Returns:
      The description.

    • getDescriptionBytes

      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];
      Returns:
      The bytes for description.

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

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

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • getId

      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];
      Returns:
      The id.

    • getIdBytes

      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];
      Returns:
      The bytes for id.

    • getEtag

      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];
      Returns:
      The etag.

    • getEtagBytes

      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];
      Returns:
      The bytes for etag.

    • getTypeValue

      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];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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];
      Returns:
      The type.

    • getAsset

      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];
      Returns:
      The asset.

    • getAssetBytes

      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];
      Returns:
      The bytes for asset.

    • getDataPath

      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];
      Returns:
      The dataPath.

    • getDataPathBytes

      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];
      Returns:
      The bytes for dataPath.

    • getDataPathPattern

      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];
      Returns:
      The dataPathPattern.

    • getDataPathPatternBytes

      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];
      Returns:
      The bytes for dataPathPattern.

    • getCatalogEntry

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

    • getCatalogEntryBytes

      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];
      Returns:
      The bytes for catalogEntry.

    • getSystemValue

      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];
      Returns:
      The enum numeric value on the wire for system.

    • getSystem

      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];
      Returns:
      The system.

    • hasFormat

      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];
      Returns:
      Whether the format field is set.

    • getFormat

      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];
      Returns:
      The format.

    • getFormatOrBuilder

      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];

    • hasCompatibility

      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];
      Returns:
      Whether the compatibility field is set.

    • getCompatibility

      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];
      Returns:
      The compatibility.

    • getCompatibilityOrBuilder

      Entity.CompatibilityStatusOrBuilder getCompatibilityOrBuilder()
       Output only. Metadata stores that the entity is compatible with.
      .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasAccess

      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];
      Returns:
      Whether the access field is set.

    • getAccess

      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];
      Returns:
      The access.

    • getAccessOrBuilder

      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];

    • getUid

      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];
      Returns:
      The uid.

    • getUidBytes

      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];
      Returns:
      The bytes for uid.

    • hasSchema

      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];
      Returns:
      Whether the schema field is set.

    • getSchema

      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];
      Returns:
      The schema.

    • getSchemaOrBuilder

      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];