entries

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

Overview

Name	entries
Type	Resource
Id	google.dataplex.entries

Fields

The following fields are returned by SELECT queries:

projects_locations_entry_groups_entries_get

Successful response

Name	Datatype	Description
name	string	Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
aspects	object	Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
createTime	string (google-datetime)	Output only. The time when the entry was created in Dataplex Universal Catalog.
entrySource	object	Optional. Information related to the source system of the data resource that is represented by the entry. (id: GoogleCloudDataplexV1EntrySource)
entryType	string	Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
fullyQualifiedName	string	Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
parentEntry	string	Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
updateTime	string (google-datetime)	Output only. The time when the entry was last updated in Dataplex Universal Catalog.

projects_locations_entry_groups_entries_list

Successful response

Name	Datatype	Description
name	string	Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
aspects	object	Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
createTime	string (google-datetime)	Output only. The time when the entry was created in Dataplex Universal Catalog.
entrySource	object	Optional. Information related to the source system of the data resource that is represented by the entry. (id: GoogleCloudDataplexV1EntrySource)
entryType	string	Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
fullyQualifiedName	string	Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
parentEntry	string	Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
updateTime	string (google-datetime)	Output only. The time when the entry was last updated in Dataplex Universal Catalog.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_entry_groups_entries_get	select	projectsId, locationsId, entryGroupsId, entriesId	view, aspectTypes, paths	Gets an Entry.
projects_locations_entry_groups_entries_list	select	projectsId, locationsId, entryGroupsId	pageSize, pageToken, filter	Lists Entries within an EntryGroup.
projects_locations_entry_groups_entries_create	insert	projectsId, locationsId, entryGroupsId	entryId	Creates an Entry.
projects_locations_entry_groups_entries_patch	update	projectsId, locationsId, entryGroupsId, entriesId	updateMask, allowMissing, deleteMissingAspects, aspectKeys	Updates an Entry.
projects_locations_entry_groups_entries_delete	delete	projectsId, locationsId, entryGroupsId, entriesId		Deletes an Entry.

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
entriesId	string
entryGroupsId	string
locationsId	string
projectsId	string
allowMissing	boolean
aspectKeys	string
aspectTypes	string
deleteMissingAspects	boolean
entryId	string
filter	string
pageSize	integer (int32)
pageToken	string
paths	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

projects_locations_entry_groups_entries_get

Gets an Entry.

SELECT
name,
aspects,
createTime,
entrySource,
entryType,
fullyQualifiedName,
parentEntry,
updateTime
FROM google.dataplex.entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required
AND entriesId = '{{ entriesId }}' -- required
AND view = '{{ view }}'
AND aspectTypes = '{{ aspectTypes }}'
AND paths = '{{ paths }}';

projects_locations_entry_groups_entries_list

Lists Entries within an EntryGroup.

SELECT
name,
aspects,
createTime,
entrySource,
entryType,
fullyQualifiedName,
parentEntry,
updateTime
FROM google.dataplex.entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

projects_locations_entry_groups_entries_create

Creates an Entry.

INSERT INTO google.dataplex.entries (
data__name,
data__entryType,
data__aspects,
data__parentEntry,
data__fullyQualifiedName,
data__entrySource,
projectsId,
locationsId,
entryGroupsId,
entryId
)
SELECT 
'{{ name }}',
'{{ entryType }}',
'{{ aspects }}',
'{{ parentEntry }}',
'{{ fullyQualifiedName }}',
'{{ entrySource }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryGroupsId }}',
'{{ entryId }}'
RETURNING
name,
aspects,
createTime,
entrySource,
entryType,
fullyQualifiedName,
parentEntry,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: entries
  props:
    - name: projectsId
      value: string
      description: Required parameter for the entries resource.
    - name: locationsId
      value: string
      description: Required parameter for the entries resource.
    - name: entryGroupsId
      value: string
      description: Required parameter for the entries resource.
    - name: name
      value: string
      description: >
        Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
        
    - name: entryType
      value: string
      description: >
        Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
        
    - name: aspects
      value: object
      description: >
        Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
        
    - name: parentEntry
      value: string
      description: >
        Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
        
    - name: fullyQualifiedName
      value: string
      description: >
        Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
        
    - name: entrySource
      value: object
      description: >
        Optional. Information related to the source system of the data resource that is represented by the entry.
        
    - name: entryId
      value: string

UPDATE examples

projects_locations_entry_groups_entries_patch

Updates an Entry.

UPDATE google.dataplex.entries
SET 
data__name = '{{ name }}',
data__entryType = '{{ entryType }}',
data__aspects = '{{ aspects }}',
data__parentEntry = '{{ parentEntry }}',
data__fullyQualifiedName = '{{ fullyQualifiedName }}',
data__entrySource = '{{ entrySource }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND entriesId = '{{ entriesId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND deleteMissingAspects = {{ deleteMissingAspects}}
AND aspectKeys = '{{ aspectKeys}}'
RETURNING
name,
aspects,
createTime,
entrySource,
entryType,
fullyQualifiedName,
parentEntry,
updateTime;

DELETE examples

projects_locations_entry_groups_entries_delete

Deletes an Entry.

DELETE FROM google.dataplex.entries
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND entriesId = '{{ entriesId }}' --required;