Skip to main content

entries

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

Overview​

Nameentries
TypeResource
Idgoogle.datacatalog.entries

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringOutput only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.
bigqueryDateShardedSpecobjectOutput only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). (id: GoogleCloudDatacatalogV1BigQueryDateShardedSpec)
bigqueryTableSpecobjectOutput only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type. (id: GoogleCloudDatacatalogV1BigQueryTableSpec)
businessContextobjectBusiness Context of the entry. Not supported for BigQuery datasets (id: GoogleCloudDatacatalogV1BusinessContext)
cloudBigtableSystemSpecobjectSpecification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE (id: GoogleCloudDatacatalogV1CloudBigtableSystemSpec)
dataSourceobjectOutput only. Physical location of the entry. (id: GoogleCloudDatacatalogV1DataSource)
dataSourceConnectionSpecobjectSpecification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. (id: GoogleCloudDatacatalogV1DataSourceConnectionSpec)
databaseTableSpecobjectSpecification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type. (id: GoogleCloudDatacatalogV1DatabaseTableSpec)
datasetSpecobjectSpecification that applies to a dataset. (id: GoogleCloudDatacatalogV1DatasetSpec)
descriptionstringEntry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
displayNamestringDisplay name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
featureOnlineStoreSpecobjectFeatureonlineStore spec for Vertex AI Feature Store. (id: GoogleCloudDatacatalogV1FeatureOnlineStoreSpec)
filesetSpecobjectSpecification that applies to a fileset resource. Valid only for entries with the FILESET type. (id: GoogleCloudDatacatalogV1FilesetSpec)
fullyQualifiedNamestringFully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
gcsFilesetSpecobjectSpecification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type. (id: GoogleCloudDatacatalogV1GcsFilesetSpec)
integratedSystemstringOutput only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
labelsobjectCloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
linkedResourcestringThe resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the linked_resource for a table resource from BigQuery is: //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID} Output only when the entry is one of the types in the EntryType enum. For entries with a user_specified_type, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.
lookerSystemSpecobjectSpecification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER (id: GoogleCloudDatacatalogV1LookerSystemSpec)
modelSpecobjectModel specification. (id: GoogleCloudDatacatalogV1ModelSpec)
personalDetailsobjectOutput only. Additional information related to the entry. Private to the current user. (id: GoogleCloudDatacatalogV1PersonalDetails)
routineSpecobjectSpecification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type. (id: GoogleCloudDatacatalogV1RoutineSpec)
schemaobjectSchema of the entry. An entry might not have any schema attached to it. (id: GoogleCloudDatacatalogV1Schema)
serviceSpecobjectSpecification that applies to a Service resource. (id: GoogleCloudDatacatalogV1ServiceSpec)
sourceSystemTimestampsobjectTimestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp. (id: GoogleCloudDatacatalogV1SystemTimestamps)
sqlDatabaseSystemSpecobjectSpecification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE (id: GoogleCloudDatacatalogV1SqlDatabaseSystemSpec)
typestringThe type of the entry. For details, see EntryType.
usageSignalobjectResource usage statistics. (id: GoogleCloudDatacatalogV1UsageSignal)
userSpecifiedSystemstringIndicates the entry's source system that Data Catalog doesn't automatically integrate with. The user_specified_system string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.
userSpecifiedTypestringCustom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type. The user_specified_type string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_entry_groups_entries_getselectprojectsId, locationsId, entryGroupsId, entriesIdGets an entry.
projects_locations_entry_groups_entries_listselectprojectsId, locationsId, entryGroupsIdpageSize, pageToken, readMaskLists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.
projects_locations_entry_groups_entries_createinsertprojectsId, locationsId, entryGroupsIdentryIdCreates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries.
projects_locations_entry_groups_entries_patchupdateprojectsId, locationsId, entryGroupsId, entriesIdupdateMaskUpdates an existing entry. You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.
projects_locations_entry_groups_entries_deletedeleteprojectsId, locationsId, entryGroupsId, entriesIdDeletes an existing entry. You can delete only the entries created by the CreateEntry method. 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_entries_modify_entry_overviewexecprojectsId, locationsId, entryGroupsId, entriesIdModifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.
projects_locations_entry_groups_entries_modify_entry_contactsexecprojectsId, locationsId, entryGroupsId, entriesIdModifies contacts, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.
projects_locations_entry_groups_entries_starexecprojectsId, locationsId, entryGroupsId, entriesIdMarks an Entry as starred by the current user. Starring information is private to each user.
projects_locations_entry_groups_entries_unstarexecprojectsId, locationsId, entryGroupsId, entriesIdMarks an Entry as NOT starred by the current user. Starring information is private to each user.
projects_locations_entry_groups_entries_importexecprojectsId, locationsId, entryGroupsIdImports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. ImportEntries returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.
entries_lookupexeclinkedResource, sqlResource, fullyQualifiedName, project, locationGets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.

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.

NameDatatypeDescription
entriesIdstring
entryGroupsIdstring
locationsIdstring
projectsIdstring
entryIdstring
fullyQualifiedNamestring
linkedResourcestring
locationstring
pageSizeinteger (int32)
pageTokenstring
projectstring
readMaskstring (google-fieldmask)
sqlResourcestring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets an entry.

SELECT
name,
bigqueryDateShardedSpec,
bigqueryTableSpec,
businessContext,
cloudBigtableSystemSpec,
dataSource,
dataSourceConnectionSpec,
databaseTableSpec,
datasetSpec,
description,
displayName,
featureOnlineStoreSpec,
filesetSpec,
fullyQualifiedName,
gcsFilesetSpec,
integratedSystem,
labels,
linkedResource,
lookerSystemSpec,
modelSpec,
personalDetails,
routineSpec,
schema,
serviceSpec,
sourceSystemTimestamps,
sqlDatabaseSystemSpec,
type,
usageSignal,
userSpecifiedSystem,
userSpecifiedType
FROM google.datacatalog.entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND entryGroupsId = '{{ entryGroupsId }}' -- required
AND entriesId = '{{ entriesId }}' -- required;

INSERT examples​

Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries.

INSERT INTO google.datacatalog.entries (
data__linkedResource,
data__fullyQualifiedName,
data__type,
data__userSpecifiedType,
data__userSpecifiedSystem,
data__sqlDatabaseSystemSpec,
data__lookerSystemSpec,
data__cloudBigtableSystemSpec,
data__gcsFilesetSpec,
data__databaseTableSpec,
data__dataSourceConnectionSpec,
data__routineSpec,
data__datasetSpec,
data__filesetSpec,
data__serviceSpec,
data__modelSpec,
data__featureOnlineStoreSpec,
data__displayName,
data__description,
data__businessContext,
data__schema,
data__sourceSystemTimestamps,
data__usageSignal,
data__labels,
projectsId,
locationsId,
entryGroupsId,
entryId
)
SELECT 
'{{ linkedResource }}',
'{{ fullyQualifiedName }}',
'{{ type }}',
'{{ userSpecifiedType }}',
'{{ userSpecifiedSystem }}',
'{{ sqlDatabaseSystemSpec }}',
'{{ lookerSystemSpec }}',
'{{ cloudBigtableSystemSpec }}',
'{{ gcsFilesetSpec }}',
'{{ databaseTableSpec }}',
'{{ dataSourceConnectionSpec }}',
'{{ routineSpec }}',
'{{ datasetSpec }}',
'{{ filesetSpec }}',
'{{ serviceSpec }}',
'{{ modelSpec }}',
'{{ featureOnlineStoreSpec }}',
'{{ displayName }}',
'{{ description }}',
'{{ businessContext }}',
'{{ schema }}',
'{{ sourceSystemTimestamps }}',
'{{ usageSignal }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ entryGroupsId }}',
'{{ entryId }}'
RETURNING
name,
bigqueryDateShardedSpec,
bigqueryTableSpec,
businessContext,
cloudBigtableSystemSpec,
dataSource,
dataSourceConnectionSpec,
databaseTableSpec,
datasetSpec,
description,
displayName,
featureOnlineStoreSpec,
filesetSpec,
fullyQualifiedName,
gcsFilesetSpec,
integratedSystem,
labels,
linkedResource,
lookerSystemSpec,
modelSpec,
personalDetails,
routineSpec,
schema,
serviceSpec,
sourceSystemTimestamps,
sqlDatabaseSystemSpec,
type,
usageSignal,
userSpecifiedSystem,
userSpecifiedType
;

UPDATE examples​

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

UPDATE google.datacatalog.entries
SET 
data__linkedResource = '{{ linkedResource }}',
data__fullyQualifiedName = '{{ fullyQualifiedName }}',
data__type = '{{ type }}',
data__userSpecifiedType = '{{ userSpecifiedType }}',
data__userSpecifiedSystem = '{{ userSpecifiedSystem }}',
data__sqlDatabaseSystemSpec = '{{ sqlDatabaseSystemSpec }}',
data__lookerSystemSpec = '{{ lookerSystemSpec }}',
data__cloudBigtableSystemSpec = '{{ cloudBigtableSystemSpec }}',
data__gcsFilesetSpec = '{{ gcsFilesetSpec }}',
data__databaseTableSpec = '{{ databaseTableSpec }}',
data__dataSourceConnectionSpec = '{{ dataSourceConnectionSpec }}',
data__routineSpec = '{{ routineSpec }}',
data__datasetSpec = '{{ datasetSpec }}',
data__filesetSpec = '{{ filesetSpec }}',
data__serviceSpec = '{{ serviceSpec }}',
data__modelSpec = '{{ modelSpec }}',
data__featureOnlineStoreSpec = '{{ featureOnlineStoreSpec }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__businessContext = '{{ businessContext }}',
data__schema = '{{ schema }}',
data__sourceSystemTimestamps = '{{ sourceSystemTimestamps }}',
data__usageSignal = '{{ usageSignal }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND entriesId = '{{ entriesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryDateShardedSpec,
bigqueryTableSpec,
businessContext,
cloudBigtableSystemSpec,
dataSource,
dataSourceConnectionSpec,
databaseTableSpec,
datasetSpec,
description,
displayName,
featureOnlineStoreSpec,
filesetSpec,
fullyQualifiedName,
gcsFilesetSpec,
integratedSystem,
labels,
linkedResource,
lookerSystemSpec,
modelSpec,
personalDetails,
routineSpec,
schema,
serviceSpec,
sourceSystemTimestamps,
sqlDatabaseSystemSpec,
type,
usageSignal,
userSpecifiedSystem,
userSpecifiedType;

DELETE examples​

Deletes an existing entry. You can delete only the entries created by the CreateEntry method. 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.entries
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND entryGroupsId = '{{ entryGroupsId }}' --required
AND entriesId = '{{ entriesId }}' --required;

Lifecycle Methods​

Modifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

EXEC google.datacatalog.entries.projects_locations_entry_groups_entries_modify_entry_overview 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@entryGroupsId='{{ entryGroupsId }}' --required, 
@entriesId='{{ entriesId }}' --required 
@@json=
'{
"entryOverview": "{{ entryOverview }}"
}';