Gcp/composer
@swamp/gcp/composerv2026.10.24.1
01README
Google Cloud composer infrastructure models
02Release Notes
- Updated: imageversions
03Behaviors
@swamp/gcp/composer/environmentsv2026.10.23.1environments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| config? | object | Optional. Configuration parameters for this environment. |
| labels? | record | Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. |
| mode? | enum | Optional. Selects the environment mode that determines what settings are customizable and what features are available in the environment. |
| name? | string | Identifier. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| state? | enum | The current state of the environment. |
| storageConfig? | object | Optional. Storage configuration for this environment. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a environments
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a environments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the environments |
fn update(identifier?: string, waitForReady?: boolean)
Update environments attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific environments by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the environments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the environments |
fn sync(identifier?: string)
Sync environments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific environments by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List environments resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of environments to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn check_upgrade(imageVersion?: any)
check upgrade
| Argument | Type | Description |
|---|---|---|
| imageVersion? | any |
fn database_failover()
database failover
fn execute_airflow_command(command?: any, parameters?: any, subcommand?: any)
execute airflow command
| Argument | Type | Description |
|---|---|---|
| command? | any | |
| parameters? | any | |
| subcommand? | any |
fn fetch_database_properties()
fetch database properties
fn load_snapshot(skipAirflowOverridesSetting?: any, skipEnvironmentVariablesSetting?: any, skipGcsDataCopying?: any, skipPypiPackagesInstallation?: any, snapshotPath?: any)
load snapshot
| Argument | Type | Description |
|---|---|---|
| skipAirflowOverridesSetting? | any | |
| skipEnvironmentVariablesSetting? | any | |
| skipGcsDataCopying? | any | |
| skipPypiPackagesInstallation? | any | |
| snapshotPath? | any |
fn poll_airflow_command(executionId?: any, nextLineNumber?: any, pod?: any, podNamespace?: any)
poll airflow command
| Argument | Type | Description |
|---|---|---|
| executionId? | any | |
| nextLineNumber? | any | |
| pod? | any | |
| podNamespace? | any |
fn restart_web_server()
restart web server
fn save_snapshot(snapshotLocation?: any)
save snapshot
| Argument | Type | Description |
|---|---|---|
| snapshotLocation? | any |
fn stop_airflow_command(executionId?: any, force?: any, pod?: any, podNamespace?: any)
stop airflow command
| Argument | Type | Description |
|---|---|---|
| executionId? | any | |
| force? | any | |
| pod? | any | |
| podNamespace? | any |
Resources
state(infinite)— An environment for running orchestration tasks.
@swamp/gcp/composer/environments-userworkloadsconfigmapsv2026.10.23.1environments_userworkloadsconfigmaps.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| data? | record | Optional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ Example: { "example_key": "example_value", "another_key": "another_value" } |
| name? | string | Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a userWorkloadsConfigMaps
fn get(identifier: string)
Get a userWorkloadsConfigMaps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userWorkloadsConfigMaps |
fn update(identifier?: string)
Update userWorkloadsConfigMaps attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userWorkloadsConfigMaps by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the userWorkloadsConfigMaps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userWorkloadsConfigMaps |
fn sync(identifier?: string)
Sync userWorkloadsConfigMaps state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userWorkloadsConfigMaps by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List userWorkloadsConfigMaps resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of ConfigMaps to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— User workloads ConfigMap used by Airflow tasks that run with Kubernetes execu...
@swamp/gcp/composer/environments-userworkloadssecretsv2026.10.23.1environments_userworkloadssecrets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| data? | record | Optional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" } |
| name? | string | Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a userWorkloadsSecrets
fn get(identifier: string)
Get a userWorkloadsSecrets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userWorkloadsSecrets |
fn update(identifier?: string)
Update userWorkloadsSecrets attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userWorkloadsSecrets by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the userWorkloadsSecrets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userWorkloadsSecrets |
fn sync(identifier?: string)
Sync userWorkloadsSecrets state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userWorkloadsSecrets by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List userWorkloadsSecrets resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of Secrets to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— User workloads Secret used by Airflow tasks that run with Kubernetes executor...
@swamp/gcp/composer/environments-workloadsv2026.10.23.1environments_workloads.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a workloads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workloads |
fn sync(identifier?: string)
Sync workloads state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workloads by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List workloads resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It\ |
| pageSize? | number | Optional. The maximum number of environments to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Information about a single workload.
@swamp/gcp/composer/imageversionsv2026.10.24.1imageversions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a imageVersions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the imageVersions |
fn sync(identifier?: string)
Sync imageVersions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific imageVersions by name (e.g. one discovered by list) |
fn list(includePastReleases?: boolean, pageSize?: number, maxPages?: number)
List imageVersions resources
| Argument | Type | Description |
|---|---|---|
| includePastReleases? | boolean | Whether or not image versions from old releases should be included. |
| pageSize? | number | The maximum number of image_versions to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— ImageVersion information
04Previous Versions
2026.10.23.3AGPL-3.0-or-later
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.10.23.1AGPL-3.0-or-later
- Updated: imageversions
2026.10.15.1AGPL-3.0-or-later(was none)
- Updated: environments
2026.10.13.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.09.29.1
- Updated: environments_userworkloadsconfigmaps, environments_userworkloadssecrets
2026.08.29.1
- Updated: environments
2026.08.12.2
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.29.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.21.4
- Updated: environments
2026.07.21.1
- Updated: environments
2026.07.20.2
- Updated: environments
2026.07.20.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.19.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.18.2
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.17.2
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets
2026.07.17.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads
2026.07.03.1
- Updated: environments
2026.06.08.2
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.06.07.1
- Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
05Stats
A
100 / 100
Downloads
35
Archive size
76.9 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