Skip to main content

Gcp/tpu

@swamp/gcp/tpuv2026.10.30.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

Google Cloud tpu infrastructure models

02Release Notes
  • Updated: locations, nodes, queuedresources
03Behaviors6
@swamp/gcp/tpu/acceleratortypesv2026.10.23.1acceleratortypes.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a acceleratorTypes
ArgumentTypeDescription
identifierstringThe name of the acceleratorTypes
fn sync(identifier?: string)
Sync acceleratorTypes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific acceleratorTypes by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List acceleratorTypes resources
ArgumentTypeDescription
filter?stringList filter.
orderBy?stringSort results.
pageSize?numberThe maximum number of items to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A accelerator type that a Node can be configured with.
@swamp/gcp/tpu/locationsv2026.10.30.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn generate_service_identity()
generate service identity

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/tpu/nodesv2026.10.30.1nodes.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
acceleratorConfig?objectThe AccleratorConfig for the TPU Node.
acceleratorType?stringOptional. The type of hardware accelerators associated with this node.
bootDiskConfig?objectOptional. Boot disk configuration.
cidrBlock?stringThe CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR
dataDisks?arrayThe additional data disks for the Node.
description?stringThe user-supplied description of the TPU. Maximum of 512 characters.
health?enumThe health status of the TPU node.
labels?recordResource labels to represent user-provided metadata.
metadata?recordCustom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
networkConfig?objectNetwork configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
networkConfigs?arrayOptional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
runtimeVersion?stringRequired. The runtime version running in the Node.
schedulingConfig?objectThe scheduling options for this node.
serviceAccount?objectThe Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
shieldedInstanceConfig?objectShielded Instance options.
tags?arrayTags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
nodeId?stringThe unqualified resource name.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a nodes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a nodes
ArgumentTypeDescription
identifierstringThe name of the nodes
fn update(identifier?: string, waitForReady?: boolean)
Update nodes attributes
ArgumentTypeDescription
identifier?stringTarget a specific nodes 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 nodes
ArgumentTypeDescription
identifierstringThe name of the nodes
fn sync(identifier?: string)
Sync nodes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific nodes by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List nodes resources
ArgumentTypeDescription
pageSize?numberThe maximum number of items to return.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_guest_attributes(queryPath?: any, workerIds?: any)
get guest attributes
ArgumentTypeDescription
queryPath?any
workerIds?any
fn start()
start
fn stop()
stop

Resources

state(infinite)— A TPU instance.
@swamp/gcp/tpu/queuedresourcesv2026.10.30.1queuedresources.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
guaranteed?objectOptional. The Guaranteed tier
queueingPolicy?objectOptional. The queueing policy of the QueuedRequest.
reservationName?stringOptional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
spot?objectOptional. The Spot tier.
tpu?objectOptional. Defines a TPU resource.
queuedResourceId?stringOptional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.
requestId?stringOptional. Idempotent request UUID.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a queuedResources
fn get(identifier: string)
Get a queuedResources
ArgumentTypeDescription
identifierstringThe name of the queuedResources
fn delete(identifier: string)
Delete the queuedResources
ArgumentTypeDescription
identifierstringThe name of the queuedResources
fn sync(identifier?: string)
Sync queuedResources state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific queuedResources by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List queuedResources resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of items to return.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn reset()
reset

Resources

state(infinite)— A QueuedResource represents a request for resources that will be placed in a ...
@swamp/gcp/tpu/runtimeversionsv2026.10.23.1runtimeversions.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a runtimeVersions
ArgumentTypeDescription
identifierstringThe name of the runtimeVersions
fn sync(identifier?: string)
Sync runtimeVersions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific runtimeVersions by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List runtimeVersions resources
ArgumentTypeDescription
filter?stringList filter.
orderBy?stringSort results.
pageSize?numberThe maximum number of items to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A runtime version that a Node can be configured with.
@swamp/gcp/tpu/tensorflowversionsv2026.10.23.1tensorflowversions.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a tensorflowVersions
ArgumentTypeDescription
identifierstringThe name of the tensorflowVersions
fn sync(identifier?: string)
Sync tensorflowVersions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific tensorflowVersions by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tensorflowVersions resources
ArgumentTypeDescription
filter?stringList filter.
orderBy?stringSort results.
pageSize?numberThe maximum number of items to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A tensorflow version that a Node can be configured with.
04Previous Versions19
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.10.13.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.10.06.1
  • Updated: locations, nodes, queuedresources
2026.10.04.1
  • Updated: locations, nodes, queuedresources
2026.08.12.2
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.07.29.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.07.21.4
  • Added: tensorflowversions
2026.07.21.1
  • Updated: nodes, queuedresources
2026.07.20.2
  • Added: tensorflowversions

Added 1 behaviors

2026.07.20.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions

Removed 1 behaviors

2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.07.18.2
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.07.17.2
  • Updated: nodes
2026.07.17.1
  • Updated: acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.06.08.2
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.06.07.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions, tensorflowversions
2026.06.05.1
  • Added: tensorflowversions

Added 1 behaviors

2026.05.25.1
  • Updated: locations, acceleratortypes, nodes, queuedresources, runtimeversions

Modified 5 behaviors

05Stats
A
100 / 100
Downloads
35
Archive size
59.7 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels