Gcp/batch

@swamp/gcp/batchv2026.07.30.1· 2d agoMODELS

01README

Google Cloud batch infrastructure models

02Release Notes

Updated: jobs

03Models3

@swamp/gcp/batch/jobsv2026.07.30.1jobs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
allocationPolicy?	object	no	Compute resource allocation for all TaskGroups in the Job.
labels?	record	no	Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels
logsPolicy?	object	no	Log preservation policy for the Job.
notifications?	array	no	Notification configurations.
priority	string	yes
taskGroups?	array	no	Required. TaskGroups in the Job. Only one TaskGroup is supported now.
jobId?	string	no	ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be \
requestId?	string	no	Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a jobs

fn get(identifier: string)

Get a jobs

Argument	Type	Required	Description
identifier	string	yes	The name of the jobs

fn delete(identifier: string)

Delete the jobs

Argument	Type	Required	Description
identifier	string	yes	The name of the jobs

fn sync(identifier?: string)

Sync jobs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific jobs by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List jobs resources

Argument	Type	Required	Description
filter?	string	no	List filter.
orderBy?	string	no	Optional. Sort results. Supported are "name", "name desc", "create_time", and "create_time desc".
pageSize?	number	no	Page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel(requestId?: any)

cancel

Argument	Type	Required	Description
requestId?	any	no

Resources

state(infinite)— The Cloud Batch Job description.

@swamp/gcp/batch/jobs-taskgroups-tasksv2026.07.29.1jobs_taskgroups_tasks.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a tasks

Argument	Type	Required	Description
identifier	string	yes	The name of the tasks

fn sync(identifier?: string)

Sync tasks state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific tasks by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List tasks resources

Argument	Type	Required	Description
filter?	string	no	Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
pageSize?	number	no	Page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Cloud Batch task.

@swamp/gcp/batch/locationsv2026.07.29.1locations.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
name	string	yes	The resource that owns the locations collection, if applicable.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync(identifier?: string)

Sync locations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific locations by name (e.g. one discovered by list)

fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)

List locations resources

Argument	Type	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	A 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?	number	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

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

04Previous Versions19

2026.07.29.2Jul 30, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.07.29.1Jul 29, 2026

Updated: jobs

2026.07.21.3Jul 21, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.07.21.1Jul 21, 2026

Updated: jobs

2026.07.20.2Jul 20, 2026

Updated: locations

2026.07.20.1Jul 20, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.07.19.2Jul 19, 2026

Updated: locations

2026.07.19.1Jul 19, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.07.18.2Jul 18, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.07.17.1Jul 17, 2026

Updated: jobs, jobs_taskgroups_tasks

2026.06.08.2Jun 8, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.06.07.1Jun 7, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.05.26.1May 26, 2026

Updated: locations

2026.05.25.1May 25, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

Modified 3 models

2026.05.24.1May 24, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.05.21.2May 21, 2026

Updated: locations, jobs, jobs_taskgroups_tasks

2026.05.21.1May 21, 2026

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

05Stats

100 / 100

Downloads

Archive size

73.3 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #batch #cloud #infrastructure