Gcp/apigateway
@swamp/gcp/apigatewayv2026.10.23.1
01README
Google Cloud apigateway infrastructure models
02Release Notes
- Updated: locations, apis, apis_configs, gateways
03Behaviors
@swamp/gcp/apigateway/apisv2026.10.23.1apis.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. |
| displayName? | string | Optional. Display name. |
| labels? | record | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| managedService? | string | Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. |
| apiId? | string | Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a apis
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
fn update(identifier?: string, waitForReady?: boolean)
Update apis attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific apis 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 apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
fn sync(identifier?: string)
Sync apis state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific apis by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List apis resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter. |
| orderBy? | string | Order by parameters. |
| pageSize? | number | Page size. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— An API that can be served by one or more Gateways.
@swamp/gcp/apigateway/apis-configsv2026.10.23.1apis_configs.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. |
| displayName? | string | Optional. Display name. |
| gatewayServiceAccount? | string | Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service. |
| grpcServices? | array | Optional. gRPC service definition files. If specified, openapi_documents must not be included. |
| labels? | record | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| managedServiceConfigs? | array | Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merge |
| openapiDocuments? | array | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. |
| apiConfigId? | string | Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
| 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(waitForReady?: boolean)
Create a configs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a configs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the configs |
fn update(identifier?: string, waitForReady?: boolean)
Update configs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific configs 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 configs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the configs |
fn sync(identifier?: string)
Sync configs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific configs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List configs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter. |
| orderBy? | string | Order by parameters. |
| pageSize? | number | Page size. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— An API Configuration is a combination of settings for both the Managed Servic...
@swamp/gcp/apigateway/gatewaysv2026.10.23.1gateways.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. |
| apiConfig? | string | Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} |
| displayName? | string | Optional. Display name. |
| labels? | record | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| streamingMode? | enum | Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. |
| gatewayId? | string | Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a gateways
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a gateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the gateways |
fn update(identifier?: string, waitForReady?: boolean)
Update gateways attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific gateways 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 gateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the gateways |
fn sync(identifier?: string)
Sync gateways state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific gateways by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List gateways resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter. |
| orderBy? | string | Order by parameters. |
| pageSize? | number | Page size. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consu...
@swamp/gcp/apigateway/locationsv2026.10.23.1locations.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. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | 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 | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.10.21.1AGPL-3.0-or-later(was none)
- Updated: gateways
2026.10.13.1
- Updated: locations, apis, apis_configs, gateways
2026.09.07.2
- Updated: apis, apis_configs, gateways
2026.09.06.1
- Updated: gateways
2026.08.12.2
- Updated: locations, apis, apis_configs, gateways
2026.07.29.1
- Updated: locations, apis, apis_configs, gateways
2026.07.21.4
- Updated: locations, apis, apis_configs, gateways
2026.07.21.1
- Updated: apis_configs
2026.07.20.2
- Updated: locations
2026.07.20.1
- Updated: locations, apis, apis_configs, gateways
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, apis, apis_configs, gateways
2026.07.18.2
- Updated: locations, apis, apis_configs, gateways
2026.07.17.2
- Updated: apis, apis_configs, gateways
2026.07.17.1
- Updated: apis, apis_configs, gateways
2026.06.08.2
- Updated: locations, apis, apis_configs, gateways
2026.06.07.1
- Updated: locations, apis, apis_configs, gateways
2026.05.26.1
- Updated: locations
2026.05.25.1
- Updated: locations, apis, apis_configs, gateways
Modified 4 behaviors
05Stats
A
100 / 100
Downloads
35
Archive size
50.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