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

public class Domains.DomainsClient : ClientBase<Domains.DomainsClient>

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

Client for Domains

Inheritance

object > ClientBase > ClientBaseDomainsDomainsClient > Domains.DomainsClient

Namespace

Google.Cloud.Domains.V1

Assembly

Google.Cloud.Domains.V1.dll

Constructors

DomainsClient()

protected DomainsClient()

Protected parameterless constructor to allow creation of test doubles.

DomainsClient(CallInvoker)

public DomainsClient(CallInvoker callInvoker)

Creates a new client for Domains that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DomainsClient(ChannelBase)

public DomainsClient(ChannelBase channel)

Creates a new client for Domains

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DomainsClient(ClientBaseConfiguration)

protected DomainsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ConfigureContactSettings(ConfigureContactSettingsRequest, CallOptions)

public virtual Operation ConfigureContactSettings(ConfigureContactSettingsRequest request, CallOptions options)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureContactSettings(ConfigureContactSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ConfigureContactSettings(ConfigureContactSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ConfigureContactSettingsAsync(ConfigureContactSettingsRequest request, CallOptions options)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ConfigureContactSettingsAsync(ConfigureContactSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ConfigureDnsSettings(ConfigureDnsSettingsRequest, CallOptions)

public virtual Operation ConfigureDnsSettings(ConfigureDnsSettingsRequest request, CallOptions options)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureDnsSettings(ConfigureDnsSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ConfigureDnsSettings(ConfigureDnsSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest request, CallOptions options)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ConfigureManagementSettings(ConfigureManagementSettingsRequest, CallOptions)

public virtual Operation ConfigureManagementSettings(ConfigureManagementSettingsRequest request, CallOptions options)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureManagementSettings(ConfigureManagementSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ConfigureManagementSettings(ConfigureManagementSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest request, CallOptions options)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteRegistration(DeleteRegistrationRequest, CallOptions)

public virtual Operation DeleteRegistration(DeleteRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteRegistration(DeleteRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRegistration(DeleteRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteRegistrationAsync(DeleteRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRegistrationAsync(DeleteRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRegistrationAsync(DeleteRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRegistrationAsync(DeleteRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ExportRegistration(ExportRegistrationRequest, CallOptions)

public virtual Operation ExportRegistration(ExportRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ExportRegistration(ExportRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportRegistration(ExportRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ExportRegistrationAsync(ExportRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportRegistrationAsync(ExportRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ExportRegistrationAsync(ExportRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportRegistrationAsync(ExportRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetRegistration(GetRegistrationRequest, CallOptions)

public virtual Registration GetRegistration(GetRegistrationRequest request, CallOptions options)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Registration

The response received from the server.

GetRegistration(GetRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual Registration GetRegistration(GetRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Registration

The response received from the server.

GetRegistrationAsync(GetRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<Registration> GetRegistrationAsync(GetRegistrationRequest request, CallOptions options)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRegistration

The call object.

GetRegistrationAsync(GetRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Registration> GetRegistrationAsync(GetRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRegistration

The call object.

ListRegistrations(ListRegistrationsRequest, CallOptions)

public virtual ListRegistrationsResponse ListRegistrations(ListRegistrationsRequest request, CallOptions options)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListRegistrationsResponse

The response received from the server.

ListRegistrations(ListRegistrationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRegistrationsResponse ListRegistrations(ListRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListRegistrationsResponse

The response received from the server.

ListRegistrationsAsync(ListRegistrationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRegistrationsResponse> ListRegistrationsAsync(ListRegistrationsRequest request, CallOptions options)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListRegistrationsResponse

The call object.

ListRegistrationsAsync(ListRegistrationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRegistrationsResponse> ListRegistrationsAsync(ListRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListRegistrationsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Domains.DomainsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DomainsDomainsClient
Overrides

RegisterDomain(RegisterDomainRequest, CallOptions)

public virtual Operation RegisterDomain(RegisterDomainRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

RegisterDomain(RegisterDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RegisterDomain(RegisterDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

RegisterDomainAsync(RegisterDomainRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RegisterDomainAsync(RegisterDomainRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

RegisterDomainAsync(RegisterDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RegisterDomainAsync(RegisterDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ResetAuthorizationCode(ResetAuthorizationCodeRequest, CallOptions)

public virtual AuthorizationCode ResetAuthorizationCode(ResetAuthorizationCodeRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AuthorizationCode

The response received from the server.

ResetAuthorizationCode(ResetAuthorizationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AuthorizationCode ResetAuthorizationCode(ResetAuthorizationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AuthorizationCode

The response received from the server.

ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CallOptions)

public virtual AsyncUnaryCall<AuthorizationCode> ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAuthorizationCode

The call object.

ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AuthorizationCode> ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallAuthorizationCode

The call object.

RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, CallOptions)

public virtual AuthorizationCode RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AuthorizationCode

The response received from the server.

RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AuthorizationCode RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AuthorizationCode

The response received from the server.

RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CallOptions)

public virtual AsyncUnaryCall<AuthorizationCode> RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAuthorizationCode

The call object.

RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AuthorizationCode> RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallAuthorizationCode

The call object.

RetrieveRegisterParameters(RetrieveRegisterParametersRequest, CallOptions)

public virtual RetrieveRegisterParametersResponse RetrieveRegisterParameters(RetrieveRegisterParametersRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveRegisterParametersResponse

The response received from the server.

RetrieveRegisterParameters(RetrieveRegisterParametersRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveRegisterParametersResponse RetrieveRegisterParameters(RetrieveRegisterParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveRegisterParametersResponse

The response received from the server.

RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveRegisterParametersResponse

The call object.

RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveRegisterParametersResponse

The call object.

RetrieveTransferParameters(RetrieveTransferParametersRequest, CallOptions)

public virtual RetrieveTransferParametersResponse RetrieveTransferParameters(RetrieveTransferParametersRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveTransferParametersResponse

The response received from the server.

RetrieveTransferParameters(RetrieveTransferParametersRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveTransferParametersResponse RetrieveTransferParameters(RetrieveTransferParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveTransferParametersResponse

The response received from the server.

RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(RetrieveTransferParametersRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveTransferParametersResponse

The call object.

RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(RetrieveTransferParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveTransferParametersResponse

The call object.

SearchDomains(SearchDomainsRequest, CallOptions)

public virtual SearchDomainsResponse SearchDomains(SearchDomainsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchDomainsResponse

The response received from the server.

SearchDomains(SearchDomainsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchDomainsResponse SearchDomains(SearchDomainsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SearchDomainsResponse

The response received from the server.

SearchDomainsAsync(SearchDomainsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchDomainsResponse> SearchDomainsAsync(SearchDomainsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchDomainsResponse

The call object.

SearchDomainsAsync(SearchDomainsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchDomainsResponse> SearchDomainsAsync(SearchDomainsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSearchDomainsResponse

The call object.

TransferDomain(TransferDomainRequest, CallOptions)

public virtual Operation TransferDomain(TransferDomainRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

TransferDomain(TransferDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TransferDomain(TransferDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

TransferDomainAsync(TransferDomainRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TransferDomainAsync(TransferDomainRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

TransferDomainAsync(TransferDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TransferDomainAsync(TransferDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateRegistration(UpdateRegistrationRequest, CallOptions)

public virtual Operation UpdateRegistration(UpdateRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateRegistration(UpdateRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateRegistration(UpdateRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateRegistrationAsync(UpdateRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateRegistrationAsync(UpdateRegistrationRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateRegistrationAsync(UpdateRegistrationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateRegistrationAsync(UpdateRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.