Skip to main content

@swamp/gcp/saasservicemgmt

v2026.04.23.1

Google Cloud saasservicemgmt infrastructure models

Repository

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

Labels

gcpgoogle-cloudsaasservicemgmtcloudinfrastructure

Contents

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

@swamp/gcp/saasservicemgmt/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/saasservicemgmt/releasesv2026.04.23.1releases.ts

Global Arguments

ArgumentTypeDescription
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?objectBlueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev).
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?objectSet 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')
createCreate a releases
getGet a releases
ArgumentTypeDescription
identifierstringThe name of the releases
updateUpdate releases attributes
deleteDelete the releases
ArgumentTypeDescription
identifierstringThe name of the releases
syncSync releases state from GCP

Resources

state(infinite)— A new version to be propagated and deployed to units. This includes pointers ...
@swamp/gcp/saasservicemgmt/rolloutkindsv2026.04.23.1rolloutkinds.ts

Global Arguments

ArgumentTypeDescription
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?stringRequired. 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.
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')
createCreate a rolloutKinds
getGet a rolloutKinds
ArgumentTypeDescription
identifierstringThe name of the rolloutKinds
updateUpdate rolloutKinds attributes
deleteDelete the rolloutKinds
ArgumentTypeDescription
identifierstringThe name of the rolloutKinds
syncSync rolloutKinds state from GCP

Resources

state(infinite)— An object that describes various settings of Rollout execution. Includes buil...
@swamp/gcp/saasservicemgmt/rolloutsv2026.04.23.1rollouts.ts

Global Arguments

ArgumentTypeDescription
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?objectRolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it.
flagRelease?stringOptional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted.
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\
stats?objectRolloutStats contains information about the progress of a rollout.
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')
createCreate a rollouts
getGet a rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
updateUpdate rollouts attributes
deleteDelete the rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
syncSync rollouts state from GCP

Resources

state(infinite)— Represents a single rollout execution and its results
@swamp/gcp/saasservicemgmt/saasv2026.04.23.1saas.ts

Global Arguments

ArgumentTypeDescription
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
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
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')
createCreate a saas
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a saas
ArgumentTypeDescription
identifierstringThe name of the saas
updateUpdate saas attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the saas
ArgumentTypeDescription
identifierstringThe name of the saas
syncSync saas state from GCP

Resources

state(infinite)— Saas is a representation of a SaaS service managed by the Producer.
@swamp/gcp/saasservicemgmt/tenantsv2026.04.23.1tenants.ts

Global Arguments

ArgumentTypeDescription
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')
createCreate a tenants
getGet a tenants
ArgumentTypeDescription
identifierstringThe name of the tenants
updateUpdate tenants attributes
deleteDelete the tenants
ArgumentTypeDescription
identifierstringThe name of the tenants
syncSync tenants state from GCP

Resources

state(infinite)— Tenant represents the service producer side of an instance of the service cre...
@swamp/gcp/saasservicemgmt/unitkindsv2026.04.23.1unitkinds.ts

Global Arguments

ArgumentTypeDescription
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
defaultFlagRevisions?arrayOptional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.
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')
createCreate a unitKinds
getGet a unitKinds
ArgumentTypeDescription
identifierstringThe name of the unitKinds
updateUpdate unitKinds attributes
deleteDelete the unitKinds
ArgumentTypeDescription
identifierstringThe name of the unitKinds
syncSync unitKinds state from GCP

Resources

state(infinite)— Definition of a Unit. Units belonging to the same UnitKind are managed togeth...
@swamp/gcp/saasservicemgmt/unitsv2026.04.23.1units.ts

Global Arguments

ArgumentTypeDescription
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
labels?recordOptional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
maintenance?objectCaptures 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')
createCreate a units
getGet a units
ArgumentTypeDescription
identifierstringThe name of the units
updateUpdate units attributes
deleteDelete the units
ArgumentTypeDescription
identifierstringThe name of the units
syncSync units state from GCP

Resources

state(infinite)— A unit of deployment that has its lifecycle via a CRUD API using an actuation...