Reference documentation and code samples for the Cloud Domains V1beta1 API class Google::Cloud::Domains::V1beta1::Registration.
The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration resource:
To create a new Registration resource, find a suitable domain name by
calling the SearchDomains method with a query to see available domain name
options. After choosing a name, call RetrieveRegisterParameters to
ensure availability and obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to transfer an existing
domain from another registrar. First, go to the current registrar to unlock
the domain for transfer and retrieve the domain's transfer authorization
code. Then call RetrieveTransferParameters to confirm that the domain is
unlocked and to get values needed to build a call to TransferDomain.
(::Google::Cloud::Domains::V1beta1::ContactSettings) — 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.
value (::Google::Cloud::Domains::V1beta1::ContactSettings) — 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.
Returns
(::Google::Cloud::Domains::V1beta1::ContactSettings) — 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.
(::Google::Cloud::Domains::V1beta1::DnsSettings) — Settings controlling the DNS configuration of the Registration. You
cannot update these with the UpdateRegistration method. To update these
settings, use the ConfigureDnsSettings method.
value (::Google::Cloud::Domains::V1beta1::DnsSettings) — Settings controlling the DNS configuration of the Registration. You
cannot update these with the UpdateRegistration method. To update these
settings, use the ConfigureDnsSettings method.
Returns
(::Google::Cloud::Domains::V1beta1::DnsSettings) — Settings controlling the DNS configuration of the Registration. You
cannot update these with the UpdateRegistration method. To update these
settings, use the ConfigureDnsSettings method.
#domain_name
defdomain_name()->::String
Returns
(::String) — Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
#domain_name=
defdomain_name=(value)->::String
Parameter
value (::String) — Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
Returns
(::String) — Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
(::Google::Cloud::Domains::V1beta1::ManagementSettings) — 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.
value (::Google::Cloud::Domains::V1beta1::ManagementSettings) — 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.
Returns
(::Google::Cloud::Domains::V1beta1::ManagementSettings) — 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.
#name
defname()->::String
Returns
(::String) — Output only. Name of the Registration resource, in the format
projects/*/locations/*/registrations/<domain_name>.
(::Google::Cloud::Domains::V1beta1::ContactSettings) — 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Domains V1beta1 API - Class Google::Cloud::Domains::V1beta1::Registration (v0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/ruby/docs/reference/google-cloud-domains-v1beta1/latest/Google-Cloud-Domains-V1beta1-Registration)\n- [0.11.1](/ruby/docs/reference/google-cloud-domains-v1beta1/0.11.1/Google-Cloud-Domains-V1beta1-Registration)\n- [0.10.0](/ruby/docs/reference/google-cloud-domains-v1beta1/0.10.0/Google-Cloud-Domains-V1beta1-Registration)\n- [0.9.1](/ruby/docs/reference/google-cloud-domains-v1beta1/0.9.1/Google-Cloud-Domains-V1beta1-Registration)\n- [0.8.2](/ruby/docs/reference/google-cloud-domains-v1beta1/0.8.2/Google-Cloud-Domains-V1beta1-Registration)\n- [0.7.0](/ruby/docs/reference/google-cloud-domains-v1beta1/0.7.0/Google-Cloud-Domains-V1beta1-Registration)\n- [0.6.0](/ruby/docs/reference/google-cloud-domains-v1beta1/0.6.0/Google-Cloud-Domains-V1beta1-Registration)\n- [0.5.0](/ruby/docs/reference/google-cloud-domains-v1beta1/0.5.0/Google-Cloud-Domains-V1beta1-Registration)\n- [0.4.0](/ruby/docs/reference/google-cloud-domains-v1beta1/0.4.0/Google-Cloud-Domains-V1beta1-Registration)\n- [0.3.2](/ruby/docs/reference/google-cloud-domains-v1beta1/0.3.2/Google-Cloud-Domains-V1beta1-Registration) \nReference documentation and code samples for the Cloud Domains V1beta1 API class Google::Cloud::Domains::V1beta1::Registration.\n\nThe `Registration` resource facilitates managing and configuring domain name\nregistrations.\n\n\nThere are several ways to create a new `Registration` resource:\n\nTo create a new `Registration` resource, find a suitable domain name by\ncalling the `SearchDomains` method with a query to see available domain name\noptions. After choosing a name, call `RetrieveRegisterParameters` to\nensure availability and obtain information like pricing, which is needed to\nbuild a call to `RegisterDomain`.\n\n\u003cbr /\u003e\n\nAnother way to create a new `Registration` is to transfer an existing\ndomain from another registrar. First, go to the current registrar to unlock\nthe domain for transfer and retrieve the domain's transfer authorization\ncode. Then call `RetrieveTransferParameters` to confirm that the domain is\nunlocked and to get values needed to build a call to `TransferDomain`. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #contact_settings\n\n def contact_settings() -\u003e ::Google::Cloud::Domains::V1beta1::ContactSettings\n\n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::ContactSettings](./Google-Cloud-Domains-V1beta1-ContactSettings)) --- 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.\n\n### #contact_settings=\n\n def contact_settings=(value) -\u003e ::Google::Cloud::Domains::V1beta1::ContactSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Domains::V1beta1::ContactSettings](./Google-Cloud-Domains-V1beta1-ContactSettings)) --- 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. \n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::ContactSettings](./Google-Cloud-Domains-V1beta1-ContactSettings)) --- 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.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The creation timestamp of the `Registration` resource.\n\n### #dns_settings\n\n def dns_settings() -\u003e ::Google::Cloud::Domains::V1beta1::DnsSettings\n\n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::DnsSettings](./Google-Cloud-Domains-V1beta1-DnsSettings)) --- Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method.\n\n### #dns_settings=\n\n def dns_settings=(value) -\u003e ::Google::Cloud::Domains::V1beta1::DnsSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Domains::V1beta1::DnsSettings](./Google-Cloud-Domains-V1beta1-DnsSettings)) --- Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method. \n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::DnsSettings](./Google-Cloud-Domains-V1beta1-DnsSettings)) --- Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method.\n\n### #domain_name\n\n def domain_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.\n\n### #domain_name=\n\n def domain_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. \n**Returns**\n\n- (::String) --- Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.\n\n### #expire_time\n\n def expire_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The expiration timestamp of the `Registration`.\n\n### #issues\n\n def issues() -\u003e ::Array\u003c::Google::Cloud::Domains::V1beta1::Registration::Issue\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Domains::V1beta1::Registration::Issue](./Google-Cloud-Domains-V1beta1-Registration-Issue)\\\u003e) --- Output only. The set of issues with the `Registration` that require attention.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with the `Registration`.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with the `Registration`. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with the `Registration`.\n\n### #management_settings\n\n def management_settings() -\u003e ::Google::Cloud::Domains::V1beta1::ManagementSettings\n\n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::ManagementSettings](./Google-Cloud-Domains-V1beta1-ManagementSettings)) --- 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.\n\n### #management_settings=\n\n def management_settings=(value) -\u003e ::Google::Cloud::Domains::V1beta1::ManagementSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Domains::V1beta1::ManagementSettings](./Google-Cloud-Domains-V1beta1-ManagementSettings)) --- 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. \n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::ManagementSettings](./Google-Cloud-Domains-V1beta1-ManagementSettings)) --- 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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/\u003cdomain_name\u003e`.\n\n### #pending_contact_settings\n\n def pending_contact_settings() -\u003e ::Google::Cloud::Domains::V1beta1::ContactSettings\n\n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::ContactSettings](./Google-Cloud-Domains-V1beta1-ContactSettings)) --- 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.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Domains::V1beta1::Registration::State\n\n**Returns**\n\n- ([::Google::Cloud::Domains::V1beta1::Registration::State](./Google-Cloud-Domains-V1beta1-Registration-State)) --- Output only. The state of the `Registration`\n\n### #supported_privacy\n\n def supported_privacy() -\u003e ::Array\u003c::Google::Cloud::Domains::V1beta1::ContactPrivacy\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Domains::V1beta1::ContactPrivacy](./Google-Cloud-Domains-V1beta1-ContactPrivacy)\\\u003e) --- Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports."]]
