Skip to main content

Gcp/bigtableadmin

@swamp/gcp/bigtableadminv2026.07.30.1· 2d agoMODELS
01README

Google Cloud bigtableadmin infrastructure models

02Release Notes
  • Updated: instances_clusters, instances_tables
03Models12
@swamp/gcp/bigtableadmin/instancesv2026.07.29.1instances.ts

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.
quotaProject?stringGCP 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.
clusters?recordImmutable. The encryption configuration for CMEK-protected clusters.
location?stringImmutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
name?stringThe unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
nodeScalingFactor?enumImmutable. The node scaling factor of this cluster.
serveNodes?numberThe number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
state?enumOutput only. The current state of the cluster.
instance?objectRequired. The instance to create. Fields marked `OutputOnly` must be left blank.
instanceId?stringRequired. The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
parent?stringRequired. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`.
createTime?stringOutput only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.
displayName?stringRequired. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
edition?enumOptional. The edition of the instance. See Edition for details.
knowledgeCatalogRegion?stringOutput only. The region where Knowledge Catalog data is synced to and stored, including user-created aspects.
labels?recordLabels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\\p{Ll}\\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`. * No more than 64 l
name?stringThe unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
satisfiesPzi?booleanOutput only. Reserved for future use.
satisfiesPzs?booleanOutput only. Reserved for future use.
state?enumOutput only. The current state of the instance.
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
type?enumThe type of the instance. Defaults to `PRODUCTION`.
fn create(waitForReady?: boolean)
Create a instances
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn update(identifier?: string, waitForReady?: boolean)
Update instances attributes
ArgumentTypeDescription
identifier?stringTarget a specific instances 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 instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn sync(identifier?: string)
Sync instances state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific instances by name (e.g. one discovered by list)
fn list(maxPages?: number)
List instances resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn partial_update_instance(createTime?: any, displayName?: any, edition?: any, knowledgeCatalogRegion?: any, labels?: any, name?: any, satisfiesPzi?: any, satisfiesPzs?: any, state?: any, tags?: any, type?: any)
partial update instance
ArgumentTypeDescription
createTime?any
displayName?any
edition?any
knowledgeCatalogRegion?any
labels?any
name?any
satisfiesPzi?any
satisfiesPzs?any
state?any
tags?any
type?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

Resources

state(infinite)— A collection of Bigtable Tables and the resources that serve them. All tables...
@swamp/gcp/bigtableadmin/instances-appprofilesv2026.07.29.1instances_appprofiles.ts

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.
quotaProject?stringGCP 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.
dataBoostIsolationReadOnly?objectSpecifies that this app profile is intended for read-only usage via the Data Boost feature.
description?stringLong form description of the use case for this AppProfile.
multiClusterRoutingUseAny?objectUse a multi-cluster routing policy.
name?stringThe unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
singleClusterRouting?objectUse a single-cluster routing policy.
standardIsolation?objectThe standard options used for isolating this app profile's traffic from other use cases.
appProfileId?stringRequired. The ID to be used when referring to the new app profile within its instance, e.g., just `myprofile` rather than `projects/myproject/instances/myinstance/appProfiles/myprofile`.
ignoreWarnings?stringIf true, ignore safety checks when creating the app profile.
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 appProfiles
fn get(identifier: string)
Get a appProfiles
ArgumentTypeDescription
identifierstringThe name of the appProfiles
fn update(identifier?: string)
Update appProfiles attributes
ArgumentTypeDescription
identifier?stringTarget a specific appProfiles by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the appProfiles
ArgumentTypeDescription
identifierstringThe name of the appProfiles
fn sync(identifier?: string)
Sync appProfiles state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific appProfiles by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List appProfiles resources
ArgumentTypeDescription
pageSize?numberMaximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A configuration object describing how Cloud Bigtable should treat traffic fro...
@swamp/gcp/bigtableadmin/instances-clustersv2026.07.30.1instances_clusters.ts

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.
quotaProject?stringGCP 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.
clusterConfig?objectConfiguration for this cluster.
defaultStorageType?enumImmutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
encryptionConfigobject
location?stringImmutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
name?stringThe unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
nodeScalingFactor?enumImmutable. The node scaling factor of this cluster.
serveNodes?numberThe number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
clusterId?stringRequired. The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn create(waitForReady?: boolean)
Create a clusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
fn update(identifier?: string, waitForReady?: boolean)
Update clusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific clusters 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 clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
fn sync(identifier?: string)
Sync clusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific clusters by name (e.g. one discovered by list)
fn list(maxPages?: number)
List clusters resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_memory_layer()
get memory layer
fn partial_update_cluster(clusterConfig?: any, defaultStorageType?: any, encryptionConfig?: any, location?: any, name?: any, nodeScalingFactor?: any, serveNodes?: any, state?: any)
partial update cluster
ArgumentTypeDescription
clusterConfig?any
defaultStorageType?any
encryptionConfig?any
location?any
name?any
nodeScalingFactor?any
serveNodes?any
state?any
fn update_memory_layer(etag?: any, memoryConfig?: any, name?: any, state?: any)
update memory layer
ArgumentTypeDescription
etag?any
memoryConfig?any
name?any
state?any

Resources

state(infinite)— A resizable group of nodes in a particular cloud location, capable of serving...
@swamp/gcp/bigtableadmin/instances-clusters-backupsv2026.07.29.1instances_clusters_backups.ts

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.
quotaProject?stringGCP 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.
backupType?enumIndicates the backup type of the backup.
expireTime?stringRequired. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
hotToStandardTime?stringThe time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
name?stringA globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
sourceTable?stringRequired. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
backupId?stringRequired. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
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 backups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a backups
ArgumentTypeDescription
identifierstringThe name of the backups
fn update(identifier?: string, waitForReady?: boolean)
Update backups attributes
ArgumentTypeDescription
identifier?stringTarget a specific backups 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 backups
ArgumentTypeDescription
identifierstringThe name of the backups
fn sync(identifier?: string)
Sync backups state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific backups by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List backups resources
ArgumentTypeDescription
filter?stringA filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon \
orderBy?stringAn expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". R
pageSize?numberNumber of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn copy(backupId?: any, expireTime?: any, sourceBackup?: any)
copy
ArgumentTypeDescription
backupId?any
expireTime?any
sourceBackup?any
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?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

Resources

state(infinite)— A backup of a Cloud Bigtable table.
@swamp/gcp/bigtableadmin/instances-clusters-hottabletsv2026.07.29.1instances_clusters_hottablets.ts

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.
quotaProject?stringGCP 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.
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 hotTablets
ArgumentTypeDescription
identifierstringThe name of the hotTablets
fn sync(identifier?: string)
Sync hotTablets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific hotTablets by name (e.g. one discovered by list)
fn list(endTime?: string, pageSize?: number, startTime?: string, maxPages?: number)
List hotTablets resources
ArgumentTypeDescription
endTime?stringThe end time to list hot tablets.
pageSize?numberMaximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
startTime?stringThe start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A tablet is a defined by a start and end key and is explained in https://clou...
@swamp/gcp/bigtableadmin/instances-clusters-memorylayersv2026.07.29.1instances_clusters_memorylayers.ts

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.
quotaProject?stringGCP 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.
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 memoryLayers
ArgumentTypeDescription
identifierstringThe name of the memoryLayers
fn sync(identifier?: string)
Sync memoryLayers state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific memoryLayers by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List memoryLayers resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of memory layers to return. The service may return fewer than this value.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Lists information about memory layers.
@swamp/gcp/bigtableadmin/instances-logicalviewsv2026.07.29.1instances_logicalviews.ts

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.
quotaProject?stringGCP 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.
deletionProtection?booleanOptional. Set to true to make the LogicalView protected against deletion.
name?stringIdentifier. The unique name of the logical view. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`
query?stringRequired. The logical view's select query.
logicalViewId?stringRequired. The ID to use for the logical view, which will become the final component of the logical view's resource name.
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 logicalViews
fn get(identifier: string)
Get a logicalViews
ArgumentTypeDescription
identifierstringThe name of the logicalViews
fn update(identifier?: string)
Update logicalViews attributes
ArgumentTypeDescription
identifier?stringTarget a specific logicalViews by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the logicalViews
ArgumentTypeDescription
identifierstringThe name of the logicalViews
fn sync(identifier?: string)
Sync logicalViews state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific logicalViews by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List logicalViews resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of logical views to return. The service may return fewer than this value
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?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

Resources

state(infinite)— A SQL logical view object that can be referenced in SQL queries.
@swamp/gcp/bigtableadmin/instances-materializedviewsv2026.07.29.1instances_materializedviews.ts

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.
quotaProject?stringGCP 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.
deletionProtection?booleanSet to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
name?stringIdentifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
query?stringRequired. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`.
ignoreWarnings?stringOptional. If true, ignore optional safety checks when creating the materialized view.
materializedViewId?stringRequired. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.
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 materializedViews
fn get(identifier: string)
Get a materializedViews
ArgumentTypeDescription
identifierstringThe name of the materializedViews
fn update(identifier?: string)
Update materializedViews attributes
ArgumentTypeDescription
identifier?stringTarget a specific materializedViews by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the materializedViews
ArgumentTypeDescription
identifierstringThe name of the materializedViews
fn sync(identifier?: string)
Sync materializedViews state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific materializedViews by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List materializedViews resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of materialized views to return. The service may return fewer than this value
view?stringOptional. Describes which of the materialized view's fields should be populated in the response. For now, only the default value SCHEMA_VIEW is supported.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?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

Resources

state(infinite)— A materialized view object that can be referenced in SQL queries.
@swamp/gcp/bigtableadmin/instances-tablesv2026.07.30.1instances_tables.ts

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.
quotaProject?stringGCP 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.
initialSplitsarray
table?objectRequired. The Table to create.
tableId?stringRequired. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
automatedBackupPolicy?objectIf specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
changeStreamConfig?objectIf specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
clusterStates?recordOutput only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
columnFamilies?recordThe column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
deletionProtection?booleanSet to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
granularity?enumImmutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
name?stringThe unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL`
restoreInfo?objectOutput only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
rowKeySchema?objectThe row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encod
stats?objectOutput only. Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
tieredStorageConfig?objectRules to specify what data is stored in each storage tier. Different tiers store data differently, providing different trade-offs between cost and performance. Different parts of a table can be stored separately on different tiers. If a config is specified, tiered storage is enabled for this table. Otherwise, tiered storage is disabled. Only SSD instances can configure tiered storage.
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 tables
fn get(identifier: string)
Get a tables
ArgumentTypeDescription
identifierstringThe name of the tables
fn update(identifier?: string)
Update tables attributes
ArgumentTypeDescription
identifier?stringTarget a specific tables by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the tables
ArgumentTypeDescription
identifierstringThe name of the tables
fn sync(identifier?: string)
Sync tables state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific tables by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List tables resources
ArgumentTypeDescription
pageSize?numberMaximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
view?stringThe view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn check_consistency(consistencyToken?: any, dataBoostReadLocalWrites?: any, standardReadRemoteWrites?: any)
check consistency
ArgumentTypeDescription
consistencyToken?any
dataBoostReadLocalWrites?any
standardReadRemoteWrites?any
fn drop_row_range(deleteAllDataFromTable?: any, rowKeyPrefix?: any)
drop row range
ArgumentTypeDescription
deleteAllDataFromTable?any
rowKeyPrefix?any
fn generate_consistency_token()
generate consistency token
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn modify_column_families(ignoreWarnings?: any, modifications?: any)
modify column families
ArgumentTypeDescription
ignoreWarnings?any
modifications?any
fn restore(backup?: any, tableId?: any)
restore
ArgumentTypeDescription
backup?any
tableId?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
fn undelete()
undelete

Resources

state(infinite)— A collection of user data indexed by row, column, and timestamp. Each table i...
@swamp/gcp/bigtableadmin/instances-tables-authorizedviewsv2026.07.29.1instances_tables_authorizedviews.ts

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.
quotaProject?stringGCP 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.
deletionProtection?booleanSet to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.
name?stringIdentifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`
subsetView?objectAn AuthorizedView permitting access to an explicit subset of a Table.
authorizedViewId?stringRequired. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.
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 authorizedViews
fn get(identifier: string)
Get a authorizedViews
ArgumentTypeDescription
identifierstringThe name of the authorizedViews
fn update(identifier?: string)
Update authorizedViews attributes
ArgumentTypeDescription
identifier?stringTarget a specific authorizedViews by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the authorizedViews
ArgumentTypeDescription
identifierstringThe name of the authorizedViews
fn sync(identifier?: string)
Sync authorizedViews state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific authorizedViews by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List authorizedViews resources
ArgumentTypeDescription
pageSize?numberOptional. Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
view?stringOptional. The resource_view to be applied to the returned AuthorizedViews' fields. Default to NAME_ONLY.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?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

Resources

state(infinite)— An Authorized View of a Cloud Bigtable Table.
@swamp/gcp/bigtableadmin/instances-tables-schemabundlesv2026.07.29.1instances_tables_schemabundles.ts

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.
quotaProject?stringGCP 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.
name?stringIdentifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`
protoSchema?objectSchema for Protobufs.
schemaBundleId?stringRequired. The unique ID to use for the schema bundle, which will become the final component of the schema bundle's resource name.
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 schemaBundles
fn get(identifier: string)
Get a schemaBundles
ArgumentTypeDescription
identifierstringThe name of the schemaBundles
fn update(identifier?: string)
Update schemaBundles attributes
ArgumentTypeDescription
identifier?stringTarget a specific schemaBundles by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the schemaBundles
ArgumentTypeDescription
identifierstringThe name of the schemaBundles
fn sync(identifier?: string)
Sync schemaBundles state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific schemaBundles by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List schemaBundles resources
ArgumentTypeDescription
pageSize?numberThe maximum number of schema bundles to return. If the value is positive, the server may return at most this value. If unspecified, the server will return the maximum allowed page size.
view?stringOptional. The resource_view to be applied to the returned SchemaBundles' fields. Defaults to NAME_ONLY.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?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

Resources

state(infinite)— A named collection of related schemas.
@swamp/gcp/bigtableadmin/locationsv2026.07.29.1locations.ts

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.
quotaProject?stringGCP 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.
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)

Resources

state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions19
2026.07.29.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.07.21.3
  • Added: instances_clusters_memorylayers
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.07.21.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles
2026.07.20.2
  • Added: instances_clusters_memorylayers
  • Updated: instances, instances_appprofiles, instances_clusters, instances_materializedviews, instances_tables, instances_tables_schemabundles, locations

Added 1, modified 1 models

2026.07.20.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations

Removed 1, modified 1 models

2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.07.18.2
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.07.17.3
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles
2026.07.17.2
  • Updated: instances, instances_tables
2026.07.17.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles
2026.06.30.1
  • Updated: instances
2026.06.08.2
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.06.07.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.05.27.1
  • Updated: instances_tables
2026.05.26.1
  • Added: instances_clusters_memorylayers
  • Updated: instances_appprofiles, instances_clusters, instances_tables, instances_tables_schemabundles, locations

Added 1, modified 1 models

2026.05.25.2
  • Updated: instances, instances_clusters

Removed 1, modified 11 models

2026.05.24.1
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
2026.05.21.2
  • Updated: instances, instances_appprofiles, instances_clusters, instances_clusters_backups, instances_clusters_hottablets, instances_clusters_memorylayers, instances_logicalviews, instances_materializedviews, instances_tables, instances_tables_authorizedviews, instances_tables_schemabundles, locations
05Stats
A
100 / 100
Downloads
0
Archive size
185.6 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