Skip to main content

@swamp/gcp/datacatalog

v2026.04.04.1

Google Cloud datacatalog infrastructure models

Labels

gcpgoogle-clouddatacatalogcloudinfrastructure

Contents

Install

$ swamp extension pull @swamp/gcp/datacatalog

Release Notes

  • Updated: entrygroups_entries, tagtemplates

entrygroups_entries_tags.tsv2026.04.03.3

Global Arguments

ArgumentTypeDescription
column?stringResources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
fields?recordThe value of a tag field with a boolean type.
name?stringIdentifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
template?stringRequired. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a tags
getGet a tags
ArgumentTypeDescription
identifierstringThe name of the tags
updateUpdate tags attributes
deleteDelete the tags
ArgumentTypeDescription
identifierstringThe name of the tags
syncSync tags state from GCP
reconcilereconcile
ArgumentTypeDescription
forceDeleteMissing?any
tagTemplate?any
tags?any
taxonomies_policytags.tsv2026.04.03.3

Global Arguments

ArgumentTypeDescription
description?stringDescription of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
displayName?stringRequired. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
name?stringIdentifier. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
parentPolicyTag?stringResource name of this policy tag\'s parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a policyTags
getGet a policyTags
ArgumentTypeDescription
identifierstringThe name of the policyTags
updateUpdate policyTags attributes
deleteDelete the policyTags
ArgumentTypeDescription
identifierstringThe name of the policyTags
syncSync policyTags state from GCP
entrygroups_entries.tsv2026.04.04.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
bigqueryDateShardedSpec?objectOutput only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`.
bigqueryTableSpec?objectOutput only. The table source type.
businessContext?objectDesignation of the person, for example, Data Steward.
cloudBigtableSystemSpec?objectDisplay name of the Instance. This is user specified and different from the resource name.
dataSource?objectFull name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
dataSourceConnectionSpec?objectDatabase name.
databaseTableSpec?objectName of a singular table this view reflects one to one.
datasetSpec?objectThe number of DataItems in this Dataset. Only apply for non-structured Dataset.
description?stringEntry 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.
displayName?stringDisplay name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
featureOnlineStoreSpec?objectOutput only. Type of underlying storage for the FeatureOnlineStore.
filesetSpec?objectFully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.
fullyQualifiedName?string[Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) 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.
gcsFilesetSpec?objectRequired. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`,... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`
graphSpec?objectRequired. The alias name of the graph element.
labels?recordCloud 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.
lookerSystemSpec?objectName of the parent Looker Instance. Empty if it does not exist.
modelSpec?objectURI of the Docker image to be used as the custom container for serving predictions.
personalDetails?objectSet if the entry is starred; unset otherwise.
routineSpec?objectPaths of the imported libraries.
schema?objectRequired. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.
serviceSpec?objectName of the cluster.
sourceSystemTimestamps?objectCreation timestamp of the resource within the given system.
spannerTableSpec?objectOutput only. The column in the current table that is part of the foreign key.
sqlDatabaseSystemSpec?objectVersion of the database engine.
type?enumThe type of the entry. For details, see [`EntryType`](#entrytype).
usageSignal?objectView count in source system.
userSpecifiedSystem?stringIndicates 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.
userSpecifiedType?stringCustom 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.
entryId?stringRequired. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a entries
getGet a entries
ArgumentTypeDescription
identifierstringThe name of the entries
updateUpdate entries attributes
deleteDelete the entries
ArgumentTypeDescription
identifierstringThe name of the entries
syncSync entries state from GCP
importimport
ArgumentTypeDescription
gcsBucketPath?any
jobId?any
modify_entry_contactsmodify entry contacts
ArgumentTypeDescription
contacts?any
modify_entry_overviewmodify entry overview
ArgumentTypeDescription
entryOverview?any
starstar
unstarunstar
entrygroups_tags.tsv2026.04.03.3

Global Arguments

ArgumentTypeDescription
column?stringResources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
fields?recordThe value of a tag field with a boolean type.
name?stringIdentifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
template?stringRequired. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a tags
getGet a tags
ArgumentTypeDescription
identifierstringThe name of the tags
updateUpdate tags attributes
deleteDelete the tags
ArgumentTypeDescription
identifierstringThe name of the tags
syncSync tags state from GCP
taxonomies.tsv2026.04.03.3

Global Arguments

ArgumentTypeDescription
activatedPolicyTypes?arrayOptional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
description?stringOptional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
displayName?stringRequired. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
name?stringIdentifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
service?objectThe service agent for the service.
taxonomyTimestamps?objectCreation timestamp of the resource within the given system.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a taxonomies
getGet a taxonomies
ArgumentTypeDescription
identifierstringThe name of the taxonomies
updateUpdate taxonomies attributes
deleteDelete the taxonomies
ArgumentTypeDescription
identifierstringThe name of the taxonomies
syncSync taxonomies state from GCP
exportexport
importimport
ArgumentTypeDescription
crossRegionalSource?any
inlineSource?any
replacereplace
ArgumentTypeDescription
serializedTaxonomy?any
entrygroups.tsv2026.04.03.3

Global Arguments

ArgumentTypeDescription
dataCatalogTimestamps?objectCreation timestamp of the resource within the given system.
description?stringEntry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
displayName?stringA short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
name?stringIdentifier. 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.
transferredToDataplex?booleanOptional. 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.
entryGroupId?stringRequired. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a entryGroups
getGet a entryGroups
ArgumentTypeDescription
identifierstringThe name of the entryGroups
updateUpdate entryGroups attributes
deleteDelete the entryGroups
ArgumentTypeDescription
identifierstringThe name of the entryGroups
syncSync entryGroups state from GCP
tagtemplates.tsv2026.04.04.1

Global Arguments

ArgumentTypeDescription
dataplexTransferStatus?enumOptional. Transfer status of the TagTemplate
displayName?stringDisplay name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces (), and can't start or end with spaces. The maximum length is 200 characters.
fields?recordThe description for this field. Defaults to an empty string.
isPubliclyReadable?booleanIndicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
name?stringIdentifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
tagTemplateId?stringRequired. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a tagTemplates
getGet a tagTemplates
ArgumentTypeDescription
identifierstringThe name of the tagTemplates
updateUpdate tagTemplates attributes
deleteDelete the tagTemplates
ArgumentTypeDescription
identifierstringThe name of the tagTemplates
syncSync tagTemplates state from GCP