Skip to main content
← back to extensions

@swamp/gcp/bigtableadmin

v2026.04.23.1

Google Cloud bigtableadmin infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudbigtableadmincloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/bigtableadmin

@swamp/gcp/bigtableadmin/instancesv2026.04.23.1instances.ts

Global Arguments

ArgumentTypeDescription
clusters?recordCloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
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?objectA collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
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.
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`.
createCreate a instances
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
updateUpdate instances attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
syncSync instances state from GCP
partial_update_instancepartial update instance
ArgumentTypeDescription
createTime?any
displayName?any
edition?any
labels?any
name?any
satisfiesPzi?any
satisfiesPzs?any
state?any
tags?any
type?any

Resources

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

Global Arguments

ArgumentTypeDescription
dataBoostIsolationReadOnly?objectData Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.
description?stringLong form description of the use case for this AppProfile.
multiClusterRoutingUseAny?objectRead/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
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?objectUnconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
standardIsolation?objectStandard options 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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a appProfiles
getGet a appProfiles
ArgumentTypeDescription
identifierstringThe name of the appProfiles
updateUpdate appProfiles attributes
deleteDelete the appProfiles
ArgumentTypeDescription
identifierstringThe name of the appProfiles
syncSync appProfiles state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
clusterConfig?objectConfiguration for a 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`.
createCreate a clusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
updateUpdate clusters attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
syncSync clusters state from GCP
get_memory_layerget memory layer
partial_update_clusterpartial update cluster
ArgumentTypeDescription
clusterConfig?any
defaultStorageType?any
encryptionConfig?any
location?any
name?any
nodeScalingFactor?any
serveNodes?any
state?any
update_memory_layerupdate 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.04.23.1instances_clusters_backups.ts

Global Arguments

ArgumentTypeDescription
backupType?enumIndicates the backup type of the backup.
encryptionInfo?objectEncryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
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*.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backups
ArgumentTypeDescription
identifierstringThe name of the backups
updateUpdate backups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP
copycopy
ArgumentTypeDescription
backupId?any
expireTime?any
sourceBackup?any

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a hotTablets
ArgumentTypeDescription
identifierstringThe name of the hotTablets
syncSync hotTablets state from GCP

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.04.23.1instances_clusters_memorylayers.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a memoryLayers
ArgumentTypeDescription
identifierstringThe name of the memoryLayers
syncSync memoryLayers state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a logicalViews
getGet a logicalViews
ArgumentTypeDescription
identifierstringThe name of the logicalViews
updateUpdate logicalViews attributes
deleteDelete the logicalViews
ArgumentTypeDescription
identifierstringThe name of the logicalViews
syncSync logicalViews state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
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`.
materializedViewId?stringRequired. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a materializedViews
getGet a materializedViews
ArgumentTypeDescription
identifierstringThe name of the materializedViews
updateUpdate materializedViews attributes
deleteDelete the materializedViews
ArgumentTypeDescription
identifierstringThe name of the materializedViews
syncSync materializedViews state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
initialSplitsarray
table?objectA collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
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?objectDefines an automated backup policy for a table
changeStreamConfig?objectChange stream configuration.
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?objectInformation about a table restore.
rowKeySchema?objectA structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`.
stats?objectApproximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.
tieredStorageConfig?objectConfig for tiered storage. A valid config must have a valid TieredStorageRule. Otherwise the whole TieredStorageConfig must be unset. By default all data is stored in the SSD tier (only SSD instances can configure tiered storage).
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a tables
getGet a tables
ArgumentTypeDescription
identifierstringThe name of the tables
updateUpdate tables attributes
deleteDelete the tables
ArgumentTypeDescription
identifierstringThe name of the tables
syncSync tables state from GCP
check_consistencycheck consistency
ArgumentTypeDescription
consistencyToken?any
dataBoostReadLocalWrites?any
standardReadRemoteWrites?any
drop_row_rangedrop row range
ArgumentTypeDescription
deleteAllDataFromTable?any
rowKeyPrefix?any
generate_consistency_tokengenerate consistency token
modify_column_familiesmodify column families
ArgumentTypeDescription
ignoreWarnings?any
modifications?any
restorerestore
ArgumentTypeDescription
backup?any
tableId?any
undeleteundelete

Resources

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

Global Arguments

ArgumentTypeDescription
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?objectDefines a simple AuthorizedView that is a subset of the underlying 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}`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a authorizedViews
getGet a authorizedViews
ArgumentTypeDescription
identifierstringThe name of the authorizedViews
updateUpdate authorizedViews attributes
deleteDelete the authorizedViews
ArgumentTypeDescription
identifierstringThe name of the authorizedViews
syncSync authorizedViews state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`
protoSchema?objectRepresents a protobuf schema.
schemaBundleId?stringRequired. The unique ID to use for the schema bundle, which will become the final component of the schema bundle's resource name.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a schemaBundles
getGet a schemaBundles
ArgumentTypeDescription
identifierstringThe name of the schemaBundles
updateUpdate schemaBundles attributes
deleteDelete the schemaBundles
ArgumentTypeDescription
identifierstringThe name of the schemaBundles
syncSync schemaBundles state from GCP

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

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