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 message google.cloud.dataplex.v1.Entity
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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
string
Optional. Display name must be shorter than or equal to 256 characters.
↳ description
string
Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
↳ create_time
↳ update_time
↳ id
string
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
string
Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
↳ type
int
Required. Immutable. The type of entity.
↳ asset
string
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
string
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
string
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
string
Output only. The name of the associated Data Catalog entry.
↳ system
int
Required. Immutable. Identifies the storage system of the entity data.
↳ format
StorageFormat
Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
↳ compatibility
↳ access
↳ uid
string
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
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.
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}
.
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}
.
var
string
$this
getDisplayName
Optional. Display name must be shorter than or equal to 256 characters.
string
setDisplayName
Optional. Display name must be shorter than or equal to 256 characters.
var
string
$this
getDescription
Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
string
setDescription
Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
var
string
$this
getCreateTime
Output only. The time when the entity was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the entity was created.
$this
getUpdateTime
Output only. The time when the entity was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the entity was last updated.
$this
getId
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.
string
setId
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.
var
string
$this
getEtag
Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
string
setEtag
Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
var
string
$this
getType
Required. Immutable. The type of entity.
int
setType
Required. Immutable. The type of entity.
var
int
$this
getAsset
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.
string
setAsset
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.
var
string
$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 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
.
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 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
.
var
string
$this
getDataPathPattern
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
.
string
setDataPathPattern
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
.
var
string
$this
getCatalogEntry
Output only. The name of the associated Data Catalog entry.
string
setCatalogEntry
Output only. The name of the associated Data Catalog entry.
var
string
$this
getSystem
Required. Immutable. Identifies the storage system of the entity data.
int
setSystem
Required. Immutable. Identifies the storage system of the entity data.
var
int
$this
getFormat
Required. Identifies the storage format of the entity data.
It does not apply to entities with data stored in BigQuery.
hasFormat
clearFormat
setFormat
Required. Identifies the storage format of the entity data.
It does not apply to entities with data stored in BigQuery.
$this
getCompatibility
Output only. Metadata stores that the entity is compatible with.
hasCompatibility
clearCompatibility
setCompatibility
Output only. Metadata stores that the entity is compatible with.
$this
getAccess
Output only. Identifies the access mechanism to the entity. Not user settable.
hasAccess
clearAccess
setAccess
Output only. Identifies the access mechanism to the entity. Not user settable.
$this
getUid
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.
string
setUid
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.
var
string
$this
getSchema
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.
hasSchema
clearSchema
setSchema
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.
$this
