Cloud Dataplex v1 API - Class Entity (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class Entity.

Represents tables and fileset metadata contained within a zone.

Inheritance

Object > Entity

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

Entity()

public Entity()

Entity(Entity)

public Entity(Entity other)
Parameter
NameDescription
otherEntity

Properties

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
TypeDescription
String

CatalogEntry

public string CatalogEntry { get; set; }

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

Property Value
TypeDescription
String

Compatibility

public Entity.Types.CompatibilityStatus Compatibility { get; set; }

Output only. Metadata stores that the entity is compatible with.

Property Value
TypeDescription
Entity.Types.CompatibilityStatus

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time when the entity was created.

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
String

Description

public string Description { get; set; }

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

Property Value
TypeDescription
String

DisplayName

public string DisplayName { get; set; }

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

Property Value
TypeDescription
String

EntityName

public EntityName EntityName { get; set; }

EntityName-typed view over the Name resource name property.

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
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. Must begin with a letter and consist of 256 or fewer characters.

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
Schema

System

public StorageSystem System { get; set; }

Required. Immutable. Identifies the storage system of the entity data.

Property Value
TypeDescription
StorageSystem

Type

public Entity.Types.Type Type { get; set; }

Required. Immutable. The type of entity.

Property Value
TypeDescription
Entity.Types.Type

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
TypeDescription
Timestamp