Skip to main content
← back to extensions

@swamp/gcp/run

v2026.04.23.1

Google Cloud run infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudruncloudinfrastructure

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/run

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

Global Arguments

ArgumentTypeDescription
annotations?record
binaryAuthorization?objectSettings for Binary Authorization feature.
client?stringArbitrary identifier for the API client.
clientVersion?stringArbitrary version identifier for the API client.
containers?arrayRequired. Holds the single container that defines the unit of execution for this Instance.
description?stringUser-provided description of the Instance. This field currently has a 512-character limit.
encryptionKey?stringA reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
encryptionKeyRevocationAction?enumThe action to take if the encryption key is revoked.
encryptionKeyShutdownDuration?stringIf encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
gpuZonalRedundancyDisabled?booleanOptional. True if GPU zonal redundancy is disabled on this instance.
iapEnabled?booleanOptional. IAP settings on the Instance.
ingress?enumOptional. Provides the ingress settings for this Instance. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
invokerIamDisabled?booleanOptional. Disables IAM permission check for run.routes.invoke for callers of this Instance. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
labels?record
launchStage?enumThe launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
name?stringThe fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id. Format: projects/{project}/locations/{location}/instances/{instance_id}
nodeSelector?objectHardware constraints configuration.
serviceAccount?string
terminalCondition?objectDefines a status condition for a resource.
timeout?stringOptional. Duration the instance may be active before the system will shut it down.
volumes?arrayA list of Volumes to make available to containers.
vpcAccess?objectVPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
instanceId?stringOptional. The unique identifier for the Instance. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the instance becomes {parent}/instances/{instance_id}. If not provided, the server will generate a unique `instance_id`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a instances
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
updateUpdate instances attributes
deleteDelete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
syncSync instances state from GCP
startstart
ArgumentTypeDescription
etag?any
validateOnly?any
stopstop
ArgumentTypeDescription
etag?any
validateOnly?any

Resources

state(infinite)— A Cloud Run Instance represents a single group of containers running in a reg...
@swamp/gcp/run/jobsv2026.04.23.1jobs.ts

Global Arguments

ArgumentTypeDescription
annotations?recordUnstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, lim
binaryAuthorization?objectSettings for Binary Authorization feature.
client?stringArbitrary identifier for the API client.
clientVersion?stringArbitrary version identifier for the API client.
labels?recordUnstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `se
latestCreatedExecution?objectReference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.
launchStage?enumThe launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
name?stringThe fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
runExecutionToken?stringA unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
startExecutionToken?stringA unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
template?objectExecutionTemplate describes the data an execution should have when created from a template.
terminalCondition?objectDefines a status condition for a resource.
jobId?stringOptional. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}. If not provided, the server will generate a unique `job_id`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a jobs
getGet a jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
updateUpdate jobs attributes
deleteDelete the jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
syncSync jobs state from GCP
runrun
ArgumentTypeDescription
etag?any
overrides?any
validateOnly?any

Resources

state(infinite)— Job represents the configuration of a single job, which references a containe...
@swamp/gcp/run/jobs-executionsv2026.04.23.1jobs_executions.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 executions
ArgumentTypeDescription
identifierstringThe name of the executions
deleteDelete the executions
ArgumentTypeDescription
identifierstringThe name of the executions
syncSync executions state from GCP
cancelcancel
ArgumentTypeDescription
etag?any
validateOnly?any
export_statusexport status

Resources

state(infinite)— Execution represents the configuration of a single execution. A execution an ...
@swamp/gcp/run/jobs-executions-tasksv2026.04.23.1jobs_executions_tasks.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 tasks
ArgumentTypeDescription
identifierstringThe name of the tasks
syncSync tasks state from GCP

Resources

state(infinite)— Task represents a single run of a container to completion.
@swamp/gcp/run/servicesv2026.04.23.1services.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' na
binaryAuthorization?objectSettings for Binary Authorization feature.
buildConfig?objectDescribes the Build step of the function that builds a container from the given source.
client?stringArbitrary identifier for the API client.
clientVersion?stringArbitrary version identifier for the API client.
customAudiences?arrayOne or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
defaultUriDisabled?booleanOptional. Disables public resolution of the default URI of this service.
description?stringUser-provided description of the Service. This field currently has a 512-character limit.
iapEnabled?booleanOptional. IAP settings on the Service.
ingress?enumOptional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
invokerIamDisabled?booleanOptional. Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis
launchStage?enumOptional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA o
multiRegionSettings?objectSettings for multi-region deployment.
name?stringIdentifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}
scaling?objectScaling settings applied at the service level rather than at the revision level.
template?objectRevisionTemplate describes the data a revision should have when created from a template.
terminalCondition?objectDefines a status condition for a resource.
traffic?arrayOptional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision.
serviceId?stringOptional. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}. If not provided, the server will generate a unique `service_id`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a services
getGet a services
ArgumentTypeDescription
identifierstringThe name of the services
updateUpdate services attributes
deleteDelete the services
ArgumentTypeDescription
identifierstringThe name of the services
syncSync services state from GCP

Resources

state(infinite)— Service acts as a top-level container that manages a set of configurations an...
@swamp/gcp/run/services-revisionsv2026.04.23.1services_revisions.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 revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
deleteDelete the revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
syncSync revisions state from GCP
export_statusexport status

Resources

state(infinite)— A Revision is an immutable snapshot of code and configuration. A Revision ref...
@swamp/gcp/run/workerpoolsv2026.04.23.1workerpools.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations'
binaryAuthorization?objectSettings for Binary Authorization feature.
client?stringArbitrary identifier for the API client.
clientVersion?stringArbitrary version identifier for the API client.
description?stringUser-provided description of the WorkerPool. This field currently has a 512-character limit.
instanceSplits?arrayOptional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.
labels?recordOptional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis
launchStage?enumOptional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA o
name?stringThe fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}`
scaling?objectWorker pool scaling settings.
template?objectWorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template.
terminalCondition?objectDefines a status condition for a resource.
workerPoolId?stringOptional. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes `{parent}/workerPools/{worker_pool_id}`. If not provided, the server will generate a unique `worker_pool_id`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a workerPools
getGet a workerPools
ArgumentTypeDescription
identifierstringThe name of the workerPools
updateUpdate workerPools attributes
deleteDelete the workerPools
ArgumentTypeDescription
identifierstringThe name of the workerPools
syncSync workerPools state from GCP

Resources

state(infinite)— WorkerPool acts as a top-level container that manages a set of configurations...
@swamp/gcp/run/workerpools-revisionsv2026.04.23.1workerpools_revisions.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 revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
deleteDelete the revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
syncSync revisions state from GCP

Resources

state(infinite)— A Revision is an immutable snapshot of code and configuration. A Revision ref...