Gcp/bigquerydatapolicy
@swamp/gcp/bigquerydatapolicyv2026.09.07.1
01README
Google Cloud bigquerydatapolicy infrastructure models
02Release Notes
- Updated: datapolicies
03Models
@swamp/gcp/bigquerydatapolicy/datapoliciesv2026.09.07.1datapolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| dataPolicy? | object | Required. The data policy to create. The `name` field does not need to be provided for the data policy creation. |
| dataPolicyId? | string | Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name. |
| dataGovernanceTag? | object | Optional. Data Governance tag bound to the Data Policy. |
| dataMaskingPolicy? | object | Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY. |
| dataPolicyType? | enum | Required. Type of data policy. |
| etag? | string | The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls. |
| grantees? | array | Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated. |
| name? | string | Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. |
| policyTag? | string | Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies. |
| version? | enum | Output only. The version of the Data Policy resource. |
| allowMissing? | string | Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a dataPolicies
fn get(identifier: string)
Get a dataPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataPolicies |
fn update(identifier?: string)
Update dataPolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataPolicies by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the dataPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataPolicies |
fn sync(identifier?: string)
Sync dataPolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataPolicies by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List dataPolicies resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters. |
| pageSize? | number | Optional. The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_grantees(grantees?: any)
add grantees
| Argument | Type | Description |
|---|---|---|
| grantees? | any |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Represents the label-policy binding.
04Previous Versions
2026.08.12.2
- Updated: datapolicies
2026.07.29.1
- Updated: datapolicies
2026.07.24.1
- Updated: datapolicies
2026.07.21.3
- Updated: datapolicies
2026.07.21.1
- Updated: datapolicies
2026.07.20.2
- Updated: datapolicies
2026.07.20.1
- Updated: datapolicies
2026.07.19.1
- Updated: datapolicies
2026.07.18.2
- Updated: datapolicies
2026.07.17.3
- Updated: datapolicies
2026.07.17.2
- Updated: datapolicies
2026.07.17.1
- Updated: datapolicies
2026.06.08.2
- Updated: datapolicies
2026.06.07.1
- Updated: datapolicies
2026.05.26.1
- Updated: datapolicies
2026.05.25.1
- Updated: datapolicies
Modified 1 models
2026.05.24.1
- Updated: datapolicies
2026.05.21.2
- Updated: datapolicies
2026.05.21.1
Modified 1 models
05Stats
A
100 / 100
Downloads
0
Archive size
30.3 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