Google Cloud Dataplex V1 Client - Class Entity (0.1.6)

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

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 63 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. Must begin with a letter.
`↳ etag`	`string` Optional. The etag for this entity. Required for update and delete requests. Must match the server's etag.
`↳ 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.
`↳ 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}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setDisplayName

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setDescription

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

Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the entity was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the entity was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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. Must begin with a letter.

Generated from protobuf field string id = 7 [(.google.api.field_behavior) = REQUIRED];

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. Must begin with a letter.

Generated from protobuf field string id = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEtag

Optional. The etag for this entity. Required for update and delete requests. Must match the server's etag.

Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setEtag

Optional. The etag for this entity. Required for update and delete requests. Must match the server's etag.

Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Required. Immutable. The type of entity.

Generated from protobuf field .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`int`

setType

Required. Immutable. The type of entity.

Generated from protobuf field .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`string`

setDataPath

Required. Immutable. The storage path of the entity data.

Generated from protobuf field string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCatalogEntry

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

Generated from protobuf field string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setCatalogEntry

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

Generated from protobuf field string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSystem

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

Generated from protobuf field .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`int`

setSystem

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

Generated from protobuf field .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

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.

Generated from protobuf field .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\StorageFormat`

Returns
Type	Description
`$this`

getCompatibility

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

Generated from protobuf field .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

hasCompatibility

clearCompatibility

setCompatibility

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

Generated from protobuf field .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Entity\CompatibilityStatus`

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.

Generated from protobuf field .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

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.

Generated from protobuf field .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Schema`

Returns
Type	Description
`$this`