Skip to main content
← back to extensions

Gcp/dataplex

@swamp/gcp/dataplexv2026.07.21.4· 5d agoMODELS
01README

Google Cloud dataplex infrastructure models

02Release Notes
  • Added: changerequests, datadomains, datadomains_bindings
  • Updated: locations, dataproducts, datascans, datascans_jobs
03Models30
aspecttypes.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
authorization?objectImmutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types.
dataClassification?enumOptional. Immutable. Stores data classification of the aspect.
description?stringOptional. Description of the AspectType.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the AspectType.
metadataTemplate?objectOptional. Marks a field as deprecated. You can include a deprecation message.
aspectTypeId?stringRequired. AspectType identifier.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a aspectTypes
fn get(identifier: string)
Get a aspectTypes
ArgumentTypeDescription
identifierstringThe name of the aspectTypes
fn update(identifier?: string)
Update aspectTypes attributes
ArgumentTypeDescription
identifier?stringTarget a specific aspectTypes by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the aspectTypes
ArgumentTypeDescription
identifierstringThe name of the aspectTypes
fn sync(identifier?: string)
Sync aspectTypes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific aspectTypes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List aspectTypes resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions.
orderBy?stringOptional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.
pageSize?numberOptional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
changerequests.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
approver?stringOutput only. The email address of the user who approved/rejected the ChangeRequest.
author?stringOutput only. The email address of the user who created the ChangeRequest.
changeType?enumOutput only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
createEntry?objectThe time the aspect was created in the source system.
createEntryLink?objectThe time the aspect was created in the source system.
createGlossary?objectOutput only. The number of GlossaryCategories in the Glossary.
createGlossaryCategory?objectOutput only. The time at which the GlossaryCategory was created.
createGlossaryTerm?objectRequired. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
createTime?stringOutput only. The time when the ChangeRequest was created.
dataProductAccessRequest?objectOutput only. The display name of the access group defined in the Data Product for which access is being requested.
deleteEntry?objectRequired. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
deleteEntryLink?objectRequired. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
deleteGlossary?objectOptional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
deleteGlossaryCategory?objectRequired. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
deleteGlossaryTerm?objectRequired. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
etag?stringOptional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
justification?stringOptional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
labels?recordOptional. User-defined labels for the ChangeRequest.
name?stringIdentifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
rejectionComment?stringOutput only. The reason provided for rejecting the ChangeRequest.
resource?stringOutput only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
state?enumOutput only. The current state of the ChangeRequest.
uid?stringOutput only. System generated globally unique ID for the ChangeRequest.
updateEntry?objectOptional. If set to true and the entry doesn't exist, the service will create it.
updateGlossary?objectOutput only. The number of GlossaryCategories in the Glossary.
updateGlossaryCategory?objectOutput only. The time at which the GlossaryCategory was created.
updateGlossaryTerm?objectOutput only. The time at which the GlossaryTerm was created.
updateTime?stringOutput only. The time when the ChangeRequest was last updated.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a changeRequests
ArgumentTypeDescription
identifierstringThe name of the changeRequests
fn update(identifier?: string)
Update changeRequests attributes
ArgumentTypeDescription
identifier?stringTarget a specific changeRequests by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the changeRequests
ArgumentTypeDescription
identifierstringThe name of the changeRequests
fn sync(identifier?: string)
Sync changeRequests state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific changeRequests by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List changeRequests resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Supports filtering by: state, author, resource, create_time, update_time.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of ChangeRequests to return. The service may return fewer.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn approve(etag?: any)
approve
ArgumentTypeDescription
etag?any
fn get_iam_policy()
get iam policy
fn reject(comment?: any, etag?: any)
reject
ArgumentTypeDescription
comment?any
etag?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
dataattributebindings.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
attributes?arrayOptional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
description?stringOptional. Description of the DataAttributeBinding.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the DataAttributeBinding.
paths?arrayOptional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
resource?stringOptional. 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?stringRequired. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a dataAttributeBindings
fn get(identifier: string)
Get a dataAttributeBindings
ArgumentTypeDescription
identifierstringThe name of the dataAttributeBindings
fn update(identifier?: string)
Update dataAttributeBindings attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataAttributeBindings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the dataAttributeBindings
ArgumentTypeDescription
identifierstringThe name of the dataAttributeBindings
fn sync(identifier?: string)
Sync dataAttributeBindings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataAttributeBindings by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataAttributeBindings resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name"
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
datadomains.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
contacts?objectOptional. Email ID or freeform ID of the Contact person.
description?stringOptional. User-provided description of the DataDomain.
displayName?stringRequired. User-friendly display name.
labels?recordOptional. User-defined labels for the DataDomain.
name?stringIdentifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id}
parentDataDomain?stringOptional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation.
dataDomainId?stringRequired. DataDomain 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 and location.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a dataDomains
fn get(identifier: string)
Get a dataDomains
ArgumentTypeDescription
identifierstringThe name of the dataDomains
fn update(identifier?: string)
Update dataDomains attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataDomains by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the dataDomains
ArgumentTypeDescription
identifierstringThe name of the dataDomains
fn sync(identifier?: string)
Sync dataDomains state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataDomains by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataDomains resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Supports filter by parent_data_domain.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of DataDomains to return. The service may return fewer. If unspecified, at most 50 domains will be returned. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
datadomains_bindings.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
name?stringIdentifier. The relative resource name of the DataDomainBinding. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{data_domain_id}/bindings/{binding_id}
resource?stringRequired. Immutable. The full resource name of the Google Cloud resource to be bound (i.e. included together with its contents) to the DataDomain.Format: IAM Full resource name (https://docs.cloud.google.com/iam/docs/full-resource-names) Examples: - GCP Project: //cloudresourcemanager.googleapis.com/projects/{project-id} - BigQuery Dataset: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - BigQuery Table: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id} - Dataplex Data Product: //dataplex.googleapis.com/projects/{project-number}/locations/{location}/dataProducts/{data-product-id}Authorization: the resource to be bound must first grant an IAM role with the resource-specific setIamPolicy permission to the DataDomain. Example: - resource: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - IAM role: with bigquery.datasets.setIamPolicy permission (e.g. roles/owner) - IAM member: principal://dataplex.googleapis.com/projects/{project-number}/name/locations/{location}/dataDomains/{data-domain-id}
dataDomainBindingId?stringOptional. DataDomainBinding 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 parent DataDomain. If not provided, a system-generated UUID will be used.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a bindings
fn get(identifier: string)
Get a bindings
ArgumentTypeDescription
identifierstringThe name of the bindings
fn delete(identifier: string)
Delete the bindings
ArgumentTypeDescription
identifierstringThe name of the bindings
fn sync(identifier?: string)
Sync bindings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific bindings by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List bindings resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of DataDomainBindings to return. The service may return fewer. If unspecified, at most 50 bindings will be returned. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
dataproducts.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
accessApprovalConfig?objectOptional. Specifies the email addresses of users who are potential approvers and are notified when an access request is made for the data product. The maximum number of emails allowed is 10.
accessGroups?recordOptional. Description of the access group.
description?stringOptional. Description of the data product.
displayName?stringRequired. User-friendly display name of the data product.
icon?stringOptional. 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?recordOptional. User-defined labels for the data product.Example: { "environment": "production", "billing": "marketing-department" }
name?stringIdentifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.
ownerEmails?arrayRequired. Emails of the data product owners.
dataProductId?stringOptional. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a dataProducts
fn get(identifier: string)
Get a dataProducts
ArgumentTypeDescription
identifierstringThe name of the dataProducts
fn update(identifier?: string)
Update dataProducts attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataProducts by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the dataProducts
ArgumentTypeDescription
identifierstringThe name of the dataProducts
fn sync(identifier?: string)
Sync dataProducts state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataProducts by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataProducts resources
ArgumentTypeDescription
filter?stringOptional. Filter expression that filters data products listed in the response.Example of using this filter is: display_name="my-data-product"
orderBy?stringOptional. Order by expression that orders data products listed in the response.Supported Order by fields are: name or create_time.If not specified, the ordering is undefined.Ordering by create_time is not supported when listing resources across locations (i.e. when request contains /locations/-).
pageSize?numberOptional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn request_access(changeRequest?: any, validateOnly?: any)
request access
ArgumentTypeDescription
changeRequest?any
validateOnly?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
dataproducts_dataassets.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
accessGroupConfigs?recordOptional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ "roles/bigquery.dataViewer" ]
labels?recordOptional. User-defined labels for the data asset.Example: { "environment": "production", "billing": "marketing-department" }
name?stringIdentifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
resource?stringRequired. 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.tables.get for BigQuery tables.
dataAssetId?stringOptional. 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a dataAssets
fn get(identifier: string)
Get a dataAssets
ArgumentTypeDescription
identifierstringThe name of the dataAssets
fn update(identifier?: string)
Update dataAssets attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataAssets by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the dataAssets
ArgumentTypeDescription
identifierstringThe name of the dataAssets
fn sync(identifier?: string)
Sync dataAssets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataAssets by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataAssets resources
ArgumentTypeDescription
filter?stringOptional. Filter expression that filters data assets listed in the response.
orderBy?stringOptional. Order by expression that orders data assets listed in the response.Supported order_by fields are: name or create_time.If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of data assets to return. The service may return fewer than this value. If unspecified, at most 50 data assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
datascans.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
data?objectImmutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
dataDiscoverySpec?objectOptional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}
dataDocumentationSpec?objectOptional. Whether to publish result to Dataplex Catalog.
dataProfileSpec?objectOptional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.
dataQualitySpec?objectOptional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.
description?stringOptional. Description of the scan. Must be between 1-1024 characters.
displayName?stringOptional. User friendly display name. Must be between 1-256 characters.
executionIdentity?objectOptional. The Dataplex service agent associated with the user's project.
executionSpec?objectImmutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.
labels?recordOptional. User-defined labels for the scan.
unstructuredDataProfileSpec?objectOptional. Customized prompt for unstructured data profile. The field will be used as part of the prompt, could be some instruction, specifying skill, or specific area to focus.
dataScanId?stringOptional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a dataScans
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a dataScans
ArgumentTypeDescription
identifierstringThe name of the dataScans
fn update(identifier?: string, waitForReady?: boolean)
Update dataScans attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataScans by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the dataScans
ArgumentTypeDescription
identifierstringThe name of the dataScans
fn sync(identifier?: string)
Sync dataScans state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataScans by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataScans resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
pageSize?numberOptional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn generate_data_quality_rules()
generate data quality rules
fn get_iam_policy()
get iam policy
fn run()
run
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
datascans_jobs.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
fn sync(identifier?: string)
Sync jobs state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific jobs by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List jobs resources
ArgumentTypeDescription
filter?stringOptional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
pageSize?numberOptional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn cancel()
cancel
fn generate_data_quality_rules()
generate data quality rules
datataxonomies.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. Description of the DataTaxonomy.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the DataTaxonomy.
dataTaxonomyId?stringRequired. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a dataTaxonomies
fn get(identifier: string)
Get a dataTaxonomies
ArgumentTypeDescription
identifierstringThe name of the dataTaxonomies
fn update(identifier?: string)
Update dataTaxonomies attributes
ArgumentTypeDescription
identifier?stringTarget a specific dataTaxonomies by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the dataTaxonomies
ArgumentTypeDescription
identifierstringThe name of the dataTaxonomies
fn sync(identifier?: string)
Sync dataTaxonomies state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataTaxonomies by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List dataTaxonomies resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
datataxonomies_attributes.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
dataAccessSpec?objectOptional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
description?stringOptional. Description of the DataAttribute.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the DataAttribute.
parentId?stringOptional. 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?objectOptional. The set of principals to be granted owner role on the resource.
dataAttributeId?stringRequired. 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a attributes
fn get(identifier: string)
Get a attributes
ArgumentTypeDescription
identifierstringThe name of the attributes
fn update(identifier?: string)
Update attributes attributes
ArgumentTypeDescription
identifier?stringTarget a specific attributes by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the attributes
ArgumentTypeDescription
identifierstringThe name of the attributes
fn sync(identifier?: string)
Sync attributes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific attributes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List attributes resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
encryptionconfigs.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
enableMetastoreEncryption?booleanOptional. Represent the state of CMEK opt-in for metastore.
key?stringOptional. 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?stringIdentifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
encryptionConfigId?stringRequired. The ID of the EncryptionConfig to create. Currently, only a value of "default" is supported.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn create()
Create a encryptionConfigs
fn get(identifier: string)
Get a encryptionConfigs
ArgumentTypeDescription
identifierstringThe name of the encryptionConfigs
fn update(identifier?: string)
Update encryptionConfigs attributes
ArgumentTypeDescription
identifier?stringTarget a specific encryptionConfigs by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the encryptionConfigs
ArgumentTypeDescription
identifierstringThe name of the encryptionConfigs
fn sync(identifier?: string)
Sync encryptionConfigs state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific encryptionConfigs by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List encryptionConfigs resources
ArgumentTypeDescription
filter?stringOptional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, create_time, update_time, encryption_state Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :), * filter=create_time>2024-05-01T00:00:00.000Z
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
entrygroups.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. Description of the EntryGroup.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the EntryGroup.
entryGroupId?stringRequired. EntryGroup identifier.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a entryGroups
fn get(identifier: string)
Get a entryGroups
ArgumentTypeDescription
identifierstringThe name of the entryGroups
fn update(identifier?: string)
Update entryGroups attributes
ArgumentTypeDescription
identifier?stringTarget a specific entryGroups by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the entryGroups
ArgumentTypeDescription
identifierstringThe name of the entryGroups
fn sync(identifier?: string)
Sync entryGroups state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific entryGroups by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List entryGroups resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
entrygroups_entries.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
aspects?recordThe time the aspect was created in the source system.
entrySource?objectOptional. The name of the ancestor resource.
entryType?stringRequired. 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?stringOptional. 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?stringIdentifier. 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?stringOptional. 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?stringRequired. 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 resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a entries
fn get(identifier: string)
Get a entries
ArgumentTypeDescription
identifierstringThe name of the entries
fn update(identifier?: string)
Update entries attributes
ArgumentTypeDescription
identifier?stringTarget a specific entries by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the entries
ArgumentTypeDescription
identifierstringThe name of the entries
fn sync(identifier?: string)
Sync entries state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific entries by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List entries resources
ArgumentTypeDescription
filter?stringOptional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_name parent_entryThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type and parent_entry you need to provide the full project id or number.You cannot use parent_entry in conjunction with other fields.Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName" "parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry"
pageSize?numberOptional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
entrygroups_entrylinks.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
aspects?recordThe time the aspect was created in the source system.
entryLinkType?stringRequired. 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?arrayRequired. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
entryLinkId?stringRequired. 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a entryLinks
fn get(identifier: string)
Get a entryLinks
ArgumentTypeDescription
identifierstringThe name of the entryLinks
fn update(identifier?: string)
Update entryLinks attributes
ArgumentTypeDescription
identifier?stringTarget a specific entryLinks by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the entryLinks
ArgumentTypeDescription
identifierstringThe name of the entryLinks
fn sync(identifier?: string)
Sync entryLinks state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific entryLinks by name (e.g. one discovered by list)
entrytypes.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
authorization?objectImmutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex Universal Catalog owned Entry Types, only settable for Dataplex Universal Catalog owned Types.
description?stringOptional. Description of the EntryType.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the EntryType.
platform?stringOptional. The platform that Entries of this type belongs to.
requiredAspects?arrayRequired aspect type for the entry type.
system?stringOptional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
typeAliases?arrayOptional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
entryTypeId?stringRequired. EntryType identifier.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a entryTypes
fn get(identifier: string)
Get a entryTypes
ArgumentTypeDescription
identifierstringThe name of the entryTypes
fn update(identifier?: string)
Update entryTypes attributes
ArgumentTypeDescription
identifier?stringTarget a specific entryTypes by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the entryTypes
ArgumentTypeDescription
identifierstringThe name of the entryTypes
fn sync(identifier?: string)
Sync entryTypes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific entryTypes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List entryTypes resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions.
orderBy?stringOptional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.
pageSize?numberOptional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
glossaries.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. The user-mutable description of the Glossary.
displayName?stringOptional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
labels?recordOptional. User-defined labels for the Glossary.
glossaryId?stringRequired. Glossary ID: Glossary identifier.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a glossaries
fn get(identifier: string)
Get a glossaries
ArgumentTypeDescription
identifierstringThe name of the glossaries
fn update(identifier?: string)
Update glossaries attributes
ArgumentTypeDescription
identifier?stringTarget a specific glossaries by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the glossaries
ArgumentTypeDescription
identifierstringThe name of the glossaries
fn sync(identifier?: string)
Sync glossaries state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific glossaries by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List glossaries resources
ArgumentTypeDescription
filter?stringOptional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are: - display_name="my-glossary" - categoryCount=1 - termCount=0
orderBy?stringOptional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
glossaries_categories.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. The user-mutable description of the GlossaryCategory.
displayName?stringOptional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
labels?recordOptional. User-defined labels for the GlossaryCategory.
parent?stringRequired. 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?stringRequired. GlossaryCategory identifier.
fn create()
Create a categories
fn get(identifier: string)
Get a categories
ArgumentTypeDescription
identifierstringThe name of the categories
fn update(identifier?: string)
Update categories attributes
ArgumentTypeDescription
identifier?stringTarget a specific categories by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the categories
ArgumentTypeDescription
identifierstringThe name of the categories
fn sync(identifier?: string)
Sync categories state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific categories by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List categories resources
ArgumentTypeDescription
filter?stringOptional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields: - immediate_parentExamples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"This will only return the GlossaryCategories that are directly nested under the specified parent.
orderBy?stringOptional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
glossaries_terms.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. The user-mutable description of the GlossaryTerm.
displayName?stringOptional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
labels?recordOptional. User-defined labels for the GlossaryTerm.
parent?stringRequired. 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?stringRequired. GlossaryTerm identifier.
fn create()
Create a terms
fn get(identifier: string)
Get a terms
ArgumentTypeDescription
identifierstringThe name of the terms
fn update(identifier?: string)
Update terms attributes
ArgumentTypeDescription
identifier?stringTarget a specific terms by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the terms
ArgumentTypeDescription
identifierstringThe name of the terms
fn sync(identifier?: string)
Sync terms state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific terms by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List terms resources
ArgumentTypeDescription
filter?stringOptional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields: - immediate_parentExamples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"This will only return the GlossaryTerms that are directly nested under the specified parent.
orderBy?stringOptional. Order by expression that orders GlossaryTerms listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
lakes.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. Description of the lake.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User-defined labels for the lake.
metastore?objectOptional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
lakeId?stringRequired. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a lakes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a lakes
ArgumentTypeDescription
identifierstringThe name of the lakes
fn update(identifier?: string, waitForReady?: boolean)
Update lakes attributes
ArgumentTypeDescription
identifier?stringTarget a specific lakes by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the lakes
ArgumentTypeDescription
identifierstringThe name of the lakes
fn sync(identifier?: string)
Sync lakes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific lakes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List lakes resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
lakes_actions.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a actions
ArgumentTypeDescription
identifierstringThe name of the actions
fn sync(identifier?: string)
Sync actions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific actions by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List actions resources
ArgumentTypeDescription
pageSize?numberOptional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
lakes_assets.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. Description of the asset.
discoverySpec?objectOptional. The delimiter being used to separate values. This defaults to ','.
displayName?stringOptional. User friendly display name.
labels?recordOptional. User defined labels for the asset.
resourceSpec?objectImmutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}
assetId?stringRequired. 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a assets
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a assets
ArgumentTypeDescription
identifierstringThe name of the assets
fn update(identifier?: string, waitForReady?: boolean)
Update assets attributes
ArgumentTypeDescription
identifier?stringTarget a specific assets by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the assets
ArgumentTypeDescription
identifierstringThe name of the assets
fn sync(identifier?: string)
Sync assets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific assets by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assets resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of asset to return. The service may return fewer than this value. If unspecified, at most 10 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
lakes_assets_actions.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a actions
ArgumentTypeDescription
identifierstringThe name of the actions
fn sync(identifier?: string)
Sync actions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific actions by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List actions resources
ArgumentTypeDescription
pageSize?numberOptional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
lakes_entities.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
asset?stringRequired. 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.
dataPath?stringRequired. 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?stringOptional. 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?stringOptional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
displayName?stringOptional. Display name must be shorter than or equal to 256 characters.
format?objectOptional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
id?stringRequired. 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?objectOptional. User friendly field description. Must be less than or equal to 1024 characters.
system?enumRequired. Immutable. Identifies the storage system of the entity data.
type?enumRequired. Immutable. The type of entity.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a entities
fn get(identifier: string)
Get a entities
ArgumentTypeDescription
identifierstringThe name of the entities
fn update(identifier?: string)
Update entities attributes
ArgumentTypeDescription
identifier?stringTarget a specific entities by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the entities
ArgumentTypeDescription
identifierstringThe name of the entities
fn sync(identifier?: string)
Sync entities state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific entities by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)
List entities resources
ArgumentTypeDescription
filter?stringOptional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE compatible: ?filter="hive_compatible=true" Is BigQuery compatible: ?filter="bigquery_compatible=true"
pageSize?numberOptional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
view?stringRequired. Specify the entity view to make a partial list request.
maxPages?numberMaximum number of pages to fetch (default: 10)
lakes_entities_partitions.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
location?stringRequired. 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?arrayRequired. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn create()
Create a partitions
fn get(identifier: string)
Get a partitions
ArgumentTypeDescription
identifierstringThe name of the partitions
fn delete(identifier: string)
Delete the partitions
ArgumentTypeDescription
identifierstringThe name of the partitions
fn sync(identifier?: string)
Sync partitions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific partitions by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List partitions resources
ArgumentTypeDescription
filter?stringOptional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax: logic operators: AND, OR comparison operators: <, >, >=, <= ,=, != LIKE operators: The right hand of a LIKE operator supports "." and "*" for wildcard searches, for example "value1 LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="key1 < value1 OR key2 > value2"Notes: Keys to the left of operators are case insensitive. Partition results are sorted first by creation time, then by lexicographic order. Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.
pageSize?numberOptional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.
maxPages?numberMaximum number of pages to fetch (default: 10)
lakes_tasks.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
description?stringOptional. Description of the task.
displayName?stringOptional. User friendly display name.
executionSpec?objectOptional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.
labels?recordOptional. User-defined labels for the task.
notebook?objectOptional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types:.jar,.tar,.tar.gz,.tgz, and.zip.
spark?objectOptional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types:.jar,.tar,.tar.gz,.tgz, and.zip.
triggerSpec?objectOptional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
taskId?stringRequired. Task identifier.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a tasks
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a tasks
ArgumentTypeDescription
identifierstringThe name of the tasks
fn update(identifier?: string, waitForReady?: boolean)
Update tasks attributes
ArgumentTypeDescription
identifier?stringTarget a specific tasks by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the tasks
ArgumentTypeDescription
identifierstringThe name of the tasks
fn sync(identifier?: string)
Sync tasks state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific tasks by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tasks resources
ArgumentTypeDescription
filter?stringOptional. Filter request.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy()
get iam policy
fn run(args?: any, labels?: any)
run
ArgumentTypeDescription
args?any
labels?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
lakes_tasks_jobs.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
fn sync(identifier?: string)
Sync jobs state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific jobs by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List jobs resources
ArgumentTypeDescription
pageSize?numberOptional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn cancel()
cancel
locations.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
pageSize?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn lookup_context(options?: any, resources?: any)
lookup context
ArgumentTypeDescription
options?any
resources?any
fn lookup_entry()
lookup entry
fn lookup_entry_links()
lookup entry links
fn modify_entry(aspectKeys?: any, deleteMissingAspects?: any, entry?: any, updateMask?: any)
modify entry
ArgumentTypeDescription
aspectKeys?any
deleteMissingAspects?any
entry?any
updateMask?any
fn search_entries()
search entries
metadatafeeds.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
filters?objectOptional. The aspect types that you want to listen to. Depending on how the aspect is attached to the entry, in the format: projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}.
labels?recordOptional. User-defined labels.
name?stringIdentifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.
pubsubTopic?stringOptional. 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?objectOptional. The entry groups whose entries you want to listen to. Must be in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
metadataFeedId?stringOptional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a metadataFeeds
fn get(identifier: string)
Get a metadataFeeds
ArgumentTypeDescription
identifierstringThe name of the metadataFeeds
fn update(identifier?: string)
Update metadataFeeds attributes
ArgumentTypeDescription
identifier?stringTarget a specific metadataFeeds by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the metadataFeeds
ArgumentTypeDescription
identifierstringThe name of the metadataFeeds
fn sync(identifier?: string)
Sync metadataFeeds state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific metadataFeeds by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List metadataFeeds resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.
orderBy?stringOptional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of metadata feeds to return. The service might return fewer feeds than this value. If unspecified, at most 10 feeds are returned. The maximum value is 1,000.
maxPages?numberMaximum number of pages to fetch (default: 10)
metadatajobs.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
exportSpec?objectRequired. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex Universal Catalog constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job.
importSpec?objectRequired. The sync mode for aspects.
labels?recordOptional. User-defined labels.
type?enumRequired. Metadata job type.
metadataJobId?stringOptional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a metadataJobs
fn get(identifier: string)
Get a metadataJobs
ArgumentTypeDescription
identifierstringThe name of the metadataJobs
fn sync(identifier?: string)
Sync metadataJobs state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific metadataJobs by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List metadataJobs resources
ArgumentTypeDescription
filter?stringOptional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.
orderBy?stringOptional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.
pageSize?numberOptional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn cancel()
cancel
04Previous Versions19
2026.07.21.1
  • Updated: encryptionconfigs, aspecttypes, changerequests, datadomains, dataproducts, datascans, datataxonomies_attributes, entrygroups_entries, entrygroups_entrylinks, entrytypes, lakes, lakes_tasks, lakes_assets, lakes_entities, lakes_entities_partitions, metadatafeeds, metadatajobs
2026.07.20.2
  • Added: changerequests, datadomains, datadomains_bindings
  • Updated: locations, dataproducts, datascans, datascans_jobs

Added 1, removed 27 models

2026.07.20.1
  • 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

Added 27, removed 1 models

2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: encryptionconfigs, locations, aspecttypes, changerequests, dataattributebindings, datadomains, datadomains_bindings, 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
2026.07.18.2
  • Updated: encryptionconfigs, locations, aspecttypes, changerequests, dataattributebindings, datadomains, datadomains_bindings, 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
2026.07.17.2
  • Updated: encryptionconfigs, aspecttypes, changerequests, dataattributebindings, datadomains, datadomains_bindings, dataproducts, dataproducts_dataassets, datascans, datataxonomies, datataxonomies_attributes, entrygroups, entrygroups_entries, entrytypes, glossaries, glossaries_categories, glossaries_terms, lakes, lakes_tasks, lakes_assets, metadatafeeds
2026.07.17.1
  • Updated: encryptionconfigs, aspecttypes, changerequests, dataattributebindings, datadomains, datadomains_bindings, 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
2026.07.16.1
  • Updated: locations
2026.07.02.1
  • Updated: datadomains
2026.06.25.1
  • Added: datadomains, datadomains_bindings
  • Updated: datascans, datascans_jobs
2026.06.08.3
  • Updated: encryptionconfigs, locations, aspecttypes, changerequests, 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
2026.06.08.1
  • Updated: datascans, datascans_jobs
2026.06.07.1
  • Updated: encryptionconfigs, locations, aspecttypes, changerequests, 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

Added 1, removed 28 models

2026.05.27.1
  • Updated: aspecttypes, lakes_entities
2026.05.26.1
  • Added: changerequests
  • Updated: locations, dataproducts, datascans, datascans_jobs

Added 1, modified 3 models

2026.05.25.1
  • 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

Removed 1, modified 26 models

2026.05.24.1
  • Added: changerequests
  • 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

Added 1 models

2026.05.21.2
  • 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
05Stats
A
100 / 100
Downloads
0
Archive size
438.7 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#dataplex#cloud#infrastructure