Google Cloud Dataplex V1 Client - Class DataAsset (1.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataAsset.

Represents a data asset resource that can be packaged and shared via a data product.

Generated from protobuf message google.cloud.dataplex.v1.DataAsset

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
↳ uid string

Output only. System generated globally unique ID for the data asset. This ID will be different if the data asset is deleted and re-created with the same name.
↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the data asset was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the data asset was last updated.
↳ etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels for the data asset. Example: { "environment": "production", "billing": "marketing-department" }
↳ resource string

Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported. Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.
↳ access_group_configs array|Google\Protobuf\Internal\MapField

Optional. Access groups configurations for this data asset. The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig. Example: { "analyst": { "iamRoles": ["roles/bigquery.dataViewer"] } } Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.

getName

Identifier. Resource name of the data asset.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}

Returns
Type Description
string

setName

Identifier. Resource name of the data asset.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. System generated globally unique ID for the data asset.

This ID will be different if the data asset is deleted and re-created with the same name.

Returns
Type Description
string

setUid

Output only. System generated globally unique ID for the data asset.

This ID will be different if the data asset is deleted and re-created with the same name.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time at which the data asset was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the data asset was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the data asset was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the data asset was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEtag

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
Type Description
string

setEtag

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. User-defined labels for the data asset.

Example:

{
  "environment": "production",
  "billing": "marketing-department"
}
Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels for the data asset.

Example:

{
  "environment": "production",
  "billing": "marketing-department"
}
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getResource

Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported.

Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.

Returns
Type Description
string

setResource

Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported.

Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.

Parameter
Name Description
var string
Returns
Type Description
$this

getAccessGroupConfigs

Optional. Access groups configurations for this data asset.

The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig. Example:

 {
   "analyst": {
     "iamRoles": ["roles/bigquery.dataViewer"]
   }
 }

Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAccessGroupConfigs

Optional. Access groups configurations for this data asset.

The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig. Example:

 {
   "analyst": {
     "iamRoles": ["roles/bigquery.dataViewer"]
   }
 }

Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this