Skip to main content
← back to extensions

@swamp/gcp/apim

v2026.04.23.1

Google Cloud apim infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudapimcloudinfrastructure

Contents

models

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

@swamp/gcp/apim/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
get_entitlementget entitlement
list_api_observation_tagslist api observation tags

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/apim/observationjobsv2026.04.23.1observationjobs.ts

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}
sources?arrayOptional. These should be of the same kind of source.
observationJobId?stringRequired. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.
requestId?stringOptional. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a observationJobs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a observationJobs
ArgumentTypeDescription
identifierstringThe name of the observationJobs
deleteDelete the observationJobs
ArgumentTypeDescription
identifierstringThe name of the observationJobs
syncSync observationJobs state from GCP
disabledisable
enableenable

Resources

state(infinite)— Message describing ObservationJob object
@swamp/gcp/apim/observationjobs-apiobservationsv2026.04.23.1observationjobs_apiobservations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a apiObservations
ArgumentTypeDescription
identifierstringThe name of the apiObservations
syncSync apiObservations state from GCP
batch_edit_tagsbatch edit tags
ArgumentTypeDescription
requests?any

Resources

state(infinite)— Message describing ApiObservation object
@swamp/gcp/apim/observationsourcesv2026.04.23.1observationsources.ts

Global Arguments

ArgumentTypeDescription
gclbObservationSource?objectThe GCLB observation source.
name?stringIdentifier. name of resource For MVP, each region can only have 1 source.
observationSourceId?stringRequired. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/.
requestId?stringOptional. 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?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a observationSources
getGet a observationSources
ArgumentTypeDescription
identifierstringThe name of the observationSources
deleteDelete the observationSources
ArgumentTypeDescription
identifierstringThe name of the observationSources
syncSync observationSources state from GCP

Resources

state(infinite)— Observation source configuration types