Cloud Domains v1 API - Class Domains.DomainsBase (2.3.0)

Version 2.3.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

[BindServiceMethod(typeof(Domains), "BindService")]
public abstract class Domains.DomainsBase

Reference documentation and code samples for the Cloud Domains v1 API class Domains.DomainsBase.

Base class for server-side implementations of Domains

Inheritance

object > Domains.DomainsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Domains.V1

Assembly

Google.Cloud.Domains.V1.dll

Methods

ConfigureContactSettings(ConfigureContactSettingsRequest, ServerCallContext)

public virtual Task<Operation> ConfigureContactSettings(ConfigureContactSettingsRequest request, ServerCallContext context)

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact .

Parameters
Name	Description
request	ConfigureContactSettingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ConfigureDnsSettings(ConfigureDnsSettingsRequest, ServerCallContext)

public virtual Task<Operation> ConfigureDnsSettings(ConfigureDnsSettingsRequest request, ServerCallContext context)

Updates a Registration's DNS settings.

Parameters
Name	Description
request	ConfigureDnsSettingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ConfigureManagementSettings(ConfigureManagementSettingsRequest, ServerCallContext)

public virtual Task<Operation> ConfigureManagementSettings(ConfigureManagementSettingsRequest request, ServerCallContext context)

Updates a Registration's management settings.

Parameters
Name	Description
request	ConfigureManagementSettingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteRegistration(DeleteRegistrationRequest, ServerCallContext)

public virtual Task<Operation> DeleteRegistration(DeleteRegistrationRequest request, ServerCallContext context)

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.

For Registration resources using Monthly billing, this method works if:

• state is EXPORTED with expire_time in the past
• state is REGISTRATION_FAILED
• state is TRANSFER_FAILED

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.

Parameters
Name	Description
request	DeleteRegistrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportRegistration(ExportRegistrationRequest, ServerCallContext)

public virtual Task<Operation> ExportRegistration(ExportRegistrationRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ExportRegistrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetRegistration(GetRegistrationRequest, ServerCallContext)

public virtual Task<Registration> GetRegistration(GetRegistrationRequest request, ServerCallContext context)

Gets the details of a Registration resource.

Parameters
Name	Description
request	GetRegistrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRegistration	The response to send back to the client (wrapped by a task).

ListRegistrations(ListRegistrationsRequest, ServerCallContext)

public virtual Task<ListRegistrationsResponse> ListRegistrations(ListRegistrationsRequest request, ServerCallContext context)

Lists the Registration resources in a project.

Parameters
Name	Description
request	ListRegistrationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListRegistrationsResponse	The response to send back to the client (wrapped by a task).

RegisterDomain(RegisterDomainRequest, ServerCallContext)

public virtual Task<Operation> RegisterDomain(RegisterDomainRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	RegisterDomainRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ResetAuthorizationCode(ResetAuthorizationCodeRequest, ServerCallContext)

public virtual Task<AuthorizationCode> ResetAuthorizationCode(ResetAuthorizationCodeRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ResetAuthorizationCodeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAuthorizationCode	The response to send back to the client (wrapped by a task).

RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, ServerCallContext)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	RetrieveAuthorizationCodeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAuthorizationCode	The response to send back to the client (wrapped by a task).

RetrieveRegisterParameters(RetrieveRegisterParametersRequest, ServerCallContext)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParameters(RetrieveRegisterParametersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	RetrieveRegisterParametersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRetrieveRegisterParametersResponse	The response to send back to the client (wrapped by a task).

RetrieveTransferParameters(RetrieveTransferParametersRequest, ServerCallContext)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParameters(RetrieveTransferParametersRequest request, ServerCallContext context)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name	Description
request	RetrieveTransferParametersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRetrieveTransferParametersResponse	The response to send back to the client (wrapped by a task).

SearchDomains(SearchDomainsRequest, ServerCallContext)

public virtual Task<SearchDomainsResponse> SearchDomains(SearchDomainsRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	SearchDomainsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchDomainsResponse	The response to send back to the client (wrapped by a task).

TransferDomain(TransferDomainRequest, ServerCallContext)

public virtual Task<Operation> TransferDomain(TransferDomainRequest request, ServerCallContext context)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name	Description
request	TransferDomainRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateRegistration(UpdateRegistrationRequest, ServerCallContext)

public virtual Task<Operation> UpdateRegistration(UpdateRegistrationRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateRegistrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).