Cloud Domains v1 API - Class DomainsClientImpl (2.1.0-beta01)

Version 2.1.0-beta01

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

public sealed class DomainsClientImpl : DomainsClient

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

Domains client wrapper implementation, for convenient use.

Inheritance

Object > DomainsClient > DomainsClientImpl

Inherited Members

DomainsClient.DefaultEndpoint

DomainsClient.DefaultScopes

DomainsClient.ServiceMetadata

DomainsClient.CreateAsync(CancellationToken)

DomainsClient.Create()

DomainsClient.ShutdownDefaultChannelsAsync()

DomainsClient.SearchDomainsAsync(SearchDomainsRequest, CancellationToken)

DomainsClient.SearchDomains(String, String, CallSettings)

DomainsClient.SearchDomainsAsync(String, String, CallSettings)

DomainsClient.SearchDomainsAsync(String, String, CancellationToken)

DomainsClient.SearchDomains(LocationName, String, CallSettings)

DomainsClient.SearchDomainsAsync(LocationName, String, CallSettings)

DomainsClient.SearchDomainsAsync(LocationName, String, CancellationToken)

DomainsClient.RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CancellationToken)

DomainsClient.RetrieveRegisterParameters(String, String, CallSettings)

DomainsClient.RetrieveRegisterParametersAsync(String, String, CallSettings)

DomainsClient.RetrieveRegisterParametersAsync(String, String, CancellationToken)

DomainsClient.RetrieveRegisterParameters(LocationName, String, CallSettings)

DomainsClient.RetrieveRegisterParametersAsync(LocationName, String, CallSettings)

DomainsClient.RetrieveRegisterParametersAsync(LocationName, String, CancellationToken)

DomainsClient.RegisterDomainAsync(RegisterDomainRequest, CancellationToken)

DomainsClient.PollOnceRegisterDomain(String, CallSettings)

DomainsClient.PollOnceRegisterDomainAsync(String, CallSettings)

DomainsClient.RegisterDomain(String, Registration, Money, CallSettings)

DomainsClient.RegisterDomainAsync(String, Registration, Money, CallSettings)

DomainsClient.RegisterDomainAsync(String, Registration, Money, CancellationToken)

DomainsClient.RegisterDomain(LocationName, Registration, Money, CallSettings)

DomainsClient.RegisterDomainAsync(LocationName, Registration, Money, CallSettings)

DomainsClient.RegisterDomainAsync(LocationName, Registration, Money, CancellationToken)

DomainsClient.RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CancellationToken)

DomainsClient.RetrieveTransferParameters(String, String, CallSettings)

DomainsClient.RetrieveTransferParametersAsync(String, String, CallSettings)

DomainsClient.RetrieveTransferParametersAsync(String, String, CancellationToken)

DomainsClient.RetrieveTransferParameters(LocationName, String, CallSettings)

DomainsClient.RetrieveTransferParametersAsync(LocationName, String, CallSettings)

DomainsClient.RetrieveTransferParametersAsync(LocationName, String, CancellationToken)

DomainsClient.TransferDomainAsync(TransferDomainRequest, CancellationToken)

DomainsClient.PollOnceTransferDomain(String, CallSettings)

DomainsClient.PollOnceTransferDomainAsync(String, CallSettings)

DomainsClient.TransferDomain(String, Registration, Money, AuthorizationCode, CallSettings)

DomainsClient.TransferDomainAsync(String, Registration, Money, AuthorizationCode, CallSettings)

DomainsClient.TransferDomainAsync(String, Registration, Money, AuthorizationCode, CancellationToken)

DomainsClient.TransferDomain(LocationName, Registration, Money, AuthorizationCode, CallSettings)

DomainsClient.TransferDomainAsync(LocationName, Registration, Money, AuthorizationCode, CallSettings)

DomainsClient.TransferDomainAsync(LocationName, Registration, Money, AuthorizationCode, CancellationToken)

DomainsClient.ListRegistrations(String, String, Nullable<Int32>, CallSettings)

DomainsClient.ListRegistrationsAsync(String, String, Nullable<Int32>, CallSettings)

DomainsClient.ListRegistrations(LocationName, String, Nullable<Int32>, CallSettings)

DomainsClient.ListRegistrationsAsync(LocationName, String, Nullable<Int32>, CallSettings)

DomainsClient.GetRegistrationAsync(GetRegistrationRequest, CancellationToken)

DomainsClient.GetRegistration(String, CallSettings)

DomainsClient.GetRegistrationAsync(String, CallSettings)

DomainsClient.GetRegistrationAsync(String, CancellationToken)

DomainsClient.GetRegistration(RegistrationName, CallSettings)

DomainsClient.GetRegistrationAsync(RegistrationName, CallSettings)

DomainsClient.GetRegistrationAsync(RegistrationName, CancellationToken)

DomainsClient.UpdateRegistrationAsync(UpdateRegistrationRequest, CancellationToken)

DomainsClient.PollOnceUpdateRegistration(String, CallSettings)

DomainsClient.PollOnceUpdateRegistrationAsync(String, CallSettings)

DomainsClient.UpdateRegistration(Registration, FieldMask, CallSettings)

DomainsClient.UpdateRegistrationAsync(Registration, FieldMask, CallSettings)

DomainsClient.UpdateRegistrationAsync(Registration, FieldMask, CancellationToken)

DomainsClient.ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CancellationToken)

DomainsClient.PollOnceConfigureManagementSettings(String, CallSettings)

DomainsClient.PollOnceConfigureManagementSettingsAsync(String, CallSettings)

DomainsClient.ConfigureManagementSettings(String, ManagementSettings, FieldMask, CallSettings)

DomainsClient.ConfigureManagementSettingsAsync(String, ManagementSettings, FieldMask, CallSettings)

DomainsClient.ConfigureManagementSettingsAsync(String, ManagementSettings, FieldMask, CancellationToken)

DomainsClient.ConfigureManagementSettings(RegistrationName, ManagementSettings, FieldMask, CallSettings)

DomainsClient.ConfigureManagementSettingsAsync(RegistrationName, ManagementSettings, FieldMask, CallSettings)

DomainsClient.ConfigureManagementSettingsAsync(RegistrationName, ManagementSettings, FieldMask, CancellationToken)

DomainsClient.ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CancellationToken)

DomainsClient.PollOnceConfigureDnsSettings(String, CallSettings)

DomainsClient.PollOnceConfigureDnsSettingsAsync(String, CallSettings)

DomainsClient.ConfigureDnsSettings(String, DnsSettings, FieldMask, CallSettings)

DomainsClient.ConfigureDnsSettingsAsync(String, DnsSettings, FieldMask, CallSettings)

DomainsClient.ConfigureDnsSettingsAsync(String, DnsSettings, FieldMask, CancellationToken)

DomainsClient.ConfigureDnsSettings(RegistrationName, DnsSettings, FieldMask, CallSettings)

DomainsClient.ConfigureDnsSettingsAsync(RegistrationName, DnsSettings, FieldMask, CallSettings)

DomainsClient.ConfigureDnsSettingsAsync(RegistrationName, DnsSettings, FieldMask, CancellationToken)

DomainsClient.ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CancellationToken)

DomainsClient.PollOnceConfigureContactSettings(String, CallSettings)

DomainsClient.PollOnceConfigureContactSettingsAsync(String, CallSettings)

DomainsClient.ConfigureContactSettings(String, ContactSettings, FieldMask, CallSettings)

DomainsClient.ConfigureContactSettingsAsync(String, ContactSettings, FieldMask, CallSettings)

DomainsClient.ConfigureContactSettingsAsync(String, ContactSettings, FieldMask, CancellationToken)

DomainsClient.ConfigureContactSettings(RegistrationName, ContactSettings, FieldMask, CallSettings)

DomainsClient.ConfigureContactSettingsAsync(RegistrationName, ContactSettings, FieldMask, CallSettings)

DomainsClient.ConfigureContactSettingsAsync(RegistrationName, ContactSettings, FieldMask, CancellationToken)

DomainsClient.ExportRegistrationAsync(ExportRegistrationRequest, CancellationToken)

DomainsClient.PollOnceExportRegistration(String, CallSettings)

DomainsClient.PollOnceExportRegistrationAsync(String, CallSettings)

DomainsClient.ExportRegistration(String, CallSettings)

DomainsClient.ExportRegistrationAsync(String, CallSettings)

DomainsClient.ExportRegistrationAsync(String, CancellationToken)

DomainsClient.ExportRegistration(RegistrationName, CallSettings)

DomainsClient.ExportRegistrationAsync(RegistrationName, CallSettings)

DomainsClient.ExportRegistrationAsync(RegistrationName, CancellationToken)

DomainsClient.DeleteRegistrationAsync(DeleteRegistrationRequest, CancellationToken)

DomainsClient.PollOnceDeleteRegistration(String, CallSettings)

DomainsClient.PollOnceDeleteRegistrationAsync(String, CallSettings)

DomainsClient.DeleteRegistration(String, CallSettings)

DomainsClient.DeleteRegistrationAsync(String, CallSettings)

DomainsClient.DeleteRegistrationAsync(String, CancellationToken)

DomainsClient.DeleteRegistration(RegistrationName, CallSettings)

DomainsClient.DeleteRegistrationAsync(RegistrationName, CallSettings)

DomainsClient.DeleteRegistrationAsync(RegistrationName, CancellationToken)

DomainsClient.RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CancellationToken)

DomainsClient.RetrieveAuthorizationCode(String, CallSettings)

DomainsClient.RetrieveAuthorizationCodeAsync(String, CallSettings)

DomainsClient.RetrieveAuthorizationCodeAsync(String, CancellationToken)

DomainsClient.RetrieveAuthorizationCode(RegistrationName, CallSettings)

DomainsClient.RetrieveAuthorizationCodeAsync(RegistrationName, CallSettings)

DomainsClient.RetrieveAuthorizationCodeAsync(RegistrationName, CancellationToken)

DomainsClient.ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CancellationToken)

DomainsClient.ResetAuthorizationCode(String, CallSettings)

DomainsClient.ResetAuthorizationCodeAsync(String, CallSettings)

DomainsClient.ResetAuthorizationCodeAsync(String, CancellationToken)

DomainsClient.ResetAuthorizationCode(RegistrationName, CallSettings)

DomainsClient.ResetAuthorizationCodeAsync(RegistrationName, CallSettings)

DomainsClient.ResetAuthorizationCodeAsync(RegistrationName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Domains.V1

Assembly

Google.Cloud.Domains.V1.dll

Remarks

The Cloud Domains API enables management and configuration of domain names.

Constructors

DomainsClientImpl(Domains.DomainsClient, DomainsSettings, ILogger)

public DomainsClientImpl(Domains.DomainsClient grpcClient, DomainsSettings settings, ILogger logger)

Constructs a client wrapper for the Domains service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	Domains.DomainsClient The underlying gRPC client.
settings	DomainsSettings The base DomainsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

ConfigureContactSettingsOperationsClient

public override OperationsClient ConfigureContactSettingsOperationsClient { get; }

The long-running operations client for ConfigureContactSettings.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.ConfigureContactSettingsOperationsClient

ConfigureDnsSettingsOperationsClient

public override OperationsClient ConfigureDnsSettingsOperationsClient { get; }

The long-running operations client for ConfigureDnsSettings.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.ConfigureDnsSettingsOperationsClient

ConfigureManagementSettingsOperationsClient

public override OperationsClient ConfigureManagementSettingsOperationsClient { get; }

The long-running operations client for ConfigureManagementSettings.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.ConfigureManagementSettingsOperationsClient

DeleteRegistrationOperationsClient

public override OperationsClient DeleteRegistrationOperationsClient { get; }

The long-running operations client for DeleteRegistration.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.DeleteRegistrationOperationsClient

ExportRegistrationOperationsClient

public override OperationsClient ExportRegistrationOperationsClient { get; }

The long-running operations client for ExportRegistration.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.ExportRegistrationOperationsClient

GrpcClient

public override Domains.DomainsClient GrpcClient { get; }

The underlying gRPC Domains client

Property Value
Type	Description
Domains.DomainsClient

Overrides

DomainsClient.GrpcClient

RegisterDomainOperationsClient

public override OperationsClient RegisterDomainOperationsClient { get; }

The long-running operations client for RegisterDomain.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.RegisterDomainOperationsClient

TransferDomainOperationsClient

public override OperationsClient TransferDomainOperationsClient { get; }

The long-running operations client for TransferDomain.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.TransferDomainOperationsClient

UpdateRegistrationOperationsClient

public override OperationsClient UpdateRegistrationOperationsClient { get; }

The long-running operations client for UpdateRegistration.

Property Value
Type	Description
OperationsClient

Overrides

DomainsClient.UpdateRegistrationOperationsClient

Methods

ConfigureContactSettings(ConfigureContactSettingsRequest, CallSettings)

public override Operation<Registration, OperationMetadata> ConfigureContactSettings(ConfigureContactSettingsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ConfigureContactSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.ConfigureContactSettings(ConfigureContactSettingsRequest, CallSettings)

ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(ConfigureContactSettingsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ConfigureContactSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CallSettings)

ConfigureDnsSettings(ConfigureDnsSettingsRequest, CallSettings)

public override Operation<Registration, OperationMetadata> ConfigureDnsSettings(ConfigureDnsSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name	Description
request	ConfigureDnsSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.ConfigureDnsSettings(ConfigureDnsSettingsRequest, CallSettings)

ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name	Description
request	ConfigureDnsSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CallSettings)

ConfigureManagementSettings(ConfigureManagementSettingsRequest, CallSettings)

public override Operation<Registration, OperationMetadata> ConfigureManagementSettings(ConfigureManagementSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name	Description
request	ConfigureManagementSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.ConfigureManagementSettings(ConfigureManagementSettingsRequest, CallSettings)

ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name	Description
request	ConfigureManagementSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CallSettings)

DeleteRegistration(DeleteRegistrationRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteRegistration(DeleteRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Empty, OperationMetadata>	The RPC response.

Overrides

DomainsClient.DeleteRegistration(DeleteRegistrationRequest, CallSettings)

DeleteRegistrationAsync(DeleteRegistrationRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(DeleteRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.DeleteRegistrationAsync(DeleteRegistrationRequest, CallSettings)

ExportRegistration(ExportRegistrationRequest, CallSettings)

public override Operation<Registration, OperationMetadata> ExportRegistration(ExportRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.ExportRegistration(ExportRegistrationRequest, CallSettings)

ExportRegistrationAsync(ExportRegistrationRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(ExportRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.ExportRegistrationAsync(ExportRegistrationRequest, CallSettings)

GetRegistration(GetRegistrationRequest, CallSettings)

public override Registration GetRegistration(GetRegistrationRequest request, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name	Description
request	GetRegistrationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Registration	The RPC response.

Overrides

DomainsClient.GetRegistration(GetRegistrationRequest, CallSettings)

GetRegistrationAsync(GetRegistrationRequest, CallSettings)

public override Task<Registration> GetRegistrationAsync(GetRegistrationRequest request, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name	Description
request	GetRegistrationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Registration>	A Task containing the RPC response.

Overrides

DomainsClient.GetRegistrationAsync(GetRegistrationRequest, CallSettings)

ListRegistrations(ListRegistrationsRequest, CallSettings)

public override PagedEnumerable<ListRegistrationsResponse, Registration> ListRegistrations(ListRegistrationsRequest request, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name	Description
request	ListRegistrationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListRegistrationsResponse, Registration>	A pageable sequence of Registration resources.

Overrides

DomainsClient.ListRegistrations(ListRegistrationsRequest, CallSettings)

ListRegistrationsAsync(ListRegistrationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRegistrationsResponse, Registration> ListRegistrationsAsync(ListRegistrationsRequest request, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name	Description
request	ListRegistrationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListRegistrationsResponse, Registration>	A pageable asynchronous sequence of Registration resources.

Overrides

DomainsClient.ListRegistrationsAsync(ListRegistrationsRequest, CallSettings)

RegisterDomain(RegisterDomainRequest, CallSettings)

public override Operation<Registration, OperationMetadata> RegisterDomain(RegisterDomainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.RegisterDomain(RegisterDomainRequest, CallSettings)

RegisterDomainAsync(RegisterDomainRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(RegisterDomainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.RegisterDomainAsync(RegisterDomainRequest, CallSettings)

ResetAuthorizationCode(ResetAuthorizationCodeRequest, CallSettings)

public override AuthorizationCode ResetAuthorizationCode(ResetAuthorizationCodeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AuthorizationCode	The RPC response.

Overrides

DomainsClient.ResetAuthorizationCode(ResetAuthorizationCodeRequest, CallSettings)

ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CallSettings)

public override Task<AuthorizationCode> ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<AuthorizationCode>	A Task containing the RPC response.

Overrides

DomainsClient.ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CallSettings)

RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, CallSettings)

public override AuthorizationCode RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AuthorizationCode	The RPC response.

Overrides

DomainsClient.RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, CallSettings)

RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CallSettings)

public override Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<AuthorizationCode>	A Task containing the RPC response.

Overrides

DomainsClient.RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CallSettings)

RetrieveRegisterParameters(RetrieveRegisterParametersRequest, CallSettings)

public override RetrieveRegisterParametersResponse RetrieveRegisterParameters(RetrieveRegisterParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RetrieveRegisterParametersResponse	The RPC response.

Overrides

DomainsClient.RetrieveRegisterParameters(RetrieveRegisterParametersRequest, CallSettings)

RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CallSettings)

public override Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<RetrieveRegisterParametersResponse>	A Task containing the RPC response.

Overrides

DomainsClient.RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CallSettings)

RetrieveTransferParameters(RetrieveTransferParametersRequest, CallSettings)

public override RetrieveTransferParametersResponse RetrieveTransferParameters(RetrieveTransferParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RetrieveTransferParametersResponse	The RPC response.

Overrides

DomainsClient.RetrieveTransferParameters(RetrieveTransferParametersRequest, CallSettings)

RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CallSettings)

public override Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(RetrieveTransferParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<RetrieveTransferParametersResponse>	A Task containing the RPC response.

Overrides

DomainsClient.RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CallSettings)

SearchDomains(SearchDomainsRequest, CallSettings)

public override SearchDomainsResponse SearchDomains(SearchDomainsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SearchDomainsResponse	The RPC response.

Overrides

DomainsClient.SearchDomains(SearchDomainsRequest, CallSettings)

SearchDomainsAsync(SearchDomainsRequest, CallSettings)

public override Task<SearchDomainsResponse> SearchDomainsAsync(SearchDomainsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<SearchDomainsResponse>	A Task containing the RPC response.

Overrides

DomainsClient.SearchDomainsAsync(SearchDomainsRequest, CallSettings)

TransferDomain(TransferDomainRequest, CallSettings)

public override Operation<Registration, OperationMetadata> TransferDomain(TransferDomainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.TransferDomain(TransferDomainRequest, CallSettings)

TransferDomainAsync(TransferDomainRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(TransferDomainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.TransferDomainAsync(TransferDomainRequest, CallSettings)

UpdateRegistration(UpdateRegistrationRequest, CallSettings)

public override Operation<Registration, OperationMetadata> UpdateRegistration(UpdateRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Registration, OperationMetadata>	The RPC response.

Overrides

DomainsClient.UpdateRegistration(UpdateRegistrationRequest, CallSettings)

UpdateRegistrationAsync(UpdateRegistrationRequest, CallSettings)

public override async Task<Operation<Registration, OperationMetadata>> UpdateRegistrationAsync(UpdateRegistrationRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Registration, OperationMetadata>>	A Task containing the RPC response.

Overrides

DomainsClient.UpdateRegistrationAsync(UpdateRegistrationRequest, CallSettings)