dataplex

v2026.04.04.2

Google Cloud dataplex infrastructure models

Platforms

linux-x86_64 linux-aarch64 darwin-x86_64 darwin-aarch64

Labels

gcpgoogle-clouddataplexcloudinfrastructure

models

Install

$ swamp extension pull @swamp/gcp/dataplex

Release Notes

Updated: locations, datascans, datascans_jobs

@swamp/gcp/dataplex/aspecttypesv2026.04.03.3aspecttypes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
authorization?	object	no	Authorization for an AspectType.
dataClassification?	enum	no	Optional. Immutable. Stores data classification of the aspect.
description?	string	no	Optional. Description of the AspectType.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the AspectType.
metadataTemplate?	object	no	MetadataTemplate definition for an AspectType.
aspectTypeId?	string	no	Required. AspectType identifier.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a aspectTypes

getGet a aspectTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the aspectTypes

updateUpdate aspectTypes attributes

deleteDelete the aspectTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the aspectTypes

syncSync aspectTypes state from GCP

Resources

state(infinite)— AspectType is a template for creating Aspects, and represents the JSON-schema...

@swamp/gcp/dataplex/dataattributebindingsv2026.04.03.3dataattributebindings.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
attributes?	array	no	Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description?	string	no	Optional. Description of the DataAttributeBinding.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the DataAttributeBinding.
paths?	array	no	Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
resource?	string	no	Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
dataAttributeBindingId?	string	no	Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a dataAttributeBindings

getGet a dataAttributeBindings

Argument	Type	Required	Description
identifier	string	yes	The name of the dataAttributeBindings

updateUpdate dataAttributeBindings attributes

deleteDelete the dataAttributeBindings

Argument	Type	Required	Description
identifier	string	yes	The name of the dataAttributeBindings

syncSync dataAttributeBindings state from GCP

Resources

state(infinite)— DataAttributeBinding represents binding of attributes to resources. Eg: Bind ...

@swamp/gcp/dataplex/dataproductsv2026.04.03.3dataproducts.ts

Global Arguments

Argument	Type	Required	Description
accessGroups?	record	no	Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } }
description?	string	no	Optional. Description of the data product.
displayName?	string	no	Required. User-friendly display name of the data product.
icon?	string	no	Optional. Base64 encoded image representing the data product. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
labels?	record	no	Optional. User-defined labels for the data product.Example: { "environment": "production", "billing": "marketing-department" }
name?	string	no	Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.
ownerEmails?	array	no	Required. Emails of the data product owners.
dataProductId?	string	no	Optional. The ID of the data product to create.The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$ If not provided, a system generated ID will be used.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a dataProducts

getGet a dataProducts

Argument	Type	Required	Description
identifier	string	yes	The name of the dataProducts

updateUpdate dataProducts attributes

deleteDelete the dataProducts

Argument	Type	Required	Description
identifier	string	yes	The name of the dataProducts

syncSync dataProducts state from GCP

Resources

state(infinite)— A data product is a curated collection of data assets, packaged to address sp...

@swamp/gcp/dataplex/dataproducts-dataassetsv2026.04.03.3dataproducts_dataassets.ts

Global Arguments

Argument	Type	Required	Description
accessGroupConfigs?	record	no	Optional. Access groups configurations for this data asset.The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig.Example: { "analyst": { "iamRoles": ["roles/bigquery.dataViewer"] } } Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.
labels?	record	no	Optional. User-defined labels for the data asset.Example: { "environment": "production", "billing": "marketing-department" }
name?	string	no	Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
resource?	string	no	Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported. Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.
dataAssetId?	string	no	Optional. The ID of the data asset to create.The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$ If not provided, a system generated ID will be used.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a dataAssets

getGet a dataAssets

Argument	Type	Required	Description
identifier	string	yes	The name of the dataAssets

updateUpdate dataAssets attributes

deleteDelete the dataAssets

Argument	Type	Required	Description
identifier	string	yes	The name of the dataAssets

syncSync dataAssets state from GCP

Resources

state(infinite)— Represents a data asset resource that can be packaged and shared via a data p...

@swamp/gcp/dataplex/datascansv2026.04.04.2datascans.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
data?	object	no	The data source for DataScan.
dataDiscoveryResult?	object	no	The output of a data discovery scan.
dataDiscoverySpec?	object	no	Spec for a data discovery scan.
dataDocumentationResult?	object	no	The output of a DataDocumentation scan.
dataDocumentationSpec?	object	no	DataDocumentation scan related spec.
dataProfileResult?	object	no	DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.
dataProfileSpec?	object	no	DataProfileScan related setting.
dataQualityResult?	object	no	The output of a DataQualityScan.
dataQualitySpec?	object	no	DataQualityScan related setting.
description?	string	no	Optional. Description of the scan. Must be between 1-1024 characters.
displayName?	string	no	Optional. User friendly display name. Must be between 1-256 characters.
executionIdentity?	object	no	The identity to run the datascan.
executionSpec?	object	no	DataScan execution settings.
executionStatus?	object	no	Status of the data scan execution.
labels?	record	no	Optional. User-defined labels for the scan.
dataScanId?	string	no	Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a dataScans

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

getGet a dataScans

Argument	Type	Required	Description
identifier	string	yes	The name of the dataScans

updateUpdate dataScans attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

deleteDelete the dataScans

Argument	Type	Required	Description
identifier	string	yes	The name of the dataScans

syncSync dataScans state from GCP

generate_data_quality_rulesgenerate data quality rules

runrun

Resources

state(infinite)— Represents a user-visible job which provides the insights for the related dat...

@swamp/gcp/dataplex/datascans-jobsv2026.04.04.2datascans_jobs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

getGet a jobs

Argument	Type	Required	Description
identifier	string	yes	The name of the jobs

syncSync jobs state from GCP

generate_data_quality_rulesgenerate data quality rules

Resources

state(infinite)— A DataScanJob represents an instance of DataScan execution.

@swamp/gcp/dataplex/datataxonomiesv2026.04.03.3datataxonomies.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. Description of the DataTaxonomy.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the DataTaxonomy.
dataTaxonomyId?	string	no	Required. DataTaxonomy identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Project.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a dataTaxonomies

getGet a dataTaxonomies

Argument	Type	Required	Description
identifier	string	yes	The name of the dataTaxonomies

updateUpdate dataTaxonomies attributes

deleteDelete the dataTaxonomies

Argument	Type	Required	Description
identifier	string	yes	The name of the dataTaxonomies

syncSync dataTaxonomies state from GCP

Resources

state(infinite)— DataTaxonomy represents a set of hierarchical DataAttributes resources, group...

@swamp/gcp/dataplex/datataxonomies-attributesv2026.04.03.3datataxonomies_attributes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
dataAccessSpec?	object	no	DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.
description?	string	no	Optional. Description of the DataAttribute.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the DataAttribute.
parentId?	string	no	Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
resourceAccessSpec?	object	no	ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.
dataAttributeId?	string	no	Required. DataAttribute identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the DataTaxonomy.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a attributes

getGet a attributes

Argument	Type	Required	Description
identifier	string	yes	The name of the attributes

updateUpdate attributes attributes

deleteDelete the attributes

Argument	Type	Required	Description
identifier	string	yes	The name of the attributes

syncSync attributes state from GCP

Resources

state(infinite)— Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute ...

@swamp/gcp/dataplex/encryptionconfigsv2026.04.03.3encryptionconfigs.ts

Global Arguments

Argument	Type	Required	Description
enableMetastoreEncryption?	boolean	no	Optional. Represent the state of CMEK opt-in for metastore.
failureDetails?	object	no	Details of the failure if anything related to Cmek db fails.
key?	string	no	Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.
name?	string	no	Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
encryptionConfigId?	string	no	Required. The ID of the EncryptionConfig to create. Currently, only a value of "default" is supported.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

createCreate a encryptionConfigs

getGet a encryptionConfigs

Argument	Type	Required	Description
identifier	string	yes	The name of the encryptionConfigs

updateUpdate encryptionConfigs attributes

deleteDelete the encryptionConfigs

Argument	Type	Required	Description
identifier	string	yes	The name of the encryptionConfigs

syncSync encryptionConfigs state from GCP

Resources

state(infinite)— A Resource designed to manage encryption configurations for customers to supp...

@swamp/gcp/dataplex/entrygroupsv2026.04.03.3entrygroups.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. Description of the EntryGroup.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the EntryGroup.
entryGroupId?	string	no	Required. EntryGroup identifier.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a entryGroups

getGet a entryGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the entryGroups

updateUpdate entryGroups attributes

deleteDelete the entryGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the entryGroups

syncSync entryGroups state from GCP

Resources

state(infinite)— An Entry Group represents a logical grouping of one or more Entries.

@swamp/gcp/dataplex/entrygroups-entriesv2026.04.03.3entrygroups_entries.ts

Global Arguments

Argument	Type	Required	Description
aspects?	record	no	Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
entrySource?	object	no	Information related to the source system of the data resource that is represented by the entry.
entryType?	string	no	Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
fullyQualifiedName?	string	no	Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
name?	string	no	Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
parentEntry?	string	no	Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
entryId?	string	no	Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a r
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a entries

getGet a entries

Argument	Type	Required	Description
identifier	string	yes	The name of the entries

updateUpdate entries attributes

deleteDelete the entries

Argument	Type	Required	Description
identifier	string	yes	The name of the entries

syncSync entries state from GCP

Resources

state(infinite)— An entry is a representation of a data resource that can be described by vari...

@swamp/gcp/dataplex/entrygroups-entrylinksv2026.04.03.3entrygroups_entrylinks.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
aspects?	record	no	Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
entryLinkType?	string	no	Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
entryReferences?	array	no	Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
entryLinkId?	string	no	Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a entryLinks

getGet a entryLinks

Argument	Type	Required	Description
identifier	string	yes	The name of the entryLinks

updateUpdate entryLinks attributes

deleteDelete the entryLinks

Argument	Type	Required	Description
identifier	string	yes	The name of the entryLinks

syncSync entryLinks state from GCP

Resources

state(infinite)— EntryLink represents a link between two Entries.

@swamp/gcp/dataplex/entrytypesv2026.04.03.3entrytypes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
authorization?	object	no	Authorization for an Entry Type.
description?	string	no	Optional. Description of the EntryType.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the EntryType.
platform?	string	no	Optional. The platform that Entries of this type belongs to.
requiredAspects?	array	no	AspectInfo for the entry type.
system?	string	no	Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
typeAliases?	array	no	Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
entryTypeId?	string	no	Required. EntryType identifier.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a entryTypes

getGet a entryTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the entryTypes

updateUpdate entryTypes attributes

deleteDelete the entryTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the entryTypes

syncSync entryTypes state from GCP

Resources

state(infinite)— Entry Type is a template for creating Entries.

@swamp/gcp/dataplex/glossariesv2026.04.03.3glossaries.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. The user-mutable description of the Glossary.
displayName?	string	no	Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
labels?	record	no	Optional. User-defined labels for the Glossary.
glossaryId?	string	no	Required. Glossary ID: Glossary identifier.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a glossaries

getGet a glossaries

Argument	Type	Required	Description
identifier	string	yes	The name of the glossaries

updateUpdate glossaries attributes

deleteDelete the glossaries

Argument	Type	Required	Description
identifier	string	yes	The name of the glossaries

syncSync glossaries state from GCP

Resources

state(infinite)— A Glossary represents a collection of GlossaryCategories and GlossaryTerms de...

@swamp/gcp/dataplex/glossaries-categoriesv2026.04.03.3glossaries_categories.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. The user-mutable description of the GlossaryCategory.
displayName?	string	no	Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
labels?	record	no	Optional. User-defined labels for the GlossaryCategory.
parent?	string	no	Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
categoryId?	string	no	Required. GlossaryCategory identifier.

createCreate a categories

getGet a categories

Argument	Type	Required	Description
identifier	string	yes	The name of the categories

updateUpdate categories attributes

deleteDelete the categories

Argument	Type	Required	Description
identifier	string	yes	The name of the categories

syncSync categories state from GCP

Resources

state(infinite)— A GlossaryCategory represents a collection of GlossaryCategories and Glossary...

@swamp/gcp/dataplex/glossaries-termsv2026.04.03.3glossaries_terms.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. The user-mutable description of the GlossaryTerm.
displayName?	string	no	Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
labels?	record	no	Optional. User-defined labels for the GlossaryTerm.
parent?	string	no	Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
termId?	string	no	Required. GlossaryTerm identifier.

createCreate a terms

getGet a terms

Argument	Type	Required	Description
identifier	string	yes	The name of the terms

updateUpdate terms attributes

deleteDelete the terms

Argument	Type	Required	Description
identifier	string	yes	The name of the terms

syncSync terms state from GCP

Resources

state(infinite)— GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text desc...

@swamp/gcp/dataplex/lakesv2026.04.03.3lakes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
assetStatus?	object	no	Aggregated status of the underlying assets of a lake or zone.
description?	string	no	Optional. Description of the lake.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User-defined labels for the lake.
metastore?	object	no	Settings to manage association of Dataproc Metastore with a lake.
metastoreStatus?	object	no	Status of Lake and Dataproc Metastore service instance association.
lakeId?	string	no	Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a lakes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

getGet a lakes

Argument	Type	Required	Description
identifier	string	yes	The name of the lakes

updateUpdate lakes attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

deleteDelete the lakes

Argument	Type	Required	Description
identifier	string	yes	The name of the lakes

syncSync lakes state from GCP

Resources

state(infinite)— A lake is a centralized repository for managing enterprise data across the or...

@swamp/gcp/dataplex/lakes-actionsv2026.04.03.3lakes_actions.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

getGet a actions

Argument	Type	Required	Description
identifier	string	yes	The name of the actions

syncSync actions state from GCP

Resources

state(infinite)— Action represents an issue requiring administrator action for resolution.

@swamp/gcp/dataplex/lakes-assetsv2026.04.03.3lakes_assets.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. Description of the asset.
discoverySpec?	object	no	Settings to manage the metadata discovery and publishing for an asset.
discoveryStatus?	object	no	Status of discovery for an asset.
displayName?	string	no	Optional. User friendly display name.
labels?	record	no	Optional. User defined labels for the asset.
resourceSpec?	object	no	Identifies the cloud resource that is referenced by this asset.
resourceStatus?	object	no	Status of the resource referenced by an asset.
securityStatus?	object	no	Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.
assetId?	string	no	Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the zone.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a assets

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

getGet a assets

Argument	Type	Required	Description
identifier	string	yes	The name of the assets

updateUpdate assets attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

deleteDelete the assets

Argument	Type	Required	Description
identifier	string	yes	The name of the assets

syncSync assets state from GCP

Resources

state(infinite)— An asset represents a cloud resource that is being managed within a lake as a...

@swamp/gcp/dataplex/lakes-assets-actionsv2026.04.03.3lakes_assets_actions.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

getGet a actions

Argument	Type	Required	Description
identifier	string	yes	The name of the actions

syncSync actions state from GCP

Resources

state(infinite)— Action represents an issue requiring administrator action for resolution.

@swamp/gcp/dataplex/lakes-entitiesv2026.04.03.3lakes_entities.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
access?	object	no	Describes the access mechanism of the data within its storage location.
asset?	string	no	Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
compatibility?	object	no	Provides compatibility information for various metadata stores.
dataPath?	string	no	Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
dataPathPattern?	string	no	Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/*/.csv.
description?	string	no	Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
displayName?	string	no	Optional. Display name must be shorter than or equal to 256 characters.
format?	object	no	Describes the format of the data within its storage location.
id?	string	no	Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
schema?	object	no	Schema information describing the structure and layout of the data.
system?	enum	no	Required. Immutable. Identifies the storage system of the entity data.
type?	enum	no	Required. Immutable. The type of entity.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a entities

getGet a entities

Argument	Type	Required	Description
identifier	string	yes	The name of the entities

updateUpdate entities attributes

deleteDelete the entities

Argument	Type	Required	Description
identifier	string	yes	The name of the entities

syncSync entities state from GCP

Resources

state(infinite)— Represents tables and fileset metadata contained within a zone.

@swamp/gcp/dataplex/lakes-entities-partitionsv2026.04.03.3lakes_entities_partitions.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
values?	array	no	Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.

createCreate a partitions

getGet a partitions

Argument	Type	Required	Description
identifier	string	yes	The name of the partitions

deleteDelete the partitions

Argument	Type	Required	Description
identifier	string	yes	The name of the partitions

syncSync partitions state from GCP

Resources

state(infinite)— Represents partition metadata contained within entity instances.

@swamp/gcp/dataplex/lakes-tasksv2026.04.03.3lakes_tasks.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Optional. Description of the task.
displayName?	string	no	Optional. User friendly display name.
executionSpec?	object	no	Execution related settings, like retry and service_account.
executionStatus?	object	no	Status of the task execution (e.g. Jobs).
labels?	record	no	Optional. User-defined labels for the task.
notebook?	object	no	Config for running scheduled notebooks.
spark?	object	no	User-specified config for running a Spark task.
triggerSpec?	object	no	Task scheduling and trigger settings.
taskId?	string	no	Required. Task identifier.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a tasks

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

getGet a tasks

Argument	Type	Required	Description
identifier	string	yes	The name of the tasks

updateUpdate tasks attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

deleteDelete the tasks

Argument	Type	Required	Description
identifier	string	yes	The name of the tasks

syncSync tasks state from GCP

runrun

Argument	Type	Required	Description
args?	any	no
labels?	any	no

Resources

state(infinite)— A task represents a user-visible job.

@swamp/gcp/dataplex/lakes-tasks-jobsv2026.04.03.3lakes_tasks_jobs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

getGet a jobs

Argument	Type	Required	Description
identifier	string	yes	The name of the jobs

syncSync jobs state from GCP

cancelcancel

Resources

state(infinite)— A job represents an instance of a task.

@swamp/gcp/dataplex/locationsv2026.04.04.1locations.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

getGet a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

syncSync locations state from GCP

lookup_contextlookup context

Argument	Type	Required	Description
options?	any	no
resources?	any	no

lookup_entrylookup entry

lookup_entry_linkslookup entry links

modify_entrymodify entry

Argument	Type	Required
aspectKeys?	any	no
deleteMissingAspects?	any	no
entry?	any	no
updateMask?	any	no

search_entriessearch entries

Resources

state(infinite)— A resource that represents a Google Cloud location.

@swamp/gcp/dataplex/metadatafeedsv2026.04.03.3metadatafeeds.ts

Global Arguments

Argument	Type	Required	Description
filters?	object	no	Filters defines the type of changes that you want to listen to. You can have multiple entry type filters and multiple aspect type filters. All of the entry type filters are OR'ed together. All of the aspect type filters are OR'ed together. All of the entry type filters and aspect type filters are AND'ed together.
labels?	record	no	Optional. User-defined labels.
name?	string	no	Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.
pubsubTopic?	string	no	Optional. The pubsub topic that you want the metadata feed messages to publish to. Please grant Dataplex service account the permission to publish messages to the topic. The service account is: service-{PROJECT_NUMBER}@gcp-sa-dataplex.iam.gserviceaccount.com.
scope?	object	no	Scope defines the scope of the metadata feed. Scopes are exclusive. Only one of the scopes can be specified.
metadataFeedId?	string	no	Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a metadataFeeds

getGet a metadataFeeds

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataFeeds

updateUpdate metadataFeeds attributes

deleteDelete the metadataFeeds

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataFeeds

syncSync metadataFeeds state from GCP

Resources

state(infinite)— MetadataFeed contains information related to the metadata feed.

@swamp/gcp/dataplex/metadatajobsv2026.04.03.3metadatajobs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
exportResult?	object	no	Summary results from a metadata export job. The results are a snapshot of the metadata at the time when the job was created. The exported entries are saved to a Cloud Storage bucket.
exportSpec?	object	no	Job specification for a metadata export job.
importResult?	object	no	Results from a metadata import job.
importSpec?	object	no	Job specification for a metadata import job.You can run the following kinds of metadata import jobs: Full sync of entries with incremental import of their aspects. Supported for custom entries. Incremental import of aspects only. Supported for aspects that belong to custom entries and system entries. For custom entries, you can modify both optional aspects and required aspects. For system entries, you can modify optional aspects.
labels?	record	no	Optional. User-defined labels.
status?	object	no	Metadata job status.
type?	enum	no	Required. Metadata job type.
metadataJobId?	string	no	Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

createCreate a metadataJobs

getGet a metadataJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataJobs

syncSync metadataJobs state from GCP

cancelcancel

Resources

state(infinite)— A metadata job resource.

2026.04.04.1147.8 KBApr 4, 2026

Google Cloud dataplex infrastructure models

Release Notes

Updated: datascans, datascans_jobs

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

gcpgoogle-clouddataplexcloudinfrastructure

2026.04.03.3150.8 KBApr 3, 2026

Google Cloud dataplex infrastructure models

Release Notes

Updated: encryptionconfigs, locations, aspecttypes, dataattributebindings, dataproducts, dataproducts_dataassets, datascans, datascans_jobs, datataxonomies, datataxonomies_attributes, entrygroups, entrygroups_entries, entrygroups_entrylinks, entrytypes, glossaries, glossaries_categories, glossaries_terms, lakes, lakes_actions, lakes_tasks, lakes_tasks_jobs, lakes_assets, lakes_assets_actions, lakes_entities, lakes_entities_partitions, metadatafeeds, metadatajobs

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

gcpgoogle-clouddataplexcloudinfrastructure

2026.04.03.1149.1 KBApr 3, 2026

Google Cloud dataplex infrastructure models

Release Notes

Updated: encryptionconfigs, locations, aspecttypes, dataattributebindings, dataproducts, dataproducts_dataassets, datascans, datascans_jobs, datataxonomies, datataxonomies_attributes, entrygroups, entrygroups_entries, entrygroups_entrylinks, entrytypes, glossaries, glossaries_categories, glossaries_terms, lakes, lakes_actions, lakes_tasks, lakes_tasks_jobs, lakes_assets, lakes_assets_actions, lakes_entities, lakes_entities_partitions, metadatafeeds, metadatajobs

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

gcpgoogle-clouddataplexcloudinfrastructure

2026.04.02.2149.0 KBApr 2, 2026

Google Cloud dataplex infrastructure models

Release Notes

Updated: datascans, datascans_jobs

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

gcpgoogle-clouddataplexcloudinfrastructure

2026.03.27.1147.8 KBMar 27, 2026

Google Cloud dataplex infrastructure models

Release Notes

Added: encryptionconfigs, locations, aspecttypes, dataattributebindings, dataproducts, dataproducts_dataassets, datascans, datascans_jobs, datataxonomies, datataxonomies_attributes, entrygroups, entrygroups_entries, entrygroups_entrylinks, entrytypes, glossaries, glossaries_categories, glossaries_terms, lakes, lakes_actions, lakes_tasks, lakes_tasks_jobs, lakes_assets, lakes_assets_actions, lakes_entities, lakes_entities_partitions, metadatafeeds, metadatajobs

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

gcpgoogle-clouddataplexcloudinfrastructure

@swamp/gcp/dataplex

Platforms

Labels

Contents

Install

Release Notes

Models27

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Previous Versions5

Release Notes

Release Notes

Release Notes

Release Notes

Release Notes