Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Asset.
An asset represents a cloud resource that is being managed within a lake as a member of a zone.
Generated from protobuf message google.cloud.dataplex.v1.Asset
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The relative resource name of the asset, of the form: |
↳ display_name |
string
Optional. User friendly display name. |
↳ uid |
string
Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the asset was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the asset was last updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. User defined labels for the asset. |
↳ description |
string
Optional. Description of the asset. |
↳ state |
int
Output only. Current state of the asset. |
↳ resource_spec |
Google\Cloud\Dataplex\V1\Asset\ResourceSpec
Required. Specification of the resource that is referenced by this asset. |
↳ resource_status |
Google\Cloud\Dataplex\V1\Asset\ResourceStatus
Output only. Status of the resource referenced by this asset. |
↳ security_status |
Google\Cloud\Dataplex\V1\Asset\SecurityStatus
Output only. Status of the security policy applied to resource referenced by this asset. |
↳ discovery_spec |
Google\Cloud\Dataplex\V1\Asset\DiscoverySpec
Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone. |
↳ discovery_status |
Google\Cloud\Dataplex\V1\Asset\DiscoveryStatus
Output only. Status of the discovery feature applied to data referenced by this asset. |
getName
Output only. The relative resource name of the asset, of the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The relative resource name of the asset, of the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Optional. User friendly display name.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. User friendly display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time when the asset was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the asset was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the asset was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the asset was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. User defined labels for the asset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. User defined labels for the asset.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the asset.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the asset.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Current state of the asset.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Current state of the asset.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceSpec
Required. Specification of the resource that is referenced by this asset.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Asset\ResourceSpec|null | |
hasResourceSpec
clearResourceSpec
setResourceSpec
Required. Specification of the resource that is referenced by this asset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Asset\ResourceSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceStatus
Output only. Status of the resource referenced by this asset.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Asset\ResourceStatus|null | |
hasResourceStatus
clearResourceStatus
setResourceStatus
Output only. Status of the resource referenced by this asset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Asset\ResourceStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecurityStatus
Output only. Status of the security policy applied to resource referenced by this asset.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Asset\SecurityStatus|null | |
hasSecurityStatus
clearSecurityStatus
setSecurityStatus
Output only. Status of the security policy applied to resource referenced by this asset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Asset\SecurityStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiscoverySpec
Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Asset\DiscoverySpec|null | |
hasDiscoverySpec
clearDiscoverySpec
setDiscoverySpec
Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Asset\DiscoverySpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiscoveryStatus
Output only. Status of the discovery feature applied to data referenced by this asset.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Asset\DiscoveryStatus|null | |
hasDiscoveryStatus
clearDiscoveryStatus
setDiscoveryStatus
Output only. Status of the discovery feature applied to data referenced by this asset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Asset\DiscoveryStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |