Google Cloud Dataplex V1 Client - Class Entity (0.16.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 Google\Protobuf\Timestamp

Output only. The time when the entity was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time when the entity was last updated.
↳ 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 Google\Cloud\Dataplex\V1\StorageFormat

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
↳ compatibility Google\Cloud\Dataplex\V1\Entity\CompatibilityStatus

Output only. Metadata stores that the entity is compatible with.
↳ access Google\Cloud\Dataplex\V1\StorageAccess

Output only. Identifies the access mechanism to the entity. Not user settable.
↳ 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 Google\Cloud\Dataplex\V1\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}.

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 or equal to 1024 characters.

Returns
Type Description
string

setDescription

Optional. User friendly longer description text. Must be shorter than or equal 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 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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.

Returns
Type Description
string

setEtag

Optional. The etag associated with the entity, which can be retrieved with a GetEntity 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

setType

Required. Immutable. The type of entity.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

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 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.

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 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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

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

setSystem

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

Parameter
Name Description
var int
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
Google\Cloud\Dataplex\V1\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 Google\Cloud\Dataplex\V1\StorageFormat
Returns
Type Description
$this

getCompatibility

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

Returns
Type Description
Google\Cloud\Dataplex\V1\Entity\CompatibilityStatus|null

hasCompatibility

clearCompatibility

setCompatibility

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

Parameter
Name Description
var Google\Cloud\Dataplex\V1\Entity\CompatibilityStatus
Returns
Type Description
$this

getAccess

Output only. Identifies the access mechanism to the entity. Not user settable.

Returns
Type Description
Google\Cloud\Dataplex\V1\StorageAccess|null

hasAccess

clearAccess

setAccess

Output only. Identifies the access mechanism to the entity. Not user settable.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\StorageAccess
Returns
Type Description
$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.

Returns
Type Description
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.

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 in SCHEMA and FULL entity views of a GetEntity response.

Returns
Type Description
Google\Cloud\Dataplex\V1\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 in SCHEMA and FULL entity views of a GetEntity response.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\Schema
Returns
Type Description
$this