aspect_types

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

Overview

Name	aspect_types
Type	Resource
Id	google.dataplex.aspect_types

Fields

The following fields are returned by SELECT queries:

projects_locations_aspect_types_get

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
authorization	object	Immutable. Defines the Authorization for this type. (id: GoogleCloudDataplexV1AspectTypeAuthorization)
createTime	string (google-datetime)	Output only. The time when the AspectType was created.
description	string	Optional. Description of the AspectType.
displayName	string	Optional. User friendly display name.
etag	string	The 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.
labels	object	Optional. User-defined labels for the AspectType.
metadataTemplate	object	Required. MetadataTemplate of the aspect. (id: GoogleCloudDataplexV1AspectTypeMetadataTemplate)
transferStatus	string	Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
uid	string	Output 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.
updateTime	string (google-datetime)	Output only. The time when the AspectType was last updated.

projects_locations_aspect_types_list

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
authorization	object	Immutable. Defines the Authorization for this type. (id: GoogleCloudDataplexV1AspectTypeAuthorization)
createTime	string (google-datetime)	Output only. The time when the AspectType was created.
description	string	Optional. Description of the AspectType.
displayName	string	Optional. User friendly display name.
etag	string	The 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.
labels	object	Optional. User-defined labels for the AspectType.
metadataTemplate	object	Required. MetadataTemplate of the aspect. (id: GoogleCloudDataplexV1AspectTypeMetadataTemplate)
transferStatus	string	Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
uid	string	Output 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.
updateTime	string (google-datetime)	Output only. The time when the AspectType was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_aspect_types_get	select	projectsId, locationsId, aspectTypesId		Gets an AspectType.
projects_locations_aspect_types_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists AspectType resources in a project and location.
projects_locations_aspect_types_create	insert	projectsId, locationsId	aspectTypeId, validateOnly	Creates an AspectType.
projects_locations_aspect_types_patch	update	projectsId, locationsId, aspectTypesId	updateMask, validateOnly	Updates an AspectType.
projects_locations_aspect_types_delete	delete	projectsId, locationsId, aspectTypesId	etag	Deletes 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.

Name	Datatype	Description
aspectTypesId	string
locationsId	string
projectsId	string
aspectTypeId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_aspect_types_get

Gets an AspectType.

SELECT
name,
authorization,
createTime,
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;

projects_locations_aspect_types_list

Lists AspectType resources in a project and location.

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

INSERT examples

projects_locations_aspect_types_create

Creates an AspectType.

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

Manifest

# Description fields are for documentation purposes
- name: aspect_types
  props:
    - name: projectsId
      value: string
      description: Required parameter for the aspect_types resource.
    - name: locationsId
      value: string
      description: Required parameter for the aspect_types resource.
    - name: description
      value: string
      description: >
        Optional. Description of the AspectType.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the AspectType.
        
    - name: etag
      value: string
      description: >
        The 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.
        
    - name: authorization
      value: object
      description: >
        Immutable. Defines the Authorization for this type.
        
    - name: metadataTemplate
      value: object
      description: >
        Required. MetadataTemplate of the aspect.
        
    - name: aspectTypeId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_aspect_types_patch

Updates an AspectType.

UPDATE google.dataplex.aspect_types
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__authorization = '{{ authorization }}',
data__metadataTemplate = '{{ metadataTemplate }}'
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

projects_locations_aspect_types_delete

Deletes an AspectType.

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