Gcp/dlp
@swamp/gcp/dlpv2026.09.07.1
01README
Google Cloud dlp infrastructure models
02Release Notes
- Updated: connections
03Models
@swamp/gcp/dlp/columndataprofilesv2026.08.12.2columndataprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a columnDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the columnDataProfiles |
fn sync(identifier?: string)
Sync columnDataProfiles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific columnDataProfiles by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List columnDataProfiles resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuer |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitiv |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The profile for a scanned column within a table.
@swamp/gcp/dlp/connectionsv2026.09.07.1connections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| connection? | object | Required. The connection with new values for the relevant fields. |
| updateMask? | string | Optional. Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a connections
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a connections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connections |
fn update(identifier?: string, waitForReady?: boolean)
Update connections attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific connections by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the connections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connections |
fn sync(identifier?: string)
Sync connections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific connections by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List connections resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160. |
| pageSize? | number | Optional. Number of results per page, max 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn search(filter?: any, pageSize?: any, pageToken?: any)
search
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| pageToken? | any |
Resources
state(infinite)— A data connection to allow the DLP API to profile data in locations that requ...
@swamp/gcp/dlp/contentpoliciesv2026.09.03.1contentpolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| contentPolicy? | object | Required. The content_policy with new values for the relevant fields. |
| contentPolicyId? | string | Optional. The content policy ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. If empty, the system will generate a random id. |
| updateMask? | string | Optional. Mask to control which fields get updated. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a contentPolicies
fn get(identifier: string)
Get a contentPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the contentPolicies |
fn update(identifier?: string)
Update contentPolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific contentPolicies by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the contentPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the contentPolicies |
fn sync(identifier?: string)
Sync contentPolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific contentPolicies by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List contentPolicies resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Number of results per page, max 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A policy to apply to content based on its inspection findings.
@swamp/gcp/dlp/deidentifytemplatesv2026.08.12.2deidentifytemplates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| deidentifyTemplate? | object | New DeidentifyTemplate value. |
| locationId? | string | Deprecated. This field has no effect. |
| templateId? | string | The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. |
| updateMask? | string | Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a deidentifyTemplates
fn get(identifier: string)
Get a deidentifyTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deidentifyTemplates |
fn update(identifier?: string)
Update deidentifyTemplates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deidentifyTemplates by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the deidentifyTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deidentifyTemplates |
fn sync(identifier?: string)
Sync deidentifyTemplates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deidentifyTemplates by name (e.g. one discovered by list) |
fn list(locationId?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List deidentifyTemplates resources
| Argument | Type | Description |
|---|---|---|
| locationId? | string | Deprecated. This field has no effect. |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— DeidentifyTemplates contains instructions on how to de-identify content. See ...
@swamp/gcp/dlp/discoveryconfigsv2026.08.12.2discoveryconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| configId? | string | The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. |
| discoveryConfig? | object | Required. New DiscoveryConfig value. |
| updateMask? | string | Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a discoveryConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a discoveryConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the discoveryConfigs |
fn update(identifier?: string, waitForReady?: boolean)
Update discoveryConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific discoveryConfigs by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the discoveryConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the discoveryConfigs |
fn sync(identifier?: string)
Sync discoveryConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific discoveryConfigs by name (e.g. one discovered by list) |
fn list(orderBy?: string, pageSize?: number, maxPages?: number)
List discoveryConfigs resources
| Argument | Type | Description |
|---|---|---|
| orderBy? | string | Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. |
| pageSize? | number | Size of the page. This value can be limited by a server. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Configuration for discovery to scan resources for profile generation. Only on...
@swamp/gcp/dlp/dlpjobsv2026.08.12.2dlpjobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a dlpJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dlpJobs |
fn sync(identifier?: string)
Sync dlpJobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dlpJobs by name (e.g. one discovered by list) |
fn list(filter?: string, locationId?: string, orderBy?: string, pageSize?: number, type?: string, maxPages?: number)
List dlpJobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'e |
| locationId? | string | Deprecated. This field has no effect. |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` |
| pageSize? | number | The standard list page size. |
| type? | string | The type of job. Defaults to `DlpJobType.INSPECT` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Combines all of the information about a DLP job.
@swamp/gcp/dlp/filestoredataprofilesv2026.08.12.2filestoredataprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a fileStoreDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the fileStoreDataProfiles |
fn delete(identifier: string)
Delete the fileStoreDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the fileStoreDataProfiles |
fn sync(identifier?: string)
Sync fileStoreDataProfiles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific fileStoreDataProfiles by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List fileStoreDataProfiles resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like "gs://bucket" - `data_source_type`: The profile\ |
| orderBy? | string | Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associate |
| pageSize? | number | Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amaz...
@swamp/gcp/dlp/infotypesv2026.08.12.2infotypes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a infoTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the infoTypes |
fn sync(identifier?: string)
Sync infoTypes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific infoTypes by name (e.g. one discovered by list) |
fn list(filter?: string, languageCode?: string, locationId?: string, parent?: string, maxPages?: number)
List infoTypes resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. |
| languageCode? | string | BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. |
| locationId? | string | Deprecated. This field has no effect. |
| parent? | string | The parent resource name. The format of this value is as follows: `locations/{location_id}` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— InfoType description.
@swamp/gcp/dlp/inspecttemplatesv2026.08.12.2inspecttemplates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| inspectTemplate? | object | New InspectTemplate value. |
| locationId? | string | Deprecated. This field has no effect. |
| templateId? | string | The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. |
| updateMask? | string | Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a inspectTemplates
fn get(identifier: string)
Get a inspectTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the inspectTemplates |
fn update(identifier?: string)
Update inspectTemplates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific inspectTemplates by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the inspectTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the inspectTemplates |
fn sync(identifier?: string)
Sync inspectTemplates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific inspectTemplates by name (e.g. one discovered by list) |
fn list(locationId?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List inspectTemplates resources
| Argument | Type | Description |
|---|---|---|
| locationId? | string | Deprecated. This field has no effect. |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The inspectTemplate contains a configuration (set of types of sensitive data ...
@swamp/gcp/dlp/jobtriggersv2026.08.12.2jobtriggers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| jobTrigger? | object | New JobTrigger value. |
| locationId? | string | Deprecated. This field has no effect. |
| triggerId? | string | The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. |
| updateMask? | string | Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a jobTriggers
fn get(identifier: string)
Get a jobTriggers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobTriggers |
fn update(identifier?: string)
Update jobTriggers attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobTriggers by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the jobTriggers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobTriggers |
fn sync(identifier?: string)
Sync jobTriggers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobTriggers by name (e.g. one discovered by list) |
fn list(filter?: string, locationId?: string, orderBy?: string, pageSize?: number, type?: string, maxPages?: number)
List jobTriggers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. |
| locationId? | string | Deprecated. This field has no effect. |
| orderBy? | string | Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `nam |
| pageSize? | number | Size of the page. This value can be limited by a server. |
| type? | string | The type of jobs. Will use `DlpJobType.INSPECT` if not set. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Contains a configuration to make API calls on a repeating basis. See https://...
@swamp/gcp/dlp/projectdataprofilesv2026.08.12.2projectdataprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a projectDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the projectDataProfiles |
fn sync(identifier?: string)
Sync projectDataProfiles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific projectDataProfiles by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List projectDataProfiles resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_las |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An aggregated profile for this project, based on the resources profiled withi...
@swamp/gcp/dlp/storedinfotypesv2026.08.12.2storedinfotypes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| config? | object | Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. |
| locationId? | string | Deprecated. This field has no effect. |
| storedInfoTypeId? | string | The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. |
| updateMask? | string | Mask to control which fields get updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a storedInfoTypes
fn get(identifier: string)
Get a storedInfoTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the storedInfoTypes |
fn update(identifier?: string)
Update storedInfoTypes attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific storedInfoTypes by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the storedInfoTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the storedInfoTypes |
fn sync(identifier?: string)
Sync storedInfoTypes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific storedInfoTypes by name (e.g. one discovered by list) |
fn list(locationId?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List storedInfoTypes resources
| Argument | Type | Description |
|---|---|---|
| locationId? | string | Deprecated. This field has no effect. |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info typ |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— StoredInfoType resource message that contains information about the current v...
@swamp/gcp/dlp/tabledataprofilesv2026.08.12.2tabledataprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a tableDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tableDataProfiles |
fn delete(identifier: string)
Delete the tableDataProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tableDataProfiles |
fn sync(identifier?: string)
Sync tableDataProfiles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tableDataProfiles by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tableDataProfiles resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE| |
| orderBy? | string | Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitiv |
| pageSize? | number | Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The profile for a scanned table.
04Previous Versions
2026.09.03.1
- Updated: contentpolicies
2026.08.12.2
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles, contentpolicies
2026.07.31.1
- Updated: deidentifytemplates, inspecttemplates, discoveryconfigs, jobtriggers, contentpolicies
2026.07.29.1
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles, contentpolicies
2026.07.21.4
- Added: contentpolicies
- Updated: inspecttemplates, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, tabledataprofiles
2026.07.21.1
- Updated: deidentifytemplates, inspecttemplates, connections, discoveryconfigs, jobtriggers, storedinfotypes, contentpolicies
2026.07.20.2
- Added: contentpolicies
- Updated: inspecttemplates, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, tabledataprofiles
Added 1 models
2026.07.20.1
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles
Removed 1 models
2026.07.19.1
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles, contentpolicies
2026.07.18.2
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles, contentpolicies
2026.07.17.2
- Updated: storedinfotypes, contentpolicies
2026.07.17.1
- Updated: deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles, contentpolicies
2026.06.27.1
- Updated: inspecttemplates, filestoredataprofiles, jobtriggers, tabledataprofiles, contentpolicies
2026.06.15.1
- Added: contentpolicies
Added 1 models
2026.06.08.2
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles
2026.06.07.1
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles
2026.05.26.1
- Updated: inspecttemplates, dlpjobs
2026.05.25.2
- Updated: infotypes
Modified 12 models
2026.05.24.1
- Updated: infotypes, deidentifytemplates, inspecttemplates, columndataprofiles, connections, discoveryconfigs, dlpjobs, filestoredataprofiles, jobtriggers, projectdataprofiles, storedinfotypes, tabledataprofiles
05Stats
A
100 / 100
Downloads
14
Archive size
256.0 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
06Platforms
07Labels