Class protos.google.cloud.domains.v1.Domains (4.1.0)

Represents a Domains

Inheritance

$protobuf.rpc.Service > protos.google.cloud.domains.v1.Domains

Package

@google-cloud/domains

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Domains service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

configureContactSettings(request, callback)

public configureContactSettings(request: google.cloud.domains.v1.IConfigureContactSettingsRequest, callback: google.cloud.domains.v1.Domains.ConfigureContactSettingsCallback): void;

Calls ConfigureContactSettings.

Parameters
Name Description
request IConfigureContactSettingsRequest

ConfigureContactSettingsRequest message or plain object
callback ConfigureContactSettingsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

configureContactSettings(request)

public configureContactSettings(request: google.cloud.domains.v1.IConfigureContactSettingsRequest): Promise<google.longrunning.Operation>;

Calls ConfigureContactSettings.

Parameter
Name Description
request IConfigureContactSettingsRequest

ConfigureContactSettingsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

configureDnsSettings(request, callback)

public configureDnsSettings(request: google.cloud.domains.v1.IConfigureDnsSettingsRequest, callback: google.cloud.domains.v1.Domains.ConfigureDnsSettingsCallback): void;

Calls ConfigureDnsSettings.

Parameters
Name Description
request IConfigureDnsSettingsRequest

ConfigureDnsSettingsRequest message or plain object
callback ConfigureDnsSettingsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

configureDnsSettings(request)

public configureDnsSettings(request: google.cloud.domains.v1.IConfigureDnsSettingsRequest): Promise<google.longrunning.Operation>;

Calls ConfigureDnsSettings.

Parameter
Name Description
request IConfigureDnsSettingsRequest

ConfigureDnsSettingsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

configureManagementSettings(request, callback)

public configureManagementSettings(request: google.cloud.domains.v1.IConfigureManagementSettingsRequest, callback: google.cloud.domains.v1.Domains.ConfigureManagementSettingsCallback): void;

Calls ConfigureManagementSettings.

Parameters
Name Description
request IConfigureManagementSettingsRequest

ConfigureManagementSettingsRequest message or plain object
callback ConfigureManagementSettingsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

configureManagementSettings(request)

public configureManagementSettings(request: google.cloud.domains.v1.IConfigureManagementSettingsRequest): Promise<google.longrunning.Operation>;

Calls ConfigureManagementSettings.

Parameter
Name Description
request IConfigureManagementSettingsRequest

ConfigureManagementSettingsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Domains;

Creates new Domains service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Domains

RPC service. Useful where requests and/or responses are streamed.

deleteRegistration(request, callback)

public deleteRegistration(request: google.cloud.domains.v1.IDeleteRegistrationRequest, callback: google.cloud.domains.v1.Domains.DeleteRegistrationCallback): void;

Calls DeleteRegistration.

Parameters
Name Description
request IDeleteRegistrationRequest

DeleteRegistrationRequest message or plain object
callback DeleteRegistrationCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteRegistration(request)

public deleteRegistration(request: google.cloud.domains.v1.IDeleteRegistrationRequest): Promise<google.longrunning.Operation>;

Calls DeleteRegistration.

Parameter
Name Description
request IDeleteRegistrationRequest

DeleteRegistrationRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

exportRegistration(request, callback)

public exportRegistration(request: google.cloud.domains.v1.IExportRegistrationRequest, callback: google.cloud.domains.v1.Domains.ExportRegistrationCallback): void;

Calls ExportRegistration.

Parameters
Name Description
request IExportRegistrationRequest

ExportRegistrationRequest message or plain object
callback ExportRegistrationCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

exportRegistration(request)

public exportRegistration(request: google.cloud.domains.v1.IExportRegistrationRequest): Promise<google.longrunning.Operation>;

Calls ExportRegistration.

Parameter
Name Description
request IExportRegistrationRequest

ExportRegistrationRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getRegistration(request, callback)

public getRegistration(request: google.cloud.domains.v1.IGetRegistrationRequest, callback: google.cloud.domains.v1.Domains.GetRegistrationCallback): void;

Calls GetRegistration.

Parameters
Name Description
request IGetRegistrationRequest

GetRegistrationRequest message or plain object
callback GetRegistrationCallback

Node-style callback called with the error, if any, and Registration
Returns
Type Description
void

getRegistration(request)

public getRegistration(request: google.cloud.domains.v1.IGetRegistrationRequest): Promise<google.cloud.domains.v1.Registration>;

Calls GetRegistration.

Parameter
Name Description
request IGetRegistrationRequest

GetRegistrationRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.Registration>

Promise

listRegistrations(request, callback)

public listRegistrations(request: google.cloud.domains.v1.IListRegistrationsRequest, callback: google.cloud.domains.v1.Domains.ListRegistrationsCallback): void;

Calls ListRegistrations.

Parameters
Name Description
request IListRegistrationsRequest

ListRegistrationsRequest message or plain object
callback ListRegistrationsCallback

Node-style callback called with the error, if any, and ListRegistrationsResponse
Returns
Type Description
void

listRegistrations(request)

public listRegistrations(request: google.cloud.domains.v1.IListRegistrationsRequest): Promise<google.cloud.domains.v1.ListRegistrationsResponse>;

Calls ListRegistrations.

Parameter
Name Description
request IListRegistrationsRequest

ListRegistrationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.ListRegistrationsResponse>

Promise

registerDomain(request, callback)

public registerDomain(request: google.cloud.domains.v1.IRegisterDomainRequest, callback: google.cloud.domains.v1.Domains.RegisterDomainCallback): void;

Calls RegisterDomain.

Parameters
Name Description
request IRegisterDomainRequest

RegisterDomainRequest message or plain object
callback RegisterDomainCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

registerDomain(request)

public registerDomain(request: google.cloud.domains.v1.IRegisterDomainRequest): Promise<google.longrunning.Operation>;

Calls RegisterDomain.

Parameter
Name Description
request IRegisterDomainRequest

RegisterDomainRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

resetAuthorizationCode(request, callback)

public resetAuthorizationCode(request: google.cloud.domains.v1.IResetAuthorizationCodeRequest, callback: google.cloud.domains.v1.Domains.ResetAuthorizationCodeCallback): void;

Calls ResetAuthorizationCode.

Parameters
Name Description
request IResetAuthorizationCodeRequest

ResetAuthorizationCodeRequest message or plain object
callback ResetAuthorizationCodeCallback

Node-style callback called with the error, if any, and AuthorizationCode
Returns
Type Description
void

resetAuthorizationCode(request)

public resetAuthorizationCode(request: google.cloud.domains.v1.IResetAuthorizationCodeRequest): Promise<google.cloud.domains.v1.AuthorizationCode>;

Calls ResetAuthorizationCode.

Parameter
Name Description
request IResetAuthorizationCodeRequest

ResetAuthorizationCodeRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.AuthorizationCode>

Promise

retrieveAuthorizationCode(request, callback)

public retrieveAuthorizationCode(request: google.cloud.domains.v1.IRetrieveAuthorizationCodeRequest, callback: google.cloud.domains.v1.Domains.RetrieveAuthorizationCodeCallback): void;

Calls RetrieveAuthorizationCode.

Parameters
Name Description
request IRetrieveAuthorizationCodeRequest

RetrieveAuthorizationCodeRequest message or plain object
callback RetrieveAuthorizationCodeCallback

Node-style callback called with the error, if any, and AuthorizationCode
Returns
Type Description
void

retrieveAuthorizationCode(request)

public retrieveAuthorizationCode(request: google.cloud.domains.v1.IRetrieveAuthorizationCodeRequest): Promise<google.cloud.domains.v1.AuthorizationCode>;

Calls RetrieveAuthorizationCode.

Parameter
Name Description
request IRetrieveAuthorizationCodeRequest

RetrieveAuthorizationCodeRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.AuthorizationCode>

Promise

retrieveRegisterParameters(request, callback)

public retrieveRegisterParameters(request: google.cloud.domains.v1.IRetrieveRegisterParametersRequest, callback: google.cloud.domains.v1.Domains.RetrieveRegisterParametersCallback): void;

Calls RetrieveRegisterParameters.

Parameters
Name Description
request IRetrieveRegisterParametersRequest

RetrieveRegisterParametersRequest message or plain object
callback RetrieveRegisterParametersCallback

Node-style callback called with the error, if any, and RetrieveRegisterParametersResponse
Returns
Type Description
void

retrieveRegisterParameters(request)

public retrieveRegisterParameters(request: google.cloud.domains.v1.IRetrieveRegisterParametersRequest): Promise<google.cloud.domains.v1.RetrieveRegisterParametersResponse>;

Calls RetrieveRegisterParameters.

Parameter
Name Description
request IRetrieveRegisterParametersRequest

RetrieveRegisterParametersRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.RetrieveRegisterParametersResponse>

Promise

retrieveTransferParameters(request, callback)

public retrieveTransferParameters(request: google.cloud.domains.v1.IRetrieveTransferParametersRequest, callback: google.cloud.domains.v1.Domains.RetrieveTransferParametersCallback): void;

Calls RetrieveTransferParameters.

Parameters
Name Description
request IRetrieveTransferParametersRequest

RetrieveTransferParametersRequest message or plain object
callback RetrieveTransferParametersCallback

Node-style callback called with the error, if any, and RetrieveTransferParametersResponse
Returns
Type Description
void

retrieveTransferParameters(request)

public retrieveTransferParameters(request: google.cloud.domains.v1.IRetrieveTransferParametersRequest): Promise<google.cloud.domains.v1.RetrieveTransferParametersResponse>;

Calls RetrieveTransferParameters.

Parameter
Name Description
request IRetrieveTransferParametersRequest

RetrieveTransferParametersRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.RetrieveTransferParametersResponse>

Promise

searchDomains(request, callback)

public searchDomains(request: google.cloud.domains.v1.ISearchDomainsRequest, callback: google.cloud.domains.v1.Domains.SearchDomainsCallback): void;

Calls SearchDomains.

Parameters
Name Description
request ISearchDomainsRequest

SearchDomainsRequest message or plain object
callback SearchDomainsCallback

Node-style callback called with the error, if any, and SearchDomainsResponse
Returns
Type Description
void

searchDomains(request)

public searchDomains(request: google.cloud.domains.v1.ISearchDomainsRequest): Promise<google.cloud.domains.v1.SearchDomainsResponse>;

Calls SearchDomains.

Parameter
Name Description
request ISearchDomainsRequest

SearchDomainsRequest message or plain object
Returns
Type Description
Promise<google.cloud.domains.v1.SearchDomainsResponse>

Promise

transferDomain(request, callback)

public transferDomain(request: google.cloud.domains.v1.ITransferDomainRequest, callback: google.cloud.domains.v1.Domains.TransferDomainCallback): void;

Calls TransferDomain.

Parameters
Name Description
request ITransferDomainRequest

TransferDomainRequest message or plain object
callback TransferDomainCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

transferDomain(request)

public transferDomain(request: google.cloud.domains.v1.ITransferDomainRequest): Promise<google.longrunning.Operation>;

Calls TransferDomain.

Parameter
Name Description
request ITransferDomainRequest

TransferDomainRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateRegistration(request, callback)

public updateRegistration(request: google.cloud.domains.v1.IUpdateRegistrationRequest, callback: google.cloud.domains.v1.Domains.UpdateRegistrationCallback): void;

Calls UpdateRegistration.

Parameters
Name Description
request IUpdateRegistrationRequest

UpdateRegistrationRequest message or plain object
callback UpdateRegistrationCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateRegistration(request)

public updateRegistration(request: google.cloud.domains.v1.IUpdateRegistrationRequest): Promise<google.longrunning.Operation>;

Calls UpdateRegistration.

Parameter
Name Description
request IUpdateRegistrationRequest

UpdateRegistrationRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise