Skip to main content

aspect_types

Creates, updates, deletes, gets or lists an aspect_types resource.

Overview

Nameaspect_types
TypeResource
Idgoogle.dataplex.aspect_types

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringOutput only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
authorizationobjectImmutable. Defines the Authorization for this type. (id: GoogleCloudDataplexV1AspectTypeAuthorization)
createTimestring (google-datetime)Output only. The time when the AspectType was created.
dataClassificationstringOptional. Immutable. Stores data classification of the aspect. (DATA_CLASSIFICATION_UNSPECIFIED, METADATA_AND_DATA)
descriptionstringOptional. Description of the AspectType.
displayNamestringOptional. User friendly display name.
etagstringThe service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding.
labelsobjectOptional. User-defined labels for the AspectType.
metadataTemplateobjectRequired. MetadataTemplate of the aspect. (id: GoogleCloudDataplexV1AspectTypeMetadataTemplate)
transferStatusstringOutput only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. (TRANSFER_STATUS_UNSPECIFIED, TRANSFER_STATUS_MIGRATED, TRANSFER_STATUS_TRANSFERRED)
uidstringOutput only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.
updateTimestring (google-datetime)Output only. The time when the AspectType was last updated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_aspect_types_getselectprojectsId, locationsId, aspectTypesIdGets an AspectType.
projects_locations_aspect_types_listselectprojectsId, locationsIdpageSize, orderBy, filter, pageTokenLists AspectType resources in a project and location.
projects_locations_aspect_types_createinsertprojectsId, locationsIdaspectTypeId, validateOnlyCreates an AspectType.
projects_locations_aspect_types_patchupdateprojectsId, locationsId, aspectTypesIdupdateMask, validateOnlyUpdates an AspectType.
projects_locations_aspect_types_deletedeleteprojectsId, locationsId, aspectTypesIdetagDeletes an AspectType.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
aspectTypesIdstring
locationsIdstring
projectsIdstring
aspectTypeIdstring
etagstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)
validateOnlyboolean

SELECT examples

Gets an AspectType.

SELECT
name,
authorization,
createTime,
dataClassification,
description,
displayName,
etag,
labels,
metadataTemplate,
transferStatus,
uid,
updateTime
FROM google.dataplex.aspect_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND aspectTypesId = '{{ aspectTypesId }}' -- required
;

INSERT examples

Creates an AspectType.

INSERT INTO google.dataplex.aspect_types (
data__dataClassification,
data__labels,
data__metadataTemplate,
data__displayName,
data__etag,
data__authorization,
data__description,
projectsId,
locationsId,
aspectTypeId,
validateOnly
)
SELECT
'{{ dataClassification }}',
'{{ labels }}',
'{{ metadataTemplate }}',
'{{ displayName }}',
'{{ etag }}',
'{{ authorization }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ aspectTypeId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples

Updates an AspectType.

UPDATE google.dataplex.aspect_types
SET
data__dataClassification = '{{ dataClassification }}',
data__labels = '{{ labels }}',
data__metadataTemplate = '{{ metadataTemplate }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__authorization = '{{ authorization }}',
data__description = '{{ description }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND aspectTypesId = '{{ aspectTypesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

Deletes an AspectType.

DELETE FROM google.dataplex.aspect_types
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND aspectTypesId = '{{ aspectTypesId }}' --required
AND etag = '{{ etag }}'
;