--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # gcp_domains_registration{% #gcp_domains_registration %} ## `ancestors`{% #ancestors %} **Type**: `UNORDERED_LIST_STRING` ## `contact_settings`{% #contact_settings %} **Type**: `STRUCT`**Provider name**: `contactSettings`**Description**: Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method. - `admin_contact`**Type**: `STRUCT`**Provider name**: `adminContact`**Description**: Required. The administrative contact for the `Registration`. - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - `privacy`**Type**: `STRING`**Provider name**: `privacy`**Description**: Required. Privacy setting for the contacts associated with the `Registration`.**Possible values**: - `CONTACT_PRIVACY_UNSPECIFIED` - The contact privacy settings are undefined. - `PUBLIC_CONTACT_DATA` - All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request. - `PRIVATE_CONTACT_DATA` - Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost. - `REDACTED_CONTACT_DATA` - The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242). - `registrant_contact`**Type**: `STRUCT`**Provider name**: `registrantContact`**Description**: Required. The registrant contact for the `Registration`. *Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.* *Warning: For new `Registration`s, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.* - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - `technical_contact`**Type**: `STRUCT`**Provider name**: `technicalContact`**Description**: Required. The technical contact for the `Registration`. - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. ## `create_time`{% #create_time %} **Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. The creation timestamp of the `Registration` resource. ## `dns_settings`{% #dns_settings %} **Type**: `STRUCT`**Provider name**: `dnsSettings`**Description**: Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method. - `custom_dns`**Type**: `STRUCT`**Provider name**: `customDns`**Description**: An arbitrary DNS provider identified by its name servers. - `ds_records`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `dsRecords`**Description**: The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled. - `algorithm`**Type**: `STRING`**Provider name**: `algorithm`**Description**: The algorithm used to generate the referenced DNSKEY.**Possible values**: - `ALGORITHM_UNSPECIFIED` - The algorithm is unspecified. - `RSAMD5` - RSA/MD5. Cannot be used for new deployments. - `DH` - Diffie-Hellman. Cannot be used for new deployments. - `DSA` - DSA/SHA1. Not recommended for new deployments. - `ECC` - ECC. Not recommended for new deployments. - `RSASHA1` - RSA/SHA-1. Not recommended for new deployments. - `DSANSEC3SHA1` - DSA-NSEC3-SHA1. Not recommended for new deployments. - `RSASHA1NSEC3SHA1` - RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments. - `RSASHA256` - RSA/SHA-256. - `RSASHA512` - RSA/SHA-512. - `ECCGOST` - GOST R 34.10-2001. - `ECDSAP256SHA256` - ECDSA Curve P-256 with SHA-256. - `ECDSAP384SHA384` - ECDSA Curve P-384 with SHA-384. - `ED25519` - Ed25519. - `ED448` - Ed448. - `INDIRECT` - Reserved for Indirect Keys. Cannot be used for new deployments. - `PRIVATEDNS` - Private algorithm. Cannot be used for new deployments. - `PRIVATEOID` - Private algorithm OID. Cannot be used for new deployments. - `digest`**Type**: `STRING`**Provider name**: `digest`**Description**: The digest generated from the referenced DNSKEY. - `digest_type`**Type**: `STRING`**Provider name**: `digestType`**Description**: The hash function used to generate the digest of the referenced DNSKEY.**Possible values**: - `DIGEST_TYPE_UNSPECIFIED` - The DigestType is unspecified. - `SHA1` - SHA-1. Not recommended for new deployments. - `SHA256` - SHA-256. - `GOST3411` - GOST R 34.11-94. - `SHA384` - SHA-384. - `key_tag`**Type**: `INT32`**Provider name**: `keyTag`**Description**: The key tag of the record. Must be set in range 0 – 65535. - `name_servers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `nameServers`**Description**: Required. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. - `glue_records`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `glueRecords`**Description**: The list of glue records for this `Registration`. Commonly empty. - `host_name`**Type**: `STRING`**Provider name**: `hostName`**Description**: Required. Domain name of the host in Punycode format. - `ipv4_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipv4Addresses`**Description**: List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. `198.51.100.1`). At least one of `ipv4_address` and `ipv6_address` must be set. - `ipv6_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipv6Addresses`**Description**: List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. `2001:db8::`). At least one of `ipv4_address` and `ipv6_address` must be set. - `google_domains_dns`**Type**: `STRUCT`**Provider name**: `googleDomainsDns`**Description**: Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). The free DNS zone provided by [Google Domains](https://domains.google/). - `ds_records`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `dsRecords`**Description**: Output only. The list of DS records published for this domain. The list is automatically populated when `ds_state` is `DS_RECORDS_PUBLISHED`, otherwise it remains empty. - `algorithm`**Type**: `STRING`**Provider name**: `algorithm`**Description**: The algorithm used to generate the referenced DNSKEY.**Possible values**: - `ALGORITHM_UNSPECIFIED` - The algorithm is unspecified. - `RSAMD5` - RSA/MD5. Cannot be used for new deployments. - `DH` - Diffie-Hellman. Cannot be used for new deployments. - `DSA` - DSA/SHA1. Not recommended for new deployments. - `ECC` - ECC. Not recommended for new deployments. - `RSASHA1` - RSA/SHA-1. Not recommended for new deployments. - `DSANSEC3SHA1` - DSA-NSEC3-SHA1. Not recommended for new deployments. - `RSASHA1NSEC3SHA1` - RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments. - `RSASHA256` - RSA/SHA-256. - `RSASHA512` - RSA/SHA-512. - `ECCGOST` - GOST R 34.10-2001. - `ECDSAP256SHA256` - ECDSA Curve P-256 with SHA-256. - `ECDSAP384SHA384` - ECDSA Curve P-384 with SHA-384. - `ED25519` - Ed25519. - `ED448` - Ed448. - `INDIRECT` - Reserved for Indirect Keys. Cannot be used for new deployments. - `PRIVATEDNS` - Private algorithm. Cannot be used for new deployments. - `PRIVATEOID` - Private algorithm OID. Cannot be used for new deployments. - `digest`**Type**: `STRING`**Provider name**: `digest`**Description**: The digest generated from the referenced DNSKEY. - `digest_type`**Type**: `STRING`**Provider name**: `digestType`**Description**: The hash function used to generate the digest of the referenced DNSKEY.**Possible values**: - `DIGEST_TYPE_UNSPECIFIED` - The DigestType is unspecified. - `SHA1` - SHA-1. Not recommended for new deployments. - `SHA256` - SHA-256. - `GOST3411` - GOST R 34.11-94. - `SHA384` - SHA-384. - `key_tag`**Type**: `INT32`**Provider name**: `keyTag`**Description**: The key tag of the record. Must be set in range 0 – 65535. - `ds_state`**Type**: `STRING`**Provider name**: `dsState`**Description**: Required. The state of DS records for this domain. Used to enable or disable automatic DNSSEC.**Possible values**: - `DS_STATE_UNSPECIFIED` - DS state is unspecified. - `DS_RECORDS_UNPUBLISHED` - DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone. - `DS_RECORDS_PUBLISHED` - DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the `Registration`'s `dns_provider` field is already DNSSEC-signed. - `name_servers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `nameServers`**Description**: Output only. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone. - `google_domains_redirects_data_available`**Type**: `BOOLEAN`**Provider name**: `googleDomainsRedirectsDataAvailable`**Description**: Output only. Indicates if this `Registration` has configured one of the following deprecated Google Domains DNS features: * Domain forwarding (HTTP `301` and `302` response status codes), * Email forwarding. See [https://cloud.google.com/domains/docs/deprecations/feature-deprecations](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details. If any of these features is enabled call the `RetrieveGoogleDomainsForwardingConfig` method to get details about the feature's configuration. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone. ## `domain_name`{% #domain_name %} **Type**: `STRING`**Provider name**: `domainName`**Description**: Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. ## `domain_properties`{% #domain_properties %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `domainProperties`**Description**: Output only. Special properties of the domain. ## `expire_time`{% #expire_time %} **Type**: `TIMESTAMP`**Provider name**: `expireTime`**Description**: Output only. The expiration timestamp of the `Registration`. ## `issues`{% #issues %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `issues`**Description**: Output only. The set of issues with the `Registration` that require attention. ## `labels`{% #labels %} **Type**: `UNORDERED_LIST_STRING` ## `management_settings`{% #management_settings %} **Type**: `STRUCT`**Provider name**: `managementSettings`**Description**: Settings 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. - `effective_transfer_lock_state`**Type**: `STRING`**Provider name**: `effectiveTransferLockState`**Description**: Output only. The actual transfer lock state for this `Registration`.**Possible values**: - `TRANSFER_LOCK_STATE_UNSPECIFIED` - The state is unspecified. - `UNLOCKED` - The domain is unlocked and can be transferred to another registrar. - `LOCKED` - The domain is locked and cannot be transferred to another registrar. - `preferred_renewal_method`**Type**: `STRING`**Provider name**: `preferredRenewalMethod`**Description**: Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours.**Possible values**: - `RENEWAL_METHOD_UNSPECIFIED` - The renewal method is undefined. - `AUTOMATIC_RENEWAL` - The domain is automatically renewed each year. - `MANUAL_RENEWAL` - Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). This option was never used. Use `RENEWAL_DISABLED` instead. - `RENEWAL_DISABLED` - The domain won't be renewed and will expire at its expiration time. - `renewal_method`**Type**: `STRING`**Provider name**: `renewalMethod`**Description**: Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours.**Possible values**: - `RENEWAL_METHOD_UNSPECIFIED` - The renewal method is undefined. - `AUTOMATIC_RENEWAL` - The domain is automatically renewed each year. - `MANUAL_RENEWAL` - Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). This option was never used. Use `RENEWAL_DISABLED` instead. - `RENEWAL_DISABLED` - The domain won't be renewed and will expire at its expiration time. - `transfer_lock_state`**Type**: `STRING`**Provider name**: `transferLockState`**Description**: This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state.**Possible values**: - `TRANSFER_LOCK_STATE_UNSPECIFIED` - The state is unspecified. - `UNLOCKED` - The domain is unlocked and can be transferred to another registrar. - `LOCKED` - The domain is locked and cannot be transferred to another registrar. ## `name`{% #name %} **Type**: `STRING`**Provider name**: `name`**Description**: Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. ## `organization_id`{% #organization_id %} **Type**: `STRING` ## `parent`{% #parent %} **Type**: `STRING` ## `pending_contact_settings`{% #pending_contact_settings %} **Type**: `STRUCT`**Provider name**: `pendingContactSettings`**Description**: Output 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. - `admin_contact`**Type**: `STRUCT`**Provider name**: `adminContact`**Description**: Required. The administrative contact for the `Registration`. - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - `privacy`**Type**: `STRING`**Provider name**: `privacy`**Description**: Required. Privacy setting for the contacts associated with the `Registration`.**Possible values**: - `CONTACT_PRIVACY_UNSPECIFIED` - The contact privacy settings are undefined. - `PUBLIC_CONTACT_DATA` - All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request. - `PRIVATE_CONTACT_DATA` - Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost. - `REDACTED_CONTACT_DATA` - The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242). - `registrant_contact`**Type**: `STRUCT`**Provider name**: `registrantContact`**Description**: Required. The registrant contact for the `Registration`. *Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.* *Warning: For new `Registration`s, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.* - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - `technical_contact`**Type**: `STRUCT`**Provider name**: `technicalContact`**Description**: Required. The technical contact for the `Registration`. - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Required. Email address of the contact. - `fax_number`**Type**: `STRING`**Provider name**: `faxNumber`**Description**: Fax number of the contact in international format. For example, `"+1-800-555-0123"`. - `phone_number`**Type**: `STRING`**Provider name**: `phoneNumber`**Description**: Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - `postal_address`**Type**: `STRUCT`**Provider name**: `postalAddress`**Description**: Required. Postal address of the contact. - `address_lines`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `addressLines`**Description**: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - `administrative_area`**Type**: `STRING`**Provider name**: `administrativeArea`**Description**: Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. - `language_code`**Type**: `STRING`**Provider name**: `languageCode`**Description**: Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality`**Type**: `STRING`**Provider name**: `locality`**Description**: Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. - `organization`**Type**: `STRING`**Provider name**: `organization`**Description**: Optional. The name of the organization at the address. - `postal_code`**Type**: `STRING`**Provider name**: `postalCode`**Description**: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). - `recipients`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `recipients`**Description**: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `region_code`**Type**: `STRING`**Provider name**: `regionCode`**Description**: Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See [https://cldr.unicode.org/](https://cldr.unicode.org/) and [https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html](https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html) for details. Example: "CH" for Switzerland. - `revision`**Type**: `INT32`**Provider name**: `revision`**Description**: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - `sorting_code`**Type**: `STRING`**Provider name**: `sortingCode`**Description**: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). - `sublocality`**Type**: `STRING`**Provider name**: `sublocality`**Description**: Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. ## `project_id`{% #project_id %} **Type**: `STRING` ## `project_number`{% #project_number %} **Type**: `STRING` ## `region_id`{% #region_id %} **Type**: `STRING` ## `register_failure_reason`{% #register_failure_reason %} **Type**: `STRING`**Provider name**: `registerFailureReason`**Description**: Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.**Possible values**: - `REGISTER_FAILURE_REASON_UNSPECIFIED` - Register failure unspecified. - `REGISTER_FAILURE_REASON_UNKNOWN` - Registration failed for an unknown reason. - `DOMAIN_NOT_AVAILABLE` - The domain is not available for registration. - `INVALID_CONTACTS` - The provided contact information was rejected. ## `resource_name`{% #resource_name %} **Type**: `STRING` ## `state`{% #state %} **Type**: `STRING`**Provider name**: `state`**Description**: Output only. The state of the `Registration`**Possible values**: - `STATE_UNSPECIFIED` - The state is undefined. - `REGISTRATION_PENDING` - The domain is being registered. - `REGISTRATION_FAILED` - The domain registration failed. You can delete resources in this state to allow registration to be retried. - `TRANSFER_PENDING` - The domain is being transferred from another registrar to Cloud Domains. - `TRANSFER_FAILED` - The attempt to transfer the domain from another registrar to Cloud Domains failed. You can delete resources in this state and retry the transfer. - `IMPORT_PENDING` - The domain is being imported from Google Domains to Cloud Domains. - `ACTIVE` - The domain is registered and operational. The domain renews automatically as long as it remains in this state and the `RenewalMethod` is set to `AUTOMATIC_RENEWAL`. - `SUSPENDED` - The domain is suspended and inoperative. For more details, see the `issues` field. - `EXPORTED` - The domain is no longer managed with Cloud Domains. It may have been transferred to another registrar or exported for management in [Google Domains](https://domains.google/). You can no longer update it with this API, and information shown about it may be stale. Domains in this state are not automatically renewed by Cloud Domains. - `EXPIRED` - The domain is expired. ## `supported_privacy`{% #supported_privacy %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `supportedPrivacy`**Description**: Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `transfer_failure_reason`{% #transfer_failure_reason %} **Type**: `STRING`**Provider name**: `transferFailureReason`**Description**: Output only. Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.**Possible values**: - `TRANSFER_FAILURE_REASON_UNSPECIFIED` - Transfer failure unspecified. - `TRANSFER_FAILURE_REASON_UNKNOWN` - Transfer failed for an unknown reason. - `EMAIL_CONFIRMATION_FAILURE` - An email confirmation sent to the user was rejected or expired. - `DOMAIN_NOT_REGISTERED` - The domain is available for registration. - `DOMAIN_HAS_TRANSFER_LOCK` - The domain has a transfer lock with its current registrar which must be removed prior to transfer. - `INVALID_AUTHORIZATION_CODE` - The authorization code entered is not valid. - `TRANSFER_CANCELLED` - The transfer was cancelled by the domain owner, current registrar, or TLD registry. - `TRANSFER_REJECTED` - The transfer was rejected by the current registrar. Contact the current registrar for more information. - `INVALID_REGISTRANT_EMAIL_ADDRESS` - The registrant email address cannot be parsed from the domain's current public contact data. - `DOMAIN_NOT_ELIGIBLE_FOR_TRANSFER` - The domain is not eligible for transfer due requirements imposed by the current registrar or TLD registry. - `TRANSFER_ALREADY_PENDING` - Another transfer is already pending for this domain. The existing transfer attempt must expire or be cancelled in order to proceed. ## `zone_id`{% #zone_id %} **Type**: `STRING`