entry_types

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

Overview

Name	`entry_types`
Type	Resource
Id	`google.dataplex.entry_types`

Fields

The following fields are returned by SELECT queries:

projects_locations_entry_types_get
projects_locations_entry_types_list

Successful response

Name	Datatype	Description
`name`	`string`	Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
`authorization`	`object`	Immutable. Authorization defined for this type. (id: GoogleCloudDataplexV1EntryTypeAuthorization)
`createTime`	`string (google-datetime)`	Output only. The time when the EntryType was created.
`description`	`string`	Optional. Description of the EntryType.
`displayName`	`string`	Optional. User friendly display name.
`etag`	`string`	Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
`labels`	`object`	Optional. User-defined labels for the EntryType.
`platform`	`string`	Optional. The platform that Entries of this type belongs to.
`requiredAspects`	`array`	AspectInfo for the entry type.
`system`	`string`	Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
`typeAliases`	`array`	Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
`uid`	`string`	Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
`updateTime`	`string (google-datetime)`	Output only. The time when the EntryType was last updated.

Successful response

Name	Datatype	Description
`name`	`string`	Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
`authorization`	`object`	Immutable. Authorization defined for this type. (id: GoogleCloudDataplexV1EntryTypeAuthorization)
`createTime`	`string (google-datetime)`	Output only. The time when the EntryType was created.
`description`	`string`	Optional. Description of the EntryType.
`displayName`	`string`	Optional. User friendly display name.
`etag`	`string`	Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
`labels`	`object`	Optional. User-defined labels for the EntryType.
`platform`	`string`	Optional. The platform that Entries of this type belongs to.
`requiredAspects`	`array`	AspectInfo for the entry type.
`system`	`string`	Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
`typeAliases`	`array`	Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
`uid`	`string`	Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
`updateTime`	`string (google-datetime)`	Output only. The time when the EntryType was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`projects_locations_entry_types_get`	`select`	`projectsId`, `locationsId`, `entryTypesId`		Gets an EntryType.
`projects_locations_entry_types_list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists EntryType resources in a project and location.
`projects_locations_entry_types_create`	`insert`	`projectsId`, `locationsId`	`entryTypeId`, `validateOnly`	Creates an EntryType.
`projects_locations_entry_types_patch`	`update`	`projectsId`, `locationsId`, `entryTypesId`	`updateMask`, `validateOnly`	Updates an EntryType.
`projects_locations_entry_types_delete`	`delete`	`projectsId`, `locationsId`, `entryTypesId`	`etag`	Deletes an EntryType.

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
`entryTypesId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`entryTypeId`	`string`
`etag`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

projects_locations_entry_types_get
projects_locations_entry_types_list

Gets an EntryType.

SELECT
name,
authorization,
createTime,
description,
displayName,
etag,
labels,
platform,
requiredAspects,
system,
typeAliases,
uid,
updateTime
FROM google.dataplex.entry_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryTypesId = '{{ entryTypesId }}' -- required;

Lists EntryType resources in a project and location.

SELECT
name,
authorization,
createTime,
description,
displayName,
etag,
labels,
platform,
requiredAspects,
system,
typeAliases,
uid,
updateTime
FROM google.dataplex.entry_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_entry_types_create
Manifest

Creates an EntryType.

INSERT INTO google.dataplex.entry_types (
data__description,
data__displayName,
data__labels,
data__etag,
data__typeAliases,
data__platform,
data__system,
data__requiredAspects,
data__authorization,
projectsId,
locationsId,
entryTypeId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ etag }}',
'{{ typeAliases }}',
'{{ platform }}',
'{{ system }}',
'{{ requiredAspects }}',
'{{ authorization }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryTypeId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: entry_types
  props:
    - name: projectsId
      value: string
      description: Required parameter for the entry_types resource.
    - name: locationsId
      value: string
      description: Required parameter for the entry_types resource.
    - name: description
      value: string
      description: >
        Optional. Description of the EntryType.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the EntryType.
        
    - name: etag
      value: string
      description: >
        Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
        
    - name: typeAliases
      value: array
      description: >
        Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
        
    - name: platform
      value: string
      description: >
        Optional. The platform that Entries of this type belongs to.
        
    - name: system
      value: string
      description: >
        Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
        
    - name: requiredAspects
      value: array
      description: >
        AspectInfo for the entry type.
        
    - name: authorization
      value: object
      description: >
        Immutable. Authorization defined for this type.
        
    - name: entryTypeId
      value: string
    - name: validateOnly
      value: boolean

`UPDATE` examples

projects_locations_entry_types_patch

Updates an EntryType.

UPDATE google.dataplex.entry_types
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__typeAliases = '{{ typeAliases }}',
data__platform = '{{ platform }}',
data__system = '{{ system }}',
data__requiredAspects = '{{ requiredAspects }}',
data__authorization = '{{ authorization }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryTypesId = '{{ entryTypesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

projects_locations_entry_types_delete

Deletes an EntryType.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​