Class Entity (1.43.0) 

public final class Entity extends GeneratedMessageV3 implements EntityOrBuilder

Represents tables and fileset metadata contained within a zone.

Protobuf type google.cloud.dataplex.v1.Entity

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Entity

Implements

EntityOrBuilder

Static Fields

ACCESS_FIELD_NUMBER

public static final int ACCESS_FIELD_NUMBER
Field Value
Type Description
int

ASSET_FIELD_NUMBER

public static final int ASSET_FIELD_NUMBER
Field Value
Type Description
int

CATALOG_ENTRY_FIELD_NUMBER

public static final int CATALOG_ENTRY_FIELD_NUMBER
Field Value
Type Description
int

COMPATIBILITY_FIELD_NUMBER

public static final int COMPATIBILITY_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_PATH_FIELD_NUMBER

public static final int DATA_PATH_FIELD_NUMBER
Field Value
Type Description
int

DATA_PATH_PATTERN_FIELD_NUMBER

public static final int DATA_PATH_PATTERN_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_FIELD_NUMBER

public static final int SYSTEM_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Entity getDefaultInstance()
Returns
Type Description
Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Entity.Builder newBuilder()
Returns
Type Description
Entity.Builder

newBuilder(Entity prototype)

public static Entity.Builder newBuilder(Entity prototype)
Parameter
Name Description
prototype Entity
Returns
Type Description
Entity.Builder

parseDelimitedFrom(InputStream input)

public static Entity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Entity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Entity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Entity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Entity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Entity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Entity> parser()
Returns
Type Description
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
StorageAccess

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

Returns
Type Description
StorageAccessOrBuilder

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

Returns
Type Description
String

The asset.

getAssetBytes()

public 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
Type Description
ByteString

The bytes for asset.

getCatalogEntry()

public String getCatalogEntry()

Output only. The name of the associated Data Catalog entry.

string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The catalogEntry.

getCatalogEntryBytes()

public ByteString getCatalogEntryBytes()

Output only. The name of the associated Data Catalog entry.

string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for catalogEntry.

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

Returns
Type Description
Entity.CompatibilityStatus

The compatibility.

getCompatibilityOrBuilder()

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

Returns
Type Description
Entity.CompatibilityStatusOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the entity was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the entity was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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

Returns
Type Description
String

The dataPath.

getDataPathBytes()

public 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
Type Description
ByteString

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

Returns
Type Description
String

The dataPathPattern.

getDataPathPatternBytes()

public 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
Type Description
ByteString

The bytes for dataPathPattern.

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()
Returns
Type Description
Entity

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public 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
Type Description
ByteString

The bytes for description.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

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

Returns
Type Description
String

The etag.

getEtagBytes()

public 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
Type Description
ByteString

The bytes for etag.

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

Returns
Type Description
StorageFormat

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

Returns
Type Description
StorageFormatOrBuilder

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

Returns
Type Description
String

The id.

getIdBytes()

public 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
Type Description
ByteString

The bytes for id.

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) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Entity> getParserForType()
Returns
Type Description
Parser<Entity>
Overrides

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

Returns
Type Description
Schema

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

Returns
Type Description
SchemaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
StorageSystem

The system.

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

Returns
Type Description
int

The enum numeric value on the wire for system.

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

Returns
Type Description
Entity.Type

The type.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

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

Returns
Type Description
String

The uid.

getUidBytes()

public 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
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public 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
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the entity was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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

Returns
Type Description
boolean

Whether the access field is set.

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

Returns
Type Description
boolean

Whether the compatibility field is set.

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

Returns
Type Description
boolean

Whether the createTime field is set.

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

Returns
Type Description
boolean

Whether the format field is set.

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

Returns
Type Description
boolean

Whether the schema field is set.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Entity.Builder newBuilderForType()
Returns
Type Description
Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Entity.Builder toBuilder()
Returns
Type Description
Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException