Gcp/domains
@swamp/gcp/domainsv2026.05.26.1
01README
Google Cloud domains infrastructure models
02Release Notes
- Updated: locations, registrations
03Models
@swamp/gcp/domains/locationsv2026.05.26.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
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.
@swamp/gcp/domains/registrationsv2026.05.26.1registrations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| contactSettings? | object | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. |
| createTime? | string | Output only. The creation timestamp of the `Registration` resource. |
| dnsSettings? | object | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. |
| domainName? | string | Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. |
| domainProperties? | array | Output only. Special properties of the domain. |
| expireTime? | string | Output only. The expiration timestamp of the `Registration`. |
| issues? | array | Output only. The set of issues with the `Registration` that require attention. |
| labels? | record | Set of labels associated with the `Registration`. |
| managementSettings? | object | Defines renewal, billing, and transfer settings for a `Registration`. |
| name? | string | Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. |
| pendingContactSettings? | object | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. |
| registerFailureReason? | enum | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. |
| state? | enum | Output only. The state of the `Registration` |
| supportedPrivacy? | array | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a registrations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the registrations |
fn update(waitForReady?: boolean)
Update registrations attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the registrations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the registrations |
fn sync()
Sync registrations state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List registrations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter 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? | number | Maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn configure_contact_settings(contactNotices?: any, contactSettings?: any, updateMask?: any, validateOnly?: any)
configure contact settings
| Argument | Type | Description |
|---|---|---|
| contactNotices? | any | |
| contactSettings? | any | |
| updateMask? | any | |
| validateOnly? | any |
fn configure_dns_settings(dnsSettings?: any, updateMask?: any, validateOnly?: any)
configure dns settings
| Argument | Type | Description |
|---|---|---|
| dnsSettings? | any | |
| updateMask? | any | |
| validateOnly? | any |
fn configure_management_settings(managementSettings?: any, updateMask?: any, validateOnly?: any)
configure management settings
| Argument | Type | Description |
|---|---|---|
| managementSettings? | any | |
| updateMask? | any | |
| validateOnly? | any |
fn export()
export
fn get_iam_policy()
get iam policy
fn import(domainName?: any, labels?: any)
import
| Argument | Type | Description |
|---|---|---|
| domainName? | any | |
| labels? | any |
fn initiate_push_transfer(tag?: any)
initiate push transfer
| Argument | Type | Description |
|---|---|---|
| tag? | any |
fn register(contactNotices?: any, domainNotices?: any, registration?: any, validateOnly?: any, yearlyPrice?: any)
register
| Argument | Type | Description |
|---|---|---|
| contactNotices? | any | |
| domainNotices? | any | |
| registration? | any | |
| validateOnly? | any | |
| yearlyPrice? | any |
fn renew_domain(validateOnly?: any, yearlyPrice?: any)
renew domain
| Argument | Type | Description |
|---|---|---|
| validateOnly? | any | |
| yearlyPrice? | any |
fn reset_authorization_code()
reset authorization code
fn retrieve_authorization_code()
retrieve authorization code
fn retrieve_google_domains_dns_records()
retrieve google domains dns records
fn retrieve_google_domains_forwarding_config()
retrieve google domains forwarding config
fn retrieve_importable_domains()
retrieve importable domains
fn retrieve_register_parameters()
retrieve register parameters
fn retrieve_transfer_parameters()
retrieve transfer parameters
fn search_domains()
search domains
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 |
fn transfer(tag?: any)
transfer
| Argument | Type | Description |
|---|---|---|
| tag? | any |
Resources
state(infinite)— The `Registration` resource facilitates managing and configuring domain name ...
04Previous Versions
2026.05.25.1May 25, 2026
- Updated: locations, registrations
Modified 2 models
2026.05.24.1May 24, 2026
- Updated: locations, registrations
2026.05.21.2May 21, 2026
- Updated: locations, registrations
2026.05.21.1May 21, 2026
Modified 1 models
2026.05.20.1May 20, 2026
- Updated: registrations
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.01.1May 1, 2026
- Updated: registrations
2026.04.23.1Apr 23, 2026
2026.04.03.3Apr 3, 2026
- Updated: locations, registrations
2026.04.03.1Apr 3, 2026
- Updated: locations, registrations
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: locations, registrations
05Stats
A
100 / 100
Downloads
0
Archive size
59.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 types1/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