Google Cloud Dataplex V1 Client - Class Entity (1.11.0)
Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Entity.
Represents tables and fileset metadata contained within a zone.
Generated from protobuf messagegoogle.cloud.dataplex.v1.Entity
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringOutput only. The resource name of the entity, of the form: |
↳ display_name | stringOptional. Display name must be shorter than or equal to 256 characters. |
↳ description | stringOptional. User friendly longer description text. Must be shorter than or equal to 1024 characters. |
↳ create_time | Google\Protobuf\TimestampOutput only. The time when the entity was created. |
↳ update_time | Google\Protobuf\TimestampOutput only. The time when the entity was last updated. |
↳ id | stringRequired. 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 | stringOptional. The etag associated with the entity, which can be retrieved with aGetEntity request. Required for update and delete requests. |
↳ type | intRequired. Immutable. The type of entity. |
↳ asset | stringRequired. 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 | stringRequired. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as |
↳ data_path_pattern | stringOptional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: |
↳ catalog_entry | stringOutput only. The name of the associated Data Catalog entry. |
↳ system | intRequired. Immutable. Identifies the storage system of the entity data. |
↳ format | StorageFormatRequired. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery. |
↳ compatibility | Entity\CompatibilityStatusOutput only. Metadata stores that the entity is compatible with. |
↳ access | StorageAccessOutput only. Identifies the access mechanism to the entity. Not user settable. |
↳ uid | stringOutput 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 | SchemaRequired. The description of the data structure and layout. The schema is not included in list responses. It is only included in |
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}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
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}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Optional. Display name must be shorter than or equal to 256 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. Display name must be shorter than or equal to 256 characters.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. User friendly longer description text. Must be shorter than orequal to 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. User friendly longer description text. Must be shorter than orequal to 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time when the entity was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the entity was created.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the entity was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the entity was last updated.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
Required. A user-provided entity ID. It is mutable, and will be used as thepublished table name. Specifying a new ID in an update entityrequest will override the existing value.
The ID must contain only letters (a-z, A-Z), numbers (0-9), andunderscores, and consist of 256 or fewer characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setId
Required. A user-provided entity ID. It is mutable, and will be used as thepublished table name. Specifying a new ID in an update entityrequest will override the existing value.
The ID must contain only letters (a-z, A-Z), numbers (0-9), andunderscores, and consist of 256 or fewer characters.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Optional. The etag associated with the entity, which can be retrieved withaGetEntity request. Required for update and delete requests.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Optional. The etag associated with the entity, which can be retrieved withaGetEntity request. Required for update and delete requests.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Required. Immutable. The type of entity.
| Returns | |
|---|---|
| Type | Description |
int | Enum of typeType. |
setType
Required. Immutable. The type of entity.
| Parameter | |
|---|---|
| Name | Description |
var | intEnum of typeType. |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAsset
Required. Immutable. The ID of the asset associated with the storagelocation containing the entity data. The entity must be with in the samezone with the asset.
| Returns | |
|---|---|
| Type | Description |
string | |
setAsset
Required. Immutable. The ID of the asset associated with the storagelocation containing the entity data. The entity must be with in the samezone with the asset.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataPath
Required. Immutable. The storage path of the entity data.
For Cloud Storage data, this is the fully-qualified path to the entity,such asgs://bucket/path/to/data. For BigQuery data, this is the name ofthe table resource, such asprojects/project_id/datasets/dataset_id/tables/table_id.
| Returns | |
|---|---|
| Type | Description |
string | |
setDataPath
Required. Immutable. The storage path of the entity data.
For Cloud Storage data, this is the fully-qualified path to the entity,such asgs://bucket/path/to/data. For BigQuery data, this is the name ofthe table resource, such asprojects/project_id/datasets/dataset_id/tables/table_id.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataPathPattern
Optional. The set of items within the data path constituting the data inthe entity, represented as a glob path. Example:gs://bucket/path/to/data/**/*.csv.
| Returns | |
|---|---|
| Type | Description |
string | |
setDataPathPattern
Optional. The set of items within the data path constituting the data inthe entity, represented as a glob path. Example:gs://bucket/path/to/data/**/*.csv.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCatalogEntry
Output only. The name of the associated Data Catalog entry.
| Returns | |
|---|---|
| Type | Description |
string | |
setCatalogEntry
Output only. The name of the associated Data Catalog entry.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSystem
Required. Immutable. Identifies the storage system of the entity data.
| Returns | |
|---|---|
| Type | Description |
int | Enum of typeStorageSystem. |
setSystem
Required. Immutable. Identifies the storage system of the entity data.
| Parameter | |
|---|---|
| Name | Description |
var | intEnum of typeStorageSystem. |
| Returns | |
|---|---|
| Type | Description |
$this | |
getFormat
Required. Identifies the storage format of the entity data.
It does not apply to entities with data stored in BigQuery.
| Returns | |
|---|---|
| Type | Description |
StorageFormat|null | |
hasFormat
clearFormat
setFormat
Required. Identifies the storage format of the entity data.
It does not apply to entities with data stored in BigQuery.
| Parameter | |
|---|---|
| Name | Description |
var | StorageFormat |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompatibility
Output only. Metadata stores that the entity is compatible with.
| Returns | |
|---|---|
| Type | Description |
Entity\CompatibilityStatus|null | |
hasCompatibility
clearCompatibility
setCompatibility
Output only. Metadata stores that the entity is compatible with.
| Parameter | |
|---|---|
| Name | Description |
var | Entity\CompatibilityStatus |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAccess
Output only. Identifies the access mechanism to the entity. Not usersettable.
| Returns | |
|---|---|
| Type | Description |
StorageAccess|null | |
hasAccess
clearAccess
setAccess
Output only. Identifies the access mechanism to the entity. Not usersettable.
| Parameter | |
|---|---|
| Name | Description |
var | StorageAccess |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System generated unique ID for the Entity. This ID will bedifferent if the Entity is deleted and re-created with the same name.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System generated unique ID for the Entity. This ID will bedifferent if the Entity is deleted and re-created with the same name.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchema
Required. The description of the data structure and layout.
The schema is not included in list responses. It is only included inSCHEMA andFULL entity views of aGetEntity response.
| Returns | |
|---|---|
| Type | Description |
Schema|null | |
hasSchema
clearSchema
setSchema
Required. The description of the data structure and layout.
The schema is not included in list responses. It is only included inSCHEMA andFULL entity views of aGetEntity response.
| Parameter | |
|---|---|
| Name | Description |
var | Schema |
| Returns | |
|---|---|
| Type | Description |
$this | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-08 UTC.