Entity(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents tables and fileset metadata contained within a zone.
Attributes | |
|---|---|
| Name | Description |
name |
str
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}.
|
display_name |
str
Optional. Display name must be shorter than or equal to 256 characters. |
description |
str
Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the entity was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the entity was last updated. |
id |
str
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. |
etag |
str
Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests. |
type_ |
google.cloud.dataplex_v1.types.Entity.Type
Required. Immutable. The type of entity. |
asset |
str
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. |
data_path |
str
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.
|
data_path_pattern |
str
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.
|
catalog_entry |
str
Output only. The name of the associated Data Catalog entry. |
system |
google.cloud.dataplex_v1.types.StorageSystem
Required. Immutable. Identifies the storage system of the entity data. |
format_ |
google.cloud.dataplex_v1.types.StorageFormat
Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery. |
compatibility |
google.cloud.dataplex_v1.types.Entity.CompatibilityStatus
Output only. Metadata stores that the entity is compatible with. |
access |
google.cloud.dataplex_v1.types.StorageAccess
Output only. Identifies the access mechanism to the entity. Not user settable. |
uid |
str
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. |
schema |
google.cloud.dataplex_v1.types.Schema
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.
|
Classes
CompatibilityStatus
CompatibilityStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)Provides compatibility information for various metadata stores.
Type
Type(value)The type of entity.
Values: TYPE_UNSPECIFIED (0): Type unspecified. TABLE (1): Structured and semi-structured data. FILESET (2): Unstructured data.