Class ProjectsResource.LocationsResource.RegistrationsResource

The "registrations" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.RegistrationsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudDomains.v1

Assembly: Google.Apis.CloudDomains.v1.dll

Syntax

public class ProjectsResource.LocationsResource.RegistrationsResource

Constructors

RegistrationsResource(IClientService)

Constructs a new resource.

Declaration

public RegistrationsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

ConfigureContactSettings(ConfigureContactSettingsRequest, string)

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact . Caution: Please consider carefully any changes to contact privacy settings when changing from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA. There may be a delay in reflecting updates you make to registrant contact information such that any changes you make to contact privacy (including from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA) will be applied without delay but changes to registrant contact information may take a limited time to be publicized. This means that changes to contact privacy from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA may make the previous registrant contact data public until the modified registrant contact details are published.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ConfigureContactSettingsRequest ConfigureContactSettings(ConfigureContactSettingsRequest body, string registration)

Parameters

Type	Name	Description
ConfigureContactSettingsRequest	body	The body of the request.
string	registration	Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ConfigureContactSettingsRequest

ConfigureDnsSettings(ConfigureDnsSettingsRequest, string)

Updates a Registration's DNS settings.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ConfigureDnsSettingsRequest ConfigureDnsSettings(ConfigureDnsSettingsRequest body, string registration)

Parameters

Type	Name	Description
ConfigureDnsSettingsRequest	body	The body of the request.
string	registration	Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ConfigureDnsSettingsRequest

ConfigureManagementSettings(ConfigureManagementSettingsRequest, string)

Updates a Registration's management settings.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ConfigureManagementSettingsRequest ConfigureManagementSettings(ConfigureManagementSettingsRequest body, string registration)

Parameters

Type	Name	Description
ConfigureManagementSettingsRequest	body	The body of the request.
string	registration	Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ConfigureManagementSettingsRequest

Delete(string)

Deletes a Registration resource. This method works on any Registration resource using Subscription or Commitment billing, provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete Registration resources when state is one of: EXPORTED, EXPIRED,REGISTRATION_FAILED or TRANSFER_FAILED. See Cloud Domains feature deprecation for more details.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.DeleteRequest

Export(ExportRegistrationRequest, string)

Deprecated: For more information, see Cloud Domains feature deprecation Exports a Registration resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ExportRequest Export(ExportRegistrationRequest body, string name)

Parameters

Type	Name	Description
ExportRegistrationRequest	body	The body of the request.
string	name	Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ExportRequest

Get(string)

Gets the details of a Registration resource.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.GetIamPolicyRequest

Import(ImportDomainRequest, string)

Deprecated: For more information, see Cloud Domains feature deprecation Imports a domain name from Google Domains for use in Cloud Domains. To transfer a domain from another registrar, use the TransferDomain method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ImportRequest Import(ImportDomainRequest body, string parent)

Parameters

Type	Name	Description
ImportDomainRequest	body	The body of the request.
string	parent	Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ImportRequest

InitiatePushTransfer(InitiatePushTransferRequest, string)

Initiates the Push Transfer process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see Transfer a registered domain to another registrar.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.InitiatePushTransferRequest InitiatePushTransfer(InitiatePushTransferRequest body, string registration)

Parameters

Type	Name	Description
InitiatePushTransferRequest	body	The body of the request.
string	registration	Required. The name of the Registration for which the push transfer is initiated, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.InitiatePushTransferRequest

List(string)

Lists the Registration resources in a project.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ListRequest

Patch(Registration, string)

Updates select fields of a Registration resource, notably labels. To update other fields, use the appropriate custom update method: * To update management settings, see ConfigureManagementSettings * To update DNS configuration, see ConfigureDnsSettings * To update contact information, see ConfigureContactSettings

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.PatchRequest Patch(Registration body, string name)

Parameters

Type	Name	Description
Registration	body	The body of the request.
string	name	Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.PatchRequest

Register(RegisterDomainRequest, string)

Registers a new domain name and creates a corresponding Registration resource. Call RetrieveRegisterParameters first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a Registration resource in state REGISTRATION_PENDING, which resolves to ACTIVE within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RegisterRequest Register(RegisterDomainRequest body, string parent)

Parameters

Type	Name	Description
RegisterDomainRequest	body	The body of the request.
string	parent	Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RegisterRequest

RenewDomain(RenewDomainRequest, string)

Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a yearly_price for the renewal.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RenewDomainRequest RenewDomain(RenewDomainRequest body, string registration)

Parameters

Type	Name	Description
RenewDomainRequest	body	The body of the request.
string	registration	Required. The name of the Registration whish is being renewed, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RenewDomainRequest

ResetAuthorizationCode(ResetAuthorizationCodeRequest, string)

Resets the authorization code of the Registration to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties don't support authorization codes and must use the InitiatePushTransfer method to initiate the process to transfer the domain to a different registrar.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.ResetAuthorizationCodeRequest ResetAuthorizationCode(ResetAuthorizationCodeRequest body, string registration)

Parameters

Type	Name	Description
ResetAuthorizationCodeRequest	body	The body of the request.
string	registration	Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.ResetAuthorizationCodeRequest

RetrieveAuthorizationCode(string)

Gets the authorization code of the Registration for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties don't support authorization codes and must use the InitiatePushTransfer method to initiate the process to transfer the domain to a different registrar.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveAuthorizationCodeRequest RetrieveAuthorizationCode(string registration)

Parameters

Type	Name	Description
string	registration	Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveAuthorizationCodeRequest

RetrieveGoogleDomainsDnsRecords(string)

Lists the DNS records from the Google Domains DNS zone for domains that use the deprecated google_domains_dns in the Registration's dns_settings.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveGoogleDomainsDnsRecordsRequest RetrieveGoogleDomainsDnsRecords(string registration)

Parameters

Type	Name	Description
string	registration	Required. The name of the Registration whose Google Domains DNS records details you are retrieving, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveGoogleDomainsDnsRecordsRequest

RetrieveGoogleDomainsForwardingConfig(string)

Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the google_domains_redirects_data_available set to true in the Registration's dns_settings. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveGoogleDomainsForwardingConfigRequest RetrieveGoogleDomainsForwardingConfig(string registration)

Parameters

Type	Name	Description
string	registration	Required. The name of the Registration whose Google Domains forwarding configuration details are being retrieved, in the format projects/*/locations/*/registrations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveGoogleDomainsForwardingConfigRequest

RetrieveImportableDomains(string)

Deprecated: For more information, see Cloud Domains feature deprecation Lists domain names from Google Domains that can be imported to Cloud Domains using the ImportDomain method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveImportableDomainsRequest RetrieveImportableDomains(string location)

Parameters

Type	Name	Description
string	location	Required. The location. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveImportableDomainsRequest

RetrieveRegisterParameters(string)

Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveRegisterParametersRequest RetrieveRegisterParameters(string location)

Parameters

Type	Name	Description
string	location	Required. The location. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveRegisterParametersRequest

RetrieveTransferParameters(string)

Deprecated: For more information, see Cloud Domains feature deprecation Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by Google Domains, use ImportDomain instead. Use the returned values to call TransferDomain.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.RetrieveTransferParametersRequest RetrieveTransferParameters(string location)

Parameters

Type	Name	Description
string	location	Required. The location. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.RetrieveTransferParametersRequest

SearchDomains(string)

Searches for available domain names similar to the provided query. Availability results from this method are approximate; call RetrieveRegisterParameters on a domain before registering to confirm availability.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.SearchDomainsRequest SearchDomains(string location)

Parameters

Type	Name	Description
string	location	Required. The location. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.SearchDomainsRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.TestIamPermissionsRequest

Transfer(TransferDomainRequest, string)

Deprecated: For more information, see Cloud Domains feature deprecation Transfers a domain name from another registrar to Cloud Domains. For domains already managed by Google Domains, use ImportDomain instead. Before calling this method, go to the domain's 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 this method. A successful call creates a Registration resource in state TRANSFER_PENDING. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state ACTIVE, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state TRANSFER_FAILED. If transfer fails, you can safely delete the resource and retry the transfer.

Declaration

public virtual ProjectsResource.LocationsResource.RegistrationsResource.TransferRequest Transfer(TransferDomainRequest body, string parent)

Parameters

Type	Name	Description
TransferDomainRequest	body	The body of the request.
string	parent	Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.RegistrationsResource.TransferRequest