entry_groups

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

Overview

Name	entry_groups
Type	Resource
Id	google.datacatalog.entry_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_entry_groups_get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
dataCatalogTimestamps	object	Output only. Timestamps of the entry group. Default value is empty. (id: GoogleCloudDatacatalogV1SystemTimestamps)
description	string	Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
displayName	string	A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
transferredToDataplex	boolean	Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.

projects_locations_entry_groups_list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
dataCatalogTimestamps	object	Output only. Timestamps of the entry group. Default value is empty. (id: GoogleCloudDatacatalogV1SystemTimestamps)
description	string	Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
displayName	string	A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
transferredToDataplex	boolean	Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.

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	readMask	Gets an entry group.
projects_locations_entry_groups_list	select	projectsId, locationsId	pageSize, pageToken	Lists entry groups.
projects_locations_entry_groups_create	insert	projectsId, locationsId	entryGroupId	Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: * BigQuery entries (@bigquery) * Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.
projects_locations_entry_groups_patch	update	projectsId, locationsId, entryGroupsId	updateMask	Updates an entry group. You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.
projects_locations_entry_groups_delete	delete	projectsId, locationsId, entryGroupsId	force	Deletes an entry group. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

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
force	boolean
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_entry_groups_get

Gets an entry group.

SELECT
name,
dataCatalogTimestamps,
description,
displayName,
transferredToDataplex
FROM google.datacatalog.entry_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required
AND readMask = '{{ readMask }}';

projects_locations_entry_groups_list

Lists entry groups.

SELECT
name,
dataCatalogTimestamps,
description,
displayName,
transferredToDataplex
FROM google.datacatalog.entry_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_entry_groups_create

Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: * BigQuery entries (@bigquery) * Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

INSERT INTO google.datacatalog.entry_groups (
data__name,
data__displayName,
data__description,
data__transferredToDataplex,
projectsId,
locationsId,
entryGroupId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
{{ transferredToDataplex }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryGroupId }}'
RETURNING
name,
dataCatalogTimestamps,
description,
displayName,
transferredToDataplex
;

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: name
      value: string
      description: >
        Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
        
    - name: displayName
      value: string
      description: >
        A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
        
    - name: description
      value: string
      description: >
        Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
        
    - name: transferredToDataplex
      value: boolean
      description: >
        Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.
        
    - name: entryGroupId
      value: string

UPDATE examples

projects_locations_entry_groups_patch

Updates an entry group. You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

UPDATE google.datacatalog.entry_groups
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__transferredToDataplex = {{ transferredToDataplex }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
dataCatalogTimestamps,
description,
displayName,
transferredToDataplex;

DELETE examples

projects_locations_entry_groups_delete

Deletes an entry group. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

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