entry_groups

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

Overview

Name	entry_groups
Type	Resource
Id	google.dataplex.entry_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_entry_groups_get

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
createTime	string (google-datetime)	Output only. The time when the EntryGroup was created.
description	string	Optional. Description of the EntryGroup.
displayName	string	Optional. User friendly display name.
etag	string	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 EntryGroup.
transferStatus	string	Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
uid	string	Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.
updateTime	string (google-datetime)	Output only. The time when the EntryGroup was last updated.

projects_locations_entry_groups_list

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
createTime	string (google-datetime)	Output only. The time when the EntryGroup was created.
description	string	Optional. Description of the EntryGroup.
displayName	string	Optional. User friendly display name.
etag	string	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 EntryGroup.
transferStatus	string	Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
uid	string	Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.
updateTime	string (google-datetime)	Output only. The time when the EntryGroup was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_entry_groups_get	select	projectsId, locationsId, entryGroupsId		Gets an EntryGroup.
projects_locations_entry_groups_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists EntryGroup resources in a project and location.
projects_locations_entry_groups_create	insert	projectsId, locationsId	entryGroupId, validateOnly	Creates an EntryGroup.
projects_locations_entry_groups_patch	update	projectsId, locationsId, entryGroupsId	updateMask, validateOnly	Updates an EntryGroup.
projects_locations_entry_groups_delete	delete	projectsId, locationsId, entryGroupsId	etag	Deletes an EntryGroup.

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

SELECT examples

projects_locations_entry_groups_get

Gets an EntryGroup.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
transferStatus,
uid,
updateTime
FROM google.dataplex.entry_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required;

projects_locations_entry_groups_list

Lists EntryGroup resources in a project and location.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
transferStatus,
uid,
updateTime
FROM google.dataplex.entry_groups
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_groups_create

Creates an EntryGroup.

INSERT INTO google.dataplex.entry_groups (
data__description,
data__displayName,
data__labels,
data__etag,
projectsId,
locationsId,
entryGroupId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryGroupId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: entry_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the entry_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the entry_groups resource.
    - name: description
      value: string
      description: >
        Optional. Description of the EntryGroup.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the EntryGroup.
        
    - name: etag
      value: string
      description: >
        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: entryGroupId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_entry_groups_patch

Updates an EntryGroup.

UPDATE google.dataplex.entry_groups
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_entry_groups_delete

Deletes an EntryGroup.

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