Skip to main content

Gcp/managedkafka

@swamp/gcp/managedkafkav2026.09.15.1· 1d agoMODELS
01README

Google Cloud managedkafka infrastructure models

02Release Notes
  • Updated: clusters
03Models27
@swamp/gcp/managedkafka/clustersv2026.09.15.1clusters.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.
brokerCapacityConfig?objectOptional. Capacity configuration at a per-broker level within the Kafka cluster. The config will be appled to each broker in the cluster.
capacityConfig?objectRequired. Capacity configuration for the Kafka cluster.
gcpConfig?objectRequired. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
kafkaVersion?stringOptional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`.
labels?recordOptional. Labels as key value pairs.
name?stringIdentifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
rebalanceConfig?objectOptional. Rebalance configuration for the Kafka cluster.
tlsConfig?objectOptional. TLS configuration for the Kafka cluster.
updateOptions?objectOptional. UpdateOptions represents options that control how updates to the cluster are applied.
clusterId?stringRequired. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a clusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
fn update(identifier?: string, waitForReady?: boolean)
Update clusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific clusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
fn sync(identifier?: string)
Sync clusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific clusters by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List clusters resources
ArgumentTypeDescription
filter?stringOptional. Filter expression for the result.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An Apache Kafka cluster deployed in a location.
@swamp/gcp/managedkafka/clusters-aclsv2026.08.12.2clusters_acls.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.
aclEntries?arrayRequired. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
name?stringIdentifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}` F
aclId?stringRequired. The ID to use for the acl, which will become the final component of the acl\
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a acls
fn get(identifier: string)
Get a acls
ArgumentTypeDescription
identifierstringThe name of the acls
fn update(identifier?: string)
Update acls attributes
ArgumentTypeDescription
identifier?stringTarget a specific acls by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the acls
ArgumentTypeDescription
identifierstringThe name of the acls
fn sync(identifier?: string)
Sync acls state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific acls by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List acls resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of acls to return. The service may return fewer than this value. If unset or zero, all acls for the parent is returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn add_acl_entry(host?: any, operation?: any, permissionType?: any, principal?: any)
add acl entry
ArgumentTypeDescription
host?any
operation?any
permissionType?any
principal?any

Resources

state(infinite)— Represents the set of ACLs for a given Kafka Resource Pattern, which consists...
@swamp/gcp/managedkafka/clusters-consumergroupsv2026.08.12.2clusters_consumergroups.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.
name?stringIdentifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
topics?recordOptional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a consumerGroups
ArgumentTypeDescription
identifierstringThe name of the consumerGroups
fn update(identifier?: string)
Update consumerGroups attributes
ArgumentTypeDescription
identifier?stringTarget a specific consumerGroups by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the consumerGroups
ArgumentTypeDescription
identifierstringThe name of the consumerGroups
fn sync(identifier?: string)
Sync consumerGroups state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific consumerGroups by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)
List consumerGroups resources
ArgumentTypeDescription
filter?stringOptional. Filter expression for the result. Only supports filtering by topic name as a key in the `topics` map.
pageSize?numberOptional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
view?stringOptional. Specifies the view (BASIC or FULL) of the ConsumerGroup resource to be returned in the response. Defaults to FULL view.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Kafka consumer group in a given cluster.
@swamp/gcp/managedkafka/clusters-topicsv2026.08.12.2clusters_topics.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.
configs?recordOptional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`.
name?stringIdentifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
partitionCount?numberRequired. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected.
replicationFactor?numberRequired. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
topicId?stringRequired. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a topics
fn get(identifier: string)
Get a topics
ArgumentTypeDescription
identifierstringThe name of the topics
fn update(identifier?: string)
Update topics attributes
ArgumentTypeDescription
identifier?stringTarget a specific topics by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the topics
ArgumentTypeDescription
identifierstringThe name of the topics
fn sync(identifier?: string)
Sync topics state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific topics by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List topics resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Kafka topic in a given cluster.
@swamp/gcp/managedkafka/connectclustersv2026.08.12.2connectclusters.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.
capacityConfig?objectRequired. Capacity configuration for the Kafka Connect cluster.
config?recordOptional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now.
gcpConfig?objectRequired. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.
kafkaCluster?stringRequired. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
labels?recordOptional. Labels as key value pairs.
name?stringIdentifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
connectClusterId?stringRequired. The ID to use for the Connect cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a connectClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a connectClusters
ArgumentTypeDescription
identifierstringThe name of the connectClusters
fn update(identifier?: string, waitForReady?: boolean)
Update connectClusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific connectClusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the connectClusters
ArgumentTypeDescription
identifierstringThe name of the connectClusters
fn sync(identifier?: string)
Sync connectClusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific connectClusters by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List connectClusters resources
ArgumentTypeDescription
filter?stringOptional. Filter expression for the result.
orderBy?stringOptional. Order by fields for the result.
pageSize?numberOptional. The maximum number of Connect clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An Apache Kafka Connect cluster deployed in a location.
@swamp/gcp/managedkafka/connectclusters-connectorsv2026.08.12.2connectclusters_connectors.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.
configs?recordOptional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
name?stringIdentifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
taskRestartPolicy?objectOptional. Restarts the individual tasks of a Connector.
connectorId?stringRequired. The ID to use for the connector, which will become the final component of the connector's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-connector-id`.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a connectors
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a connectors
ArgumentTypeDescription
identifierstringThe name of the connectors
fn update(identifier?: string, waitForReady?: boolean)
Update connectors attributes
ArgumentTypeDescription
identifier?stringTarget a specific connectors by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the connectors
ArgumentTypeDescription
identifierstringThe name of the connectors
fn sync(identifier?: string)
Sync connectors state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific connectors by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List connectors resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn pause()
pause
fn restart()
restart
fn resume()
resume
fn stop()
stop

Resources

state(infinite)— A Kafka Connect connector in a given ConnectCluster.
@swamp/gcp/managedkafka/locationsv2026.08.12.2locations.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/managedkafka/schemaregistriesv2026.08.12.2schemaregistries.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
schemaRegistry?objectRequired. The schema registry instance to create. The name field is ignored.
schemaRegistryId?stringRequired. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a schemaRegistries
fn get(identifier: string)
Get a schemaRegistries
ArgumentTypeDescription
identifierstringThe name of the schemaRegistries
fn delete(identifier: string)
Delete the schemaRegistries
ArgumentTypeDescription
identifierstringThe name of the schemaRegistries
fn sync(identifier?: string)
Sync schemaRegistries state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific schemaRegistries by name (e.g. one discovered by list)
fn list(view?: string, maxPages?: number)
List schemaRegistries resources
ArgumentTypeDescription
view?stringOptional. Specifies the view to return for the schema registry instances. If not specified, the default view is SCHEMA_REGISTRY_VIEW_BASIC.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— SchemaRegistry is a schema registry instance.
@swamp/gcp/managedkafka/schemaregistries-configv2026.08.12.2schemaregistries_config.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
compatibility?enumRequired. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
normalize?booleanOptional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
fn get(identifier: string)
Get a config
ArgumentTypeDescription
identifierstringThe name of the config
fn update(identifier?: string)
Update config attributes
ArgumentTypeDescription
identifier?stringTarget a specific config by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the config
ArgumentTypeDescription
identifierstringThe name of the config
fn sync(identifier?: string)
Sync config state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific config by name (e.g. one discovered by list)

Resources

state(infinite)— SchemaConfig represents configuration for a schema registry or a specific sub...
@swamp/gcp/managedkafka/schemaregistries-contextsv2026.08.12.2schemaregistries_contexts.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a contexts
ArgumentTypeDescription
identifierstringThe name of the contexts
fn sync(identifier?: string)
Sync contexts state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific contexts by name (e.g. one discovered by list)
fn list(maxPages?: number)
List contexts resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Context represents an independent schema grouping in a schema registry instance.
@swamp/gcp/managedkafka/schemaregistries-contexts-configv2026.08.12.2schemaregistries_contexts_config.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
compatibility?enumRequired. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
normalize?booleanOptional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
fn get(identifier: string)
Get a config
ArgumentTypeDescription
identifierstringThe name of the config
fn update(identifier?: string)
Update config attributes
ArgumentTypeDescription
identifier?stringTarget a specific config by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the config
ArgumentTypeDescription
identifierstringThe name of the config
fn sync(identifier?: string)
Sync config state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific config by name (e.g. one discovered by list)

Resources

state(infinite)— SchemaConfig represents configuration for a schema registry or a specific sub...
@swamp/gcp/managedkafka/schemaregistries-contexts-modev2026.08.12.2schemaregistries_contexts_mode.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
mode?enumRequired. The mode type.
fn get(identifier: string)
Get a mode
ArgumentTypeDescription
identifierstringThe name of the mode
fn update(identifier?: string)
Update mode attributes
ArgumentTypeDescription
identifier?stringTarget a specific mode by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the mode
ArgumentTypeDescription
identifierstringThe name of the mode
fn sync(identifier?: string)
Sync mode state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific mode by name (e.g. one discovered by list)

Resources

state(infinite)— SchemaMode represents the mode of a schema registry or a specific subject. Fo...
@swamp/gcp/managedkafka/schemaregistries-contexts-schemasv2026.09.07.1schemaregistries_contexts_schemas.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
fn get(identifier: string)
Get a schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
fn sync(identifier?: string)
Sync schemas state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific schemas by name (e.g. one discovered by list)
fn get_schema(subject?: any)
get schema
ArgumentTypeDescription
subject?any

Resources

state(infinite)— Schema for a Kafka message.
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-subjectsv2026.08.12.2schemaregistries_contexts_schemas_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn sync(identifier?: string)
Sync subjects state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific subjects by name (e.g. one discovered by list)
fn list(deleted?: boolean, subject?: string, maxPages?: number)
List subjects resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted subjects. The default is false.
subject?stringOptional. The subject to filter the subjects by.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List subjects which reference a particular schema id. The response will be an...
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-typesv2026.08.12.2schemaregistries_contexts_schemas_types.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a types
ArgumentTypeDescription
identifierstringThe name of the types
fn sync(identifier?: string)
Sync types state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific types by name (e.g. one discovered by list)
fn list(maxPages?: number)
List types resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List the supported schema types. The response will be an array of schema types.
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-versionsv2026.08.12.2schemaregistries_contexts_schemas_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn sync(identifier?: string)
Sync versions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn list(deleted?: boolean, subject?: string, maxPages?: number)
List versions resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
subject?stringOptional. The subject to filter the subjects by.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List the schema versions for the given schema id. The response will be an arr...
@swamp/gcp/managedkafka/schemaregistries-contexts-subjectsv2026.08.12.2schemaregistries_contexts_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn delete(identifier: string)
Delete the subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn sync(identifier?: string)
Sync subjects state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific subjects by name (e.g. one discovered by list)
fn list(deleted?: boolean, subjectPrefix?: string, maxPages?: number)
List subjects resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted subjects. The default is false.
subjectPrefix?stringOptional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn lookup_version(deleted?: any, normalize?: any, references?: any, schema?: any, schemaType?: any)
lookup version
ArgumentTypeDescription
deleted?any
normalize?any
references?any
schema?any
schemaType?any

Resources

state(infinite)— List subjects in the schema registry. The response will be an array of subjec...
@swamp/gcp/managedkafka/schemaregistries-contexts-subjects-versionsv2026.09.07.1schemaregistries_contexts_subjects_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
id?numberOptional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
normalize?booleanOptional. If true, the schema will be normalized before being stored. The default is false.
references?arrayOptional. The schema references used by the schema.
schema?stringRequired. The schema payload
schemaType?enumOptional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
version?numberOptional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a versions
fn get(identifier: string)
Get a versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn delete(identifier: string)
Delete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn sync(identifier?: string)
Sync versions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn list(deleted?: boolean, maxPages?: number)
List versions resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_schema(deleted?: any)
get schema
ArgumentTypeDescription
deleted?any

Resources

state(infinite)— Version of a schema.
@swamp/gcp/managedkafka/schemaregistries-contexts-subjects-versions-referencedbyv2026.08.12.2schemaregistries_contexts_subjects_versions_referencedby.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a referencedby
ArgumentTypeDescription
identifierstringThe name of the referencedby
fn sync(identifier?: string)
Sync referencedby state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific referencedby by name (e.g. one discovered by list)
fn list(maxPages?: number)
List referencedby resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Get a list of IDs of schemas that reference the schema with the given subject...
@swamp/gcp/managedkafka/schemaregistries-modev2026.08.12.2schemaregistries_mode.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
mode?enumRequired. The mode type.
fn get(identifier: string)
Get a mode
ArgumentTypeDescription
identifierstringThe name of the mode
fn update(identifier?: string)
Update mode attributes
ArgumentTypeDescription
identifier?stringTarget a specific mode by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the mode
ArgumentTypeDescription
identifierstringThe name of the mode
fn sync(identifier?: string)
Sync mode state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific mode by name (e.g. one discovered by list)

Resources

state(infinite)— SchemaMode represents the mode of a schema registry or a specific subject. Fo...
@swamp/gcp/managedkafka/schemaregistries-schemasv2026.09.07.1schemaregistries_schemas.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
fn get(identifier: string)
Get a schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
fn sync(identifier?: string)
Sync schemas state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific schemas by name (e.g. one discovered by list)
fn get_schema(subject?: any)
get schema
ArgumentTypeDescription
subject?any

Resources

state(infinite)— Schema for a Kafka message.
@swamp/gcp/managedkafka/schemaregistries-schemas-subjectsv2026.08.12.2schemaregistries_schemas_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn sync(identifier?: string)
Sync subjects state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific subjects by name (e.g. one discovered by list)
fn list(deleted?: boolean, subject?: string, maxPages?: number)
List subjects resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted subjects. The default is false.
subject?stringOptional. The subject to filter the subjects by.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List subjects which reference a particular schema id. The response will be an...
@swamp/gcp/managedkafka/schemaregistries-schemas-typesv2026.08.12.2schemaregistries_schemas_types.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a types
ArgumentTypeDescription
identifierstringThe name of the types
fn sync(identifier?: string)
Sync types state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific types by name (e.g. one discovered by list)
fn list(maxPages?: number)
List types resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List the supported schema types. The response will be an array of schema types.
@swamp/gcp/managedkafka/schemaregistries-schemas-versionsv2026.08.12.2schemaregistries_schemas_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn sync(identifier?: string)
Sync versions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn list(deleted?: boolean, subject?: string, maxPages?: number)
List versions resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
subject?stringOptional. The subject to filter the subjects by.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— List the schema versions for the given schema id. The response will be an arr...
@swamp/gcp/managedkafka/schemaregistries-subjectsv2026.08.12.2schemaregistries_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn delete(identifier: string)
Delete the subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
fn sync(identifier?: string)
Sync subjects state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific subjects by name (e.g. one discovered by list)
fn list(deleted?: boolean, subjectPrefix?: string, maxPages?: number)
List subjects resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted subjects. The default is false.
subjectPrefix?stringOptional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn lookup_version(deleted?: any, normalize?: any, references?: any, schema?: any, schemaType?: any)
lookup version
ArgumentTypeDescription
deleted?any
normalize?any
references?any
schema?any
schemaType?any

Resources

state(infinite)— List subjects in the schema registry. The response will be an array of subjec...
@swamp/gcp/managedkafka/schemaregistries-subjects-versionsv2026.09.07.1schemaregistries_subjects_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
id?numberOptional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
normalize?booleanOptional. If true, the schema will be normalized before being stored. The default is false.
references?arrayOptional. The schema references used by the schema.
schema?stringRequired. The schema payload
schemaType?enumOptional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
version?numberOptional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a versions
fn get(identifier: string)
Get a versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn delete(identifier: string)
Delete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn sync(identifier?: string)
Sync versions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn list(deleted?: boolean, maxPages?: number)
List versions resources
ArgumentTypeDescription
deleted?booleanOptional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_schema(deleted?: any)
get schema
ArgumentTypeDescription
deleted?any

Resources

state(infinite)— Version of a schema.
@swamp/gcp/managedkafka/schemaregistries-subjects-versions-referencedbyv2026.08.12.2schemaregistries_subjects_versions_referencedby.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a referencedby
ArgumentTypeDescription
identifierstringThe name of the referencedby
fn sync(identifier?: string)
Sync referencedby state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific referencedby by name (e.g. one discovered by list)
fn list(maxPages?: number)
List referencedby resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Get a list of IDs of schemas that reference the schema with the given subject...
04Previous Versions19
2026.09.08.1
  • Updated: clusters
2026.09.07.1
  • Updated: clusters, schemaregistries_contexts_schemas, schemaregistries_contexts_subjects_versions, schemaregistries_schemas, schemaregistries_subjects_versions
2026.08.30.1
  • Updated: clusters
2026.08.12.2
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.07.29.1
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.07.21.4
  • Updated: locations, connectclusters
2026.07.21.1
  • Updated: clusters, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_contexts_subjects_versions, schemaregistries_subjects_versions
2026.07.20.2
  • Updated: locations, connectclusters
2026.07.20.1
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.07.18.2
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.07.17.3
  • Updated: clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors
2026.07.17.2
  • Updated: schemaregistries
2026.07.17.1
  • Updated: clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_contexts, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.06.08.2
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.06.07.1
  • Updated: locations, clusters, clusters_acls, clusters_consumergroups, clusters_topics, connectclusters, connectclusters_connectors, schemaregistries, schemaregistries_config, schemaregistries_contexts, schemaregistries_contexts_config, schemaregistries_contexts_mode, schemaregistries_contexts_schemas, schemaregistries_contexts_schemas_subjects, schemaregistries_contexts_schemas_types, schemaregistries_contexts_schemas_versions, schemaregistries_contexts_subjects, schemaregistries_contexts_subjects_versions, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_mode, schemaregistries_schemas, schemaregistries_schemas_subjects, schemaregistries_schemas_types, schemaregistries_schemas_versions, schemaregistries_subjects, schemaregistries_subjects_versions, schemaregistries_subjects_versions_referencedby
2026.05.26.1
  • Updated: locations, connectclusters
2026.05.25.2
  • Updated: schemaregistries_contexts, schemaregistries_contexts_schemas_types, schemaregistries_contexts_subjects_versions_referencedby, schemaregistries_schemas_types, schemaregistries_subjects_versions_referencedby

Modified 21 models

05Stats
A
100 / 100
Downloads
0
Archive size
206.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
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels