public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Dataplex v1 API class Entity.
Represents tables and fileset metadata contained within a zone.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
Entity()
public Entity()Entity(Entity)
public Entity(Entity other)| Parameter | |
|---|---|
| Name | Description |
other | Entity |
Properties
Access
public StorageAccess Access { get; set; }Output only. Identifies the access mechanism to the entity. Not user settable.
| Property Value | |
|---|---|
| Type | Description |
StorageAccess | |
Asset
public string Asset { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
CatalogEntry
public string CatalogEntry { get; set; }Output only. The name of the associated Data Catalog entry.
| Property Value | |
|---|---|
| Type | Description |
string | |
Compatibility
public Entity.Types.CompatibilityStatus Compatibility { get; set; }Output only. Metadata stores that the entity is compatible with.
| Property Value | |
|---|---|
| Type | Description |
EntityTypesCompatibilityStatus | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time when the entity was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
DataPath
public string DataPath { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
DataPathPattern
public string DataPathPattern { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Description
public string Description { get; set; }Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
DisplayName
public string DisplayName { get; set; }Optional. Display name must be shorter than or equal to 256 characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
EntityName
public EntityName EntityName { get; set; }EntityName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
EntityName | |
Etag
public string Etag { get; set; }Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.
| Property Value | |
|---|---|
| Type | Description |
string | |
Format
public StorageFormat Format { get; set; }Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
| Property Value | |
|---|---|
| Type | Description |
StorageFormat | |
Id
public string Id { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Name
public string Name { get; set; }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}.
| Property Value | |
|---|---|
| Type | Description |
string | |
Schema
public Schema Schema { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Schema | |
System
public StorageSystem System { get; set; }Required. Immutable. Identifies the storage system of the entity data.
| Property Value | |
|---|---|
| Type | Description |
StorageSystem | |
Type
public Entity.Types.Type Type { get; set; }Required. Immutable. The type of entity.
| Property Value | |
|---|---|
| Type | Description |
EntityTypesType | |
Uid
public string Uid { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time when the entity was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |