Skip to main content
← back to extensions

Gcp/domains

@swamp/gcp/domainsv2026.09.07.2· 3d agoMODELS
01README

Google Cloud domains infrastructure models

02Release Notes
  • Updated: registrations
03Models2
@swamp/gcp/domains/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/domains/registrationsv2026.09.07.2registrations.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.
contactSettings?objectRequired. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method.
createTime?stringOutput only. The creation timestamp of the `Registration` resource.
dnsSettings?objectSettings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method.
domainName?stringRequired. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
domainProperties?arrayOutput only. Special properties of the domain.
expireTime?stringOutput only. The expiration timestamp of the `Registration`.
issues?arrayOutput only. The set of issues with the `Registration` that require attention.
labels?recordSet of labels associated with the `Registration`.
managementSettings?objectSettings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method.
name?stringOutput only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`.
pendingContactSettings?objectOutput only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive.
registerFailureReason?enumOutput only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state?enumOutput only. The state of the `Registration`
supportedPrivacy?arrayOutput only. Set of options for the `contact_settings.privacy` field that this `Registration` supports.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a registrations
ArgumentTypeDescription
identifierstringThe name of the registrations
fn update(identifier?: string, waitForReady?: boolean)
Update registrations attributes
ArgumentTypeDescription
identifier?stringTarget a specific registrations 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 registrations
ArgumentTypeDescription
identifierstringThe name of the registrations
fn sync(identifier?: string)
Sync registrations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific registrations by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List registrations resources
ArgumentTypeDescription
filter?stringFilter expression to restrict the `Registration`s returned. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches. For example, to filter to a specific domain name, use an expression like `domainName="example.com"`. You can also check for the existence of a field; for exa
pageSize?numberMaximum number of results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn configure_contact_settings(contactNotices?: any, contactSettings?: any, updateMask?: any, validateOnly?: any)
configure contact settings
ArgumentTypeDescription
contactNotices?any
contactSettings?any
updateMask?any
validateOnly?any
fn configure_dns_settings(dnsSettings?: any, updateMask?: any, validateOnly?: any)
configure dns settings
ArgumentTypeDescription
dnsSettings?any
updateMask?any
validateOnly?any
fn configure_management_settings(managementSettings?: any, updateMask?: any, validateOnly?: any)
configure management settings
ArgumentTypeDescription
managementSettings?any
updateMask?any
validateOnly?any
fn export()
export
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn import(domainName?: any, labels?: any)
import
ArgumentTypeDescription
domainName?any
labels?any
fn initiate_push_transfer(tag?: any, validateOnly?: any)
initiate push transfer
ArgumentTypeDescription
tag?any
validateOnly?any
fn register(contactNotices?: any, domainNotices?: any, registration?: any, validateOnly?: any, yearlyPrice?: any)
register
ArgumentTypeDescription
contactNotices?any
domainNotices?any
registration?any
validateOnly?any
yearlyPrice?any
fn renew_domain(validateOnly?: any, yearlyPrice?: any)
renew domain
ArgumentTypeDescription
validateOnly?any
yearlyPrice?any
fn reset_authorization_code()
reset authorization code
fn retrieve_authorization_code()
retrieve authorization code
fn retrieve_google_domains_dns_records(pageSize?: any, pageToken?: any)
retrieve google domains dns records
ArgumentTypeDescription
pageSize?any
pageToken?any
fn retrieve_google_domains_forwarding_config()
retrieve google domains forwarding config
fn retrieve_importable_domains(pageSize?: any, pageToken?: any)
retrieve importable domains
ArgumentTypeDescription
pageSize?any
pageToken?any
fn retrieve_register_parameters(domainName?: any)
retrieve register parameters
ArgumentTypeDescription
domainName?any
fn retrieve_transfer_parameters(domainName?: any)
retrieve transfer parameters
ArgumentTypeDescription
domainName?any
fn search_domains(query?: any)
search domains
ArgumentTypeDescription
query?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn transfer(tag?: any, validateOnly?: any)
transfer
ArgumentTypeDescription
tag?any
validateOnly?any

Resources

state(infinite)— The `Registration` resource facilitates managing and configuring domain name ...
04Previous Versions19
2026.08.12.2
  • Updated: locations, registrations
2026.07.29.1
  • Updated: locations, registrations
2026.07.21.4
  • Updated: locations, registrations
2026.07.21.1
  • Updated: registrations
2026.07.20.2
  • Updated: locations, registrations
2026.07.20.1
  • Updated: locations, registrations
2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, registrations
2026.07.18.2
  • Updated: locations, registrations
2026.07.17.2
  • Updated: registrations
2026.07.17.1
  • Updated: registrations

Added 2, removed 1 models

2026.06.12.1
  • Updated: registrations
2026.06.08.2
  • Updated: locations, registrations
2026.06.07.1
  • Updated: locations, registrations
2026.05.26.1
  • Updated: locations, registrations
2026.05.25.1
  • Updated: locations, registrations

Modified 2 models

2026.05.24.1
  • Updated: locations, registrations
2026.05.21.2
  • Updated: locations, registrations
2026.05.21.1

Modified 1 models

05Stats
A
100 / 100
Downloads
0
Archive size
65.6 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
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#domains#cloud#infrastructure