Gcp/workloadmanager

@swamp/gcp/workloadmanagerv2026.06.12.1· 3d agoMODELS

01README

Google Cloud workloadmanager infrastructure models

02Release Notes

Updated: deployments, deployments_actuations

03Models10

@swamp/gcp/workloadmanager/deploymentsv2026.06.12.1deployments.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.
description?	string	no	Description of the deployment.
name?	string	no	The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
sapSystemS4Config?	object	no	Message for SAP system workload.
serviceAccount?	string	no	User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation.
sqlServerWorkload?	object	no	Message for MS SQL workload.
terraformVariables?	record	no	Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
workerPool?	string	no	Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
workloadType?	enum	no	Optional. Workload type of the deployment.
deploymentId?	string	no	Required. ID of the deployment.
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(waitForReady?: boolean)

Create a deployments

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a deployments

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

fn delete(identifier: string)

Delete the deployments

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

fn sync()

Sync deployments state from GCP

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

List deployments resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter resource following https://google.aip.dev/160.
orderBy?	string	no	Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— The Deployment object represents user intent for deploying a specific type of...

@swamp/gcp/workloadmanager/deployments-actuationsv2026.06.12.1deployments_actuations.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.
actuationOutput?	object	no	Message for output of actuation.
name?	string	no	The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.
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(waitForReady?: boolean)

Create a actuations

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a actuations

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

fn delete(identifier: string)

Delete the actuations

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

fn sync()

Sync actuations state from GCP

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

List actuations resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— The Actuation object represents the bootstrap state and output results of dep...

@swamp/gcp/workloadmanager/discoveredprofilesv2026.06.08.1discoveredprofiles.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.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a discoveredprofiles

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

fn sync()

Sync discoveredprofiles state from GCP

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

List discoveredprofiles resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Workload resource.

@swamp/gcp/workloadmanager/discoveredprofiles-healthv2026.06.08.1discoveredprofiles_health.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.

fn get(identifier: string)

Get a health

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

fn sync()

Sync health state from GCP

Resources

state(infinite)— WorkloadProfileHealth contains the detailed health check of workload.

@swamp/gcp/workloadmanager/evaluationsv2026.06.08.1evaluations.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.
bigQueryDestination?	object	no	BigQuery destination for evaluation results.
customRulesBucket?	string	no	The Cloud Storage bucket name for custom rules.
description?	string	no	Description of the Evaluation.
evaluationType?	enum	no	Evaluation type.
kmsKey?	string	no	Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/. The key will be used for CMEK encryption of the evaluation resource.
labels?	record	no	Labels as key value pairs.
name?	string	no	Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
resourceFilter?	object	no	Resource filter for an evaluation defining the scope of resources to be evaluated.
resourceStatus?	object	no	The lifecycle status of an Evaluation resource.
ruleNames?	array	no	The names of the rules used for this evaluation.
schedule?	string	no	Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 /1 * ` # Hourly `0 /6 * ` # Every 6 hours `0 /12 * ` # Every 12 hours `0 0 /1 ` # Daily `0 0 /7 ` # Weekly `0 0 /14 ` # Every 14 days `0 0 1 /1 ` # Monthly
evaluationId?	string	no	Required. Id of the requesting object.
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 evaluations

fn get(identifier: string)

Get a evaluations

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

fn update()

Update evaluations attributes

fn delete(identifier: string)

Delete the evaluations

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

fn sync()

Sync evaluations state from GCP

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

List evaluations resources

Argument	Type	Required	Description
filter?	string	no	Filter to be applied when listing the evaluation results.
orderBy?	string	no	Hint for how to order the results.
pageSize?	number	no	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Represents a Workload Manager Evaluation configuration. An Evaluation defines...

@swamp/gcp/workloadmanager/evaluations-executionsv2026.06.08.1evaluations_executions.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.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a executions

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

fn delete(identifier: string)

Delete the executions

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

fn sync()

Sync executions state from GCP

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

List executions resources

Argument	Type	Required	Description
filter?	string	no	Filtering results.
orderBy?	string	no	Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn run(execution?: any, executionId?: any, requestId?: any)

run

Argument	Type	Required
execution?	any	no
executionId?	any	no
requestId?	any	no

Resources

state(infinite)— Execution that represents a single run of an Evaluation.

@swamp/gcp/workloadmanager/evaluations-executions-resultsv2026.06.08.1evaluations_executions_results.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.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a results

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

fn sync()

Sync results state from GCP

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

List results resources

Argument	Type	Required	Description
filter?	string	no	Filtering results.
pageSize?	number	no	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— The result of an execution.

@swamp/gcp/workloadmanager/evaluations-executions-scannedresourcesv2026.06.08.1evaluations_executions_scannedresources.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.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a scannedResources

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

fn sync()

Sync scannedResources state from GCP

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

List scannedResources resources

Argument	Type	Required	Description
filter?	string	no	Filtering results.
orderBy?	string	no	Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
rule?	string	no	Rule name.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A scanned resource.

@swamp/gcp/workloadmanager/locationsv2026.06.08.1locations.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.

fn get(identifier: string)

Get a locations

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

fn sync()

Sync locations state from GCP

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.

@swamp/gcp/workloadmanager/rulesv2026.06.08.1rules.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.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a rules

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

fn sync()

Sync rules state from GCP

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

List rules resources

Argument	Type	Required	Description
customRulesBucket?	string	no	The Cloud Storage bucket name for custom rules.
evaluationType?	string	no	Optional. The evaluation type of the rules will be applied to. The Cloud Storage bucket name for custom rules.
filter?	string	no	Filter based on primary_category, secondary_category.
pageSize?	number	no	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A rule to be evaluated.

04Previous Versions17

2026.06.08.2Jun 8, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.06.07.1Jun 7, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.05.27.1May 27, 2026

Updated: discoveredprofiles_health

2026.05.26.1May 26, 2026

Updated: locations

2026.05.25.1May 25, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

Modified 9 models

2026.05.24.1May 24, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.05.21.2May 21, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.05.21.1May 21, 2026

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.05.18.1May 18, 2026

2026.04.23.1Apr 23, 2026

2026.04.04.1Apr 4, 2026

Updated: discoveredprofiles, discoveredprofiles_health

2026.04.03.3Apr 3, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.04.03.1Apr 3, 2026

Updated: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

2026.04.02.2Apr 2, 2026

2026.03.27.1Mar 27, 2026

Added: locations, deployments, deployments_actuations, discoveredprofiles, discoveredprofiles_health, evaluations, evaluations_executions, evaluations_executions_results, evaluations_executions_scannedresources, rules

05Stats

100 / 100

Downloads

Archive size

86.4 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 #workloadmanager #cloud #infrastructure