Skip to main content

Gcp/saasservicemgmt

@swamp/gcp/saasservicemgmtv2026.10.23.1· AGPL-3.0-or-later· 3d agoBEHAVIORS
01README

Google Cloud saasservicemgmt infrastructure models

02Release Notes
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
03Behaviors8
@swamp/gcp/saasservicemgmt/locationsv2026.10.23.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)

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/saasservicemgmt/releasesv2026.10.23.1releases.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
blueprint?objectOptional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.
inputVariableDefaults?arrayOptional. Mapping of input variables to default values. Maximum 100
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/releases/{release}"
releaseRequirements?objectOptional. Set of requirements to be fulfilled on the Unit when using this Release.
unitKind?stringRequired. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).
releaseId?stringRequired. The ID value for the new release.
requestId?stringAn 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 was receive
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a releases
fn get(identifier: string)
Get a releases
ArgumentTypeDescription
identifierstringThe name of the releases
fn update(identifier?: string)
Update releases attributes
ArgumentTypeDescription
identifier?stringTarget a specific releases by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the releases
ArgumentTypeDescription
identifierstringThe name of the releases
fn sync(identifier?: string)
Sync releases state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific releases by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List releases resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of releases to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A new version to be propagated and deployed to units. This includes pointers ...
@swamp/gcp/saasservicemgmt/rolloutkindsv2026.10.23.1rolloutkinds.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
allowedCount?numberOptional. The maximum number of failed units allowed in a location without pausing the rollout.
allowedPercentage?numberOptional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
rolloutOrchestrationStrategy?stringOptional. The strategy used for executing a Rollout. This is a required field. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the associated UnitKind\
unitFilter?stringOptional. [CEL](https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout.
unitKind?stringOptional. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
unitUpdatePacing?objectOptional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region.
updateUnitKindStrategy?enumOptional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
requestId?stringAn 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 was receive
rolloutKindId?stringRequired. The ID value for the new rollout kind.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a rolloutKinds
fn get(identifier: string)
Get a rolloutKinds
ArgumentTypeDescription
identifierstringThe name of the rolloutKinds
fn update(identifier?: string)
Update rolloutKinds attributes
ArgumentTypeDescription
identifier?stringTarget a specific rolloutKinds by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the rolloutKinds
ArgumentTypeDescription
identifierstringThe name of the rolloutKinds
fn sync(identifier?: string)
Sync rolloutKinds state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rolloutKinds by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List rolloutKinds resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of rollout kinds to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An object that describes various settings of Rollout execution. Includes buil...
@swamp/gcp/saasservicemgmt/rolloutsv2026.10.23.1rollouts.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
control?objectOptional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
release?stringOptional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
rolloutKind?stringRequired. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
rolloutOrchestrationStrategy?stringOptional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind\
unitFilter?stringOptional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.
requestId?stringAn 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 was receive
rolloutId?stringRequired. The ID value for the new rollout.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a rollouts
fn get(identifier: string)
Get a rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
fn update(identifier?: string)
Update rollouts attributes
ArgumentTypeDescription
identifier?stringTarget a specific rollouts by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
fn sync(identifier?: string)
Sync rollouts state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rollouts by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List rollouts resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of rollouts to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Represents a single rollout execution and its results
@swamp/gcp/saasservicemgmt/saasv2026.10.23.1saas.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
applicationTemplate?objectOptional. Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions.
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
locations?arrayOptional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}"
requestId?stringAn 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 was receive
saasId?stringRequired. The ID value for the new saas.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a saas
fn get(identifier: string)
Get a saas
ArgumentTypeDescription
identifierstringThe name of the saas
fn update(identifier?: string)
Update saas attributes
ArgumentTypeDescription
identifier?stringTarget a specific saas by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the saas
ArgumentTypeDescription
identifierstringThe name of the saas
fn sync(identifier?: string)
Sync saas state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific saas by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List saas resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of saas to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Saas is a representation of a SaaS service managed by the Producer.
@swamp/gcp/saasservicemgmt/tenantsv2026.10.23.1tenants.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
consumerResource?stringOptional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}"
saas?stringRequired. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model.
requestId?stringAn 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 was receive
tenantId?stringRequired. The ID value for the new tenant.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a tenants
fn get(identifier: string)
Get a tenants
ArgumentTypeDescription
identifierstringThe name of the tenants
fn update(identifier?: string)
Update tenants attributes
ArgumentTypeDescription
identifier?stringTarget a specific tenants by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the tenants
ArgumentTypeDescription
identifierstringThe name of the tenants
fn sync(identifier?: string)
Sync tenants state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific tenants by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tenants resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of tenants to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Tenant represents the service producer side of an instance of the service cre...
@swamp/gcp/saasservicemgmt/unitkindsv2026.10.23.1unitkinds.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
appParams?objectOptional. AppParams contains the parameters for creating an AppHub Application.
applicationTemplateComponent?objectOptional. Reference to component and revision in a composite ApplicationTemplate.
defaultRelease?stringOptional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.
dependencies?arrayOptional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.
inputVariableMappings?arrayOptional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitKinds/{unitKind}"
outputVariableMappings?arrayOptional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.
saas?stringRequired. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.
requestId?stringAn 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 was receive
unitKindId?stringRequired. The ID value for the new unit kind.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a unitKinds
fn get(identifier: string)
Get a unitKinds
ArgumentTypeDescription
identifierstringThe name of the unitKinds
fn update(identifier?: string)
Update unitKinds attributes
ArgumentTypeDescription
identifier?stringTarget a specific unitKinds by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the unitKinds
ArgumentTypeDescription
identifierstringThe name of the unitKinds
fn sync(identifier?: string)
Sync unitKinds state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific unitKinds by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List unitKinds resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of unit kinds to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Definition of a Unit. Units belonging to the same UnitKind are managed togeth...
@swamp/gcp/saasservicemgmt/unitsv2026.10.23.1units.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.
annotations?recordOptional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
application?stringOptional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application.
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
maintenance?objectOptional. Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.
managementMode?enumOptional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
name?stringIdentifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
tenant?stringOptional. Reference to the Saas Tenant resource this unit belongs to. This for example informs the maintenance policies to use for scheduling future updates on a unit. (optional and immutable once created)
unitKind?stringOptional. Reference to the UnitKind this Unit belongs to. Immutable once set.
requestId?stringAn 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 was receive
unitId?stringRequired. The ID value for the new unit.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a units
fn get(identifier: string)
Get a units
ArgumentTypeDescription
identifierstringThe name of the units
fn update(identifier?: string)
Update units attributes
ArgumentTypeDescription
identifier?stringTarget a specific units by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the units
ArgumentTypeDescription
identifierstringThe name of the units
fn sync(identifier?: string)
Sync units state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific units by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List units resources
ArgumentTypeDescription
filter?stringFilter the list as specified in https://google.aip.dev/160.
orderBy?stringOrder results as specified in https://google.aip.dev/132.
pageSize?numberThe maximum number of units to send per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A unit of deployment that has its lifecycle via a CRUD API using an actuation...
04Previous Versions19
2026.10.15.1AGPL-3.0-or-later(was none)
  • Updated: releases, rollouts, saas, unitkinds, units
2026.10.13.1
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.10.08.1
  • Updated: releases, rolloutkinds, unitkinds, units
2026.09.26.1
  • Updated: rolloutkinds
2026.08.12.2
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.29.1
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.21.4
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.21.1
  • Updated: releases, rolloutkinds, rollouts, saas, unitkinds, units
2026.07.20.2
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.20.1
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.18.2
  • Updated: locations, releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.17.2
  • Updated: releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.07.17.1
  • Updated: releases, rolloutkinds, rollouts, saas, tenants, unitkinds, units
2026.06.24.1
  • Updated: rolloutkinds, unitkinds, units

Removed 2 behaviors

2026.06.12.1
  • Updated: rolloutkinds, saasreleases, unitgroups
2026.06.08.2
  • Updated: locations, releases, rolloutkinds, rollouts, saas, saasreleases, tenants, unitgroups, unitkinds, units
2026.06.07.1
  • Updated: locations, releases, rolloutkinds, rollouts, saas, saasreleases, tenants, unitgroups, unitkinds, units
05Stats
A
100 / 100
Downloads
35
Archive size
104.5 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