Reference documentation and code samples for the Google Cloud Dataplex V1 Client class AspectType.
Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.
Generated from protobuf message google.cloud.dataplex.v1.AspectType
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. |
↳ uid |
string
Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the AspectType was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the AspectType was last updated. |
↳ description |
string
Optional. Description of the AspectType. |
↳ display_name |
string
Optional. User friendly display name. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. User-defined labels for the AspectType. |
↳ etag |
string
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. |
↳ authorization |
Google\Cloud\Dataplex\V1\AspectType\Authorization
Immutable. Authorization defined for this type. |
↳ metadata_template |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
Required. MetadataTemplate of the aspect. |
↳ transfer_status |
int
Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. |
getName
Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Returns | |
---|---|
Type | Description |
string |
setName
Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUid
Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
Returns | |
---|---|
Type | Description |
string |
setUid
Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType 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 AspectType was created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the AspectType was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. The time when the AspectType was last updated.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the AspectType was last updated.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
Optional. Description of the AspectType.
Returns | |
---|---|
Type | Description |
string |
setDescription
Optional. Description of the AspectType.
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 |
getLabels
Optional. User-defined labels for the AspectType.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Optional. User-defined labels for the AspectType.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getEtag
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
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 |
getAuthorization
Immutable. Authorization defined for this type.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\Authorization|null |
hasAuthorization
clearAuthorization
setAuthorization
Immutable. Authorization defined for this type.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\Authorization
|
Returns | |
---|---|
Type | Description |
$this |
getMetadataTemplate
Required. MetadataTemplate of the aspect.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate|null |
hasMetadataTemplate
clearMetadataTemplate
setMetadataTemplate
Required. MetadataTemplate of the aspect.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
|
Returns | |
---|---|
Type | Description |
$this |
getTransferStatus
Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
Returns | |
---|---|
Type | Description |
int |
setTransferStatus
Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |