entry_links

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

Overview

Name	entry_links
Type	Resource
Id	google.dataplex.entry_links

Fields

The following fields are returned by SELECT queries:

projects_locations_entry_groups_entry_links_get

Name	Datatype	Description
name	string	Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
aspects	object	Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
createTime	string (google-datetime)	Output only. The time when the Entry Link was created.
entryLinkType	string	Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
entryReferences	array	Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
updateTime	string (google-datetime)	Output only. The time when the Entry Link was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_entry_groups_entry_links_get	select	projectsId, locationsId, entryGroupsId, entryLinksId		Gets an Entry Link.
projects_locations_entry_groups_entry_links_create	insert	projectsId, locationsId, entryGroupsId	entryLinkId	Creates an Entry Link.
projects_locations_entry_groups_entry_links_patch	update	projectsId, locationsId, entryGroupsId, entryLinksId	allowMissing, aspectKeys	Updates an Entry Link.
projects_locations_entry_groups_entry_links_delete	delete	projectsId, locationsId, entryGroupsId, entryLinksId		Deletes an Entry Link.

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
entryGroupsId	string
entryLinksId	string
locationsId	string
projectsId	string
allowMissing	boolean
aspectKeys	string
entryLinkId	string

SELECT examples

projects_locations_entry_groups_entry_links_get

Gets an Entry Link.

SELECT
name,
aspects,
createTime,
entryLinkType,
entryReferences,
updateTime
FROM google.dataplex.entry_links
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required
AND entryLinksId = '{{ entryLinksId }}' -- required
;

INSERT examples

projects_locations_entry_groups_entry_links_create

Creates an Entry Link.

INSERT INTO google.dataplex.entry_links (
data__entryReferences,
data__aspects,
data__entryLinkType,
projectsId,
locationsId,
entryGroupsId,
entryLinkId
)
SELECT 
'{{ entryReferences }}',
'{{ aspects }}',
'{{ entryLinkType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryGroupsId }}',
'{{ entryLinkId }}'
RETURNING
name,
aspects,
createTime,
entryLinkType,
entryReferences,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: entry_links
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the entry_links resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the entry_links resource.
  - name: entryGroupsId
    value: "{{ entryGroupsId }}"
    description: Required parameter for the entry_links resource.
  - name: entryReferences
    description: |
      Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    value:
      - path: "{{ path }}"
        name: "{{ name }}"
        type: "{{ type }}"
  - name: aspects
    value: "{{ aspects }}"
    description: |
      Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
  - name: entryLinkType
    value: "{{ entryLinkType }}"
    description: |
      Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  - name: entryLinkId
    value: "{{ entryLinkId }}"

UPDATE examples

projects_locations_entry_groups_entry_links_patch

Updates an Entry Link.

UPDATE google.dataplex.entry_links
SET 
data__entryReferences = '{{ entryReferences }}',
data__aspects = '{{ aspects }}',
data__entryLinkType = '{{ entryLinkType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND entryLinksId = '{{ entryLinksId }}' --required
AND allowMissing = {{ allowMissing}}
AND aspectKeys = '{{ aspectKeys}}'
RETURNING
name,
aspects,
createTime,
entryLinkType,
entryReferences,
updateTime;

DELETE examples

projects_locations_entry_groups_entry_links_delete

Deletes an Entry Link.

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