entry_groups

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

Overview

Name	entry_groups
Type	Resource
Id	google.datacatalog.entry_groups

Fields

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.
description	string	Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
dataCatalogTimestamps	object	Timestamps associated with this resource in a particular system.
displayName	string	A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.

Methods

Name	Accessible by	Required Params	Description
projects_locations_entry_groups_get	SELECT	entryGroupsId, locationsId, projectsId	Gets an entry group.
projects_locations_entry_groups_list	SELECT	locationsId, projectsId	Lists entry groups.
projects_locations_entry_groups_create	INSERT	locationsId, projectsId	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_delete	DELETE	entryGroupsId, locationsId, projectsId	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.
projects_locations_entry_groups_patch	UPDATE	entryGroupsId, locationsId, projectsId	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.

SELECT examples

Lists entry groups.

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

INSERT example

Use the following StackQL query and manifest file to create a new entry_groups resource.

All Properties

/*+ create */
INSERT INTO google.datacatalog.entry_groups (
locationsId,
projectsId,
name,
displayName,
description
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: dataCatalogTimestamps
      value:
        - name: createTime
          value: string
        - name: updateTime
          value: string
        - name: expireTime
          value: string

UPDATE example

Updates a entry_groups resource.

/*+ update */
UPDATE google.datacatalog.entry_groups
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}'
WHERE 
entryGroupsId = '{{ entryGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified entry_groups resource.

/*+ delete */
DELETE FROM google.datacatalog.entry_groups
WHERE entryGroupsId = '{{ entryGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';