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.
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.
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.
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.
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}.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eGoogle.Cloud.Dataplex.V1.Entity\u003c/code\u003e class is 3.6.0, and the documentation includes versions ranging from 1.0.0 to 3.6.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEntity\u003c/code\u003e class represents metadata for tables and filesets within a zone, implementing interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eEntity\u003c/code\u003e objects have properties like \u003ccode\u003eAccess\u003c/code\u003e, \u003ccode\u003eAsset\u003c/code\u003e, \u003ccode\u003eCatalogEntry\u003c/code\u003e, \u003ccode\u003eCompatibility\u003c/code\u003e, \u003ccode\u003eCreateTime\u003c/code\u003e, and \u003ccode\u003eDataPath\u003c/code\u003e, that provides information about the entity's storage, associated resources, and compatibility.\u003c/p\u003e\n"],["\u003cp\u003eKey properties for defining an entity include \u003ccode\u003eId\u003c/code\u003e, \u003ccode\u003eDataPath\u003c/code\u003e, \u003ccode\u003eSystem\u003c/code\u003e, and \u003ccode\u003eType\u003c/code\u003e, while other properties such as \u003ccode\u003eEtag\u003c/code\u003e, \u003ccode\u003eDescription\u003c/code\u003e, and \u003ccode\u003eDisplayName\u003c/code\u003e are optional for additional details.\u003c/p\u003e\n"],["\u003cp\u003eThe class contains methods and properites to access and describe the data, including a user-provided id, storage path, format, and structure through the \u003ccode\u003eId\u003c/code\u003e, \u003ccode\u003eDataPath\u003c/code\u003e, \u003ccode\u003eFormat\u003c/code\u003e, and \u003ccode\u003eSchema\u003c/code\u003e properties.\u003c/p\u003e\n"]]],[],null,["# Cloud Dataplex v1 API - Class Entity (3.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.Entity)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.8.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.7.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.6.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.5.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.4.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.3.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.2.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.1.0/Google.Cloud.Dataplex.V1.Entity)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.0.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.15.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.14.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.13.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.12.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.11.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.10.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.9.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.8.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.7.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.6.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.5.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.4.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.3.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.2.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.1.0/Google.Cloud.Dataplex.V1.Entity)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.0.0/Google.Cloud.Dataplex.V1.Entity)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/1.0.0/Google.Cloud.Dataplex.V1.Entity) \n\n public sealed class Entity : IMessage\u003cEntity\u003e, IEquatable\u003cEntity\u003e, IDeepCloneable\u003cEntity\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Dataplex v1 API class Entity.\n\nRepresents tables and fileset metadata contained within a zone. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Entity \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Entity](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.Entity), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Entity](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.Entity), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Entity](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.Entity), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataplex.V1](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataplex.V1.dll\n\nConstructors\n------------\n\n### Entity()\n\n public Entity()\n\n### Entity(Entity)\n\n public Entity(Entity other)\n\nProperties\n----------\n\n### Access\n\n public StorageAccess Access { get; set; }\n\nOutput only. Identifies the access mechanism to the entity. Not user\nsettable.\n\n### Asset\n\n public string Asset { get; set; }\n\nRequired. Immutable. The ID of the asset associated with the storage\nlocation containing the entity data. The entity must be with in the same\nzone with the asset.\n\n### CatalogEntry\n\n public string CatalogEntry { get; set; }\n\nOutput only. The name of the associated Data Catalog entry.\n\n### Compatibility\n\n public Entity.Types.CompatibilityStatus Compatibility { get; set; }\n\nOutput only. Metadata stores that the entity is compatible with.\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. The time when the entity was created.\n\n### DataPath\n\n public string DataPath { get; set; }\n\nRequired. Immutable. The storage path of the entity data.\nFor Cloud Storage data, this is the fully-qualified path to the entity,\nsuch as `gs://bucket/path/to/data`. For BigQuery data, this is the name of\nthe table resource, such as\n`projects/project_id/datasets/dataset_id/tables/table_id`.\n\n### DataPathPattern\n\n public string DataPathPattern { get; set; }\n\nOptional. The set of items within the data path constituting the data in\nthe entity, represented as a glob path. Example:\n`gs://bucket/path/to/data/**/*.csv`.\n\n### Description\n\n public string Description { get; set; }\n\nOptional. User friendly longer description text. Must be shorter than or\nequal to 1024 characters.\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nOptional. Display name must be shorter than or equal to 256 characters.\n\n### EntityName\n\n public EntityName EntityName { get; set; }\n\n[EntityName](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.EntityName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.Entity#Google_Cloud_Dataplex_V1_Entity_Name) resource name property.\n\n### Etag\n\n public string Etag { get; set; }\n\nOptional. The etag associated with the entity, which can be retrieved with\na \\[GetEntity\\]\\[\\] request. Required for update and delete requests.\n\n### Format\n\n public StorageFormat Format { get; set; }\n\nRequired. Identifies the storage format of the entity data.\nIt does not apply to entities with data stored in BigQuery.\n\n### Id\n\n public string Id { get; set; }\n\nRequired. A user-provided entity ID. It is mutable, and will be used as the\npublished table name. Specifying a new ID in an update entity\nrequest will override the existing value.\nThe ID must contain only letters (a-z, A-Z), numbers (0-9), and\nunderscores, and consist of 256 or fewer characters.\n\n### Name\n\n public string Name { get; set; }\n\nOutput only. The resource name of the entity, of the form:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.\n\n### Schema\n\n public Schema Schema { get; set; }\n\nRequired. The description of the data structure and layout.\nThe schema is not included in list responses. It is only included in\n`SCHEMA` and `FULL` entity views of a `GetEntity` response.\n\n### System\n\n public StorageSystem System { get; set; }\n\nRequired. Immutable. Identifies the storage system of the entity data.\n\n### Type\n\n public Entity.Types.Type Type { get; set; }\n\nRequired. Immutable. The type of entity.\n\n### Uid\n\n public string Uid { get; set; }\n\nOutput only. System generated unique ID for the Entity. This ID will be\ndifferent if the Entity is deleted and re-created with the same name.\n\n### UpdateTime\n\n public Timestamp UpdateTime { get; set; }\n\nOutput only. The time when the entity was last updated."]]
