Send feedback
Class v1alpha2.DomainsClient (1.1.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 1.1.0 keyboard_arrow_down
The Cloud Domains API enables management and configuration of domain names. v1alpha2
Package
@google-cloud/domains!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of DomainsClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
domainsStub
domainsStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
checkConfigureContactSettingsProgress(name)
checkConfigureContactSettingsProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by configureContactSettings()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkConfigureDnsSettingsProgress(name)
checkConfigureDnsSettingsProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by configureDnsSettings()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkConfigureManagementSettingsProgress(name)
checkConfigureManagementSettingsProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by configureManagementSettings()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkDeleteRegistrationProgress(name)
checkDeleteRegistrationProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteRegistration()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkExportRegistrationProgress(name)
checkExportRegistrationProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by exportRegistration()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkRegisterDomainProgress(name)
checkRegisterDomainProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by registerDomain()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkUpdateRegistrationProgress(name)
checkUpdateRegistrationProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
Registration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateRegistration()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.domains.v1alpha2.Registration
, protos. google.cloud.domains.v1alpha2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
configureContactSettings(request, options)
configureContactSettings
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureContactSettingsRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureContactSettingsRequest
options
CallOptions
Returns
configureContactSettings(request, options, callback)
configureContactSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureContactSettingsRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureContactSettingsRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
configureContactSettings(request, callback)
configureContactSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureContactSettingsRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureContactSettingsRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
configureDnsSettings(request, options)
configureDnsSettings
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureDnsSettingsRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureDnsSettingsRequest
options
CallOptions
Returns
configureDnsSettings(request, options, callback)
configureDnsSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureDnsSettingsRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureDnsSettingsRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
configureDnsSettings(request, callback)
configureDnsSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureDnsSettingsRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureDnsSettingsRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
configureManagementSettings(request, options)
configureManagementSettings
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureManagementSettingsRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureManagementSettingsRequest
options
CallOptions
Returns
configureManagementSettings(request, options, callback)
configureManagementSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureManagementSettingsRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureManagementSettingsRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
configureManagementSettings(request, callback)
configureManagementSettings
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IConfigureManagementSettingsRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IConfigureManagementSettingsRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteRegistration(request, options)
deleteRegistration
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IDeleteRegistrationRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IDeleteRegistrationRequest
options
CallOptions
Returns
deleteRegistration(request, options, callback)
deleteRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IDeleteRegistrationRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IDeleteRegistrationRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteRegistration(request, callback)
deleteRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IDeleteRegistrationRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IDeleteRegistrationRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
exportRegistration(request, options)
exportRegistration
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IExportRegistrationRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IExportRegistrationRequest
options
CallOptions
Returns
exportRegistration(request, options, callback)
exportRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IExportRegistrationRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IExportRegistrationRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
exportRegistration(request, callback)
exportRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IExportRegistrationRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IExportRegistrationRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
getRegistration(request, options)
getRegistration
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IGetRegistrationRequest
options
CallOptions
Returns
getRegistration(request, options, callback)
getRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IGetRegistrationRequest
options
CallOptions
callback
Callback
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IGetRegistrationRequest
| null | undefined, {} | null | undefined>
Returns
getRegistration(request, callback)
getRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IGetRegistrationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IGetRegistrationRequest
callback
Callback
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IGetRegistrationRequest
| null | undefined, {} | null | undefined>
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listRegistrations(request, options)
listRegistrations
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
[],
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
|
null
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsResponse
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
options
CallOptions
Returns
listRegistrations(request, options, callback)
listRegistrations
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
, protos. google.cloud.domains.v1alpha2.IListRegistrationsResponse
| null | undefined, protos. google.cloud.domains.v1alpha2.IRegistration
>
Returns
listRegistrations(request, callback)
listRegistrations
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
callback
PaginationCallback
<protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
, protos. google.cloud.domains.v1alpha2.IListRegistrationsResponse
| null | undefined, protos. google.cloud.domains.v1alpha2.IRegistration
>
Returns
listRegistrationsAsync(request, options)
listRegistrationsAsync
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
> ;
Equivalent to listRegistrations
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.domains.v1alpha2.IRegistration
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Registration]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listRegistrationsStream(request, options)
listRegistrationsStream
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IListRegistrationsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IListRegistrationsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
Transform
{Stream} An object stream which emits an object representing [Registration] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRegistrationsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchLocationFromRegistrationName(registrationName)
matchLocationFromRegistrationName
(
registrationName
:
string
)
:
string
|
number
;
Parse the location from Registration resource.
Parameter Name
Description
registrationName
string
A fully-qualified path representing Registration resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromRegistrationName(registrationName)
matchProjectFromRegistrationName
(
registrationName
:
string
)
:
string
|
number
;
Parse the project from Registration resource.
Parameter Name
Description
registrationName
string
A fully-qualified path representing Registration resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchRegistrationFromRegistrationName(registrationName)
matchRegistrationFromRegistrationName
(
registrationName
:
string
)
:
string
|
number
;
Parse the registration from Registration resource.
Parameter Name
Description
registrationName
string
A fully-qualified path representing Registration resource.
Returns Type
Description
string | number
{string} A string representing the registration.
registerDomain(request, options)
registerDomain
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegisterDomainRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRegisterDomainRequest
options
CallOptions
Returns
registerDomain(request, options, callback)
registerDomain
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegisterDomainRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRegisterDomainRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
registerDomain(request, callback)
registerDomain
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegisterDomainRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRegisterDomainRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
registrationPath(project, location, registration)
registrationPath
(
project
:
string
,
location
:
string
,
registration
:
string
)
:
string
;
Return a fully-qualified registration resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
resetAuthorizationCode(request, options)
resetAuthorizationCode
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
(
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IResetAuthorizationCodeRequest
options
CallOptions
Returns
resetAuthorizationCode(request, options, callback)
resetAuthorizationCode
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IResetAuthorizationCodeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.domains.v1alpha2.IAuthorizationCode
, protos. google.cloud.domains.v1alpha2.IResetAuthorizationCodeRequest
| null | undefined, {} | null | undefined>
Returns
resetAuthorizationCode(request, callback)
resetAuthorizationCode
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IResetAuthorizationCodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IResetAuthorizationCodeRequest
callback
Callback
<protos. google.cloud.domains.v1alpha2.IAuthorizationCode
, protos. google.cloud.domains.v1alpha2.IResetAuthorizationCodeRequest
| null | undefined, {} | null | undefined>
Returns
retrieveAuthorizationCode(request, options)
retrieveAuthorizationCode
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
(
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveAuthorizationCodeRequest
options
CallOptions
Returns
retrieveAuthorizationCode(request, options, callback)
retrieveAuthorizationCode
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveAuthorizationCodeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.domains.v1alpha2.IAuthorizationCode
, protos. google.cloud.domains.v1alpha2.IRetrieveAuthorizationCodeRequest
| null | undefined, {} | null | undefined>
Returns
retrieveAuthorizationCode(request, callback)
retrieveAuthorizationCode
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IAuthorizationCode
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveAuthorizationCodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveAuthorizationCodeRequest
callback
Callback
<protos. google.cloud.domains.v1alpha2.IAuthorizationCode
, protos. google.cloud.domains.v1alpha2.IRetrieveAuthorizationCodeRequest
| null | undefined, {} | null | undefined>
Returns
retrieveRegisterParameters(request, options)
retrieveRegisterParameters
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersResponse
,
(
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersRequest
options
CallOptions
Returns
retrieveRegisterParameters(request, options, callback)
retrieveRegisterParameters
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersResponse
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersRequest
options
CallOptions
callback
Callback
<protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersResponse
, protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersRequest
| null | undefined, {} | null | undefined>
Returns
retrieveRegisterParameters(request, callback)
retrieveRegisterParameters
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersResponse
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRetrieveRegisterParametersRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersRequest
callback
Callback
<protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersResponse
, protos. google.cloud.domains.v1alpha2.IRetrieveRegisterParametersRequest
| null | undefined, {} | null | undefined>
Returns
searchDomains(request, options)
searchDomains
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsResponse
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.ISearchDomainsRequest
options
CallOptions
Returns
searchDomains(request, options, callback)
searchDomains
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsResponse
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.ISearchDomainsRequest
options
CallOptions
callback
Callback
<protos. google.cloud.domains.v1alpha2.ISearchDomainsResponse
, protos. google.cloud.domains.v1alpha2.ISearchDomainsRequest
| null | undefined, {} | null | undefined>
Returns
searchDomains(request, callback)
searchDomains
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsResponse
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
ISearchDomainsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.ISearchDomainsRequest
callback
Callback
<protos. google.cloud.domains.v1alpha2.ISearchDomainsResponse
, protos. google.cloud.domains.v1alpha2.ISearchDomainsRequest
| null | undefined, {} | null | undefined>
Returns
updateRegistration(request, options)
updateRegistration
(
request
?:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IUpdateRegistrationRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IUpdateRegistrationRequest
options
CallOptions
Returns
updateRegistration(request, options, callback)
updateRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IUpdateRegistrationRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IUpdateRegistrationRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateRegistration(request, callback)
updateRegistration
(
request
:
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IUpdateRegistrationRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IRegistration
,
protos
.
google
.
cloud
.
domains
.
v1alpha2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.domains.v1alpha2.IUpdateRegistrationRequest
callback
Callback
< LROperation
<protos. google.cloud.domains.v1alpha2.IRegistration
, protos. google.cloud.domains.v1alpha2.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
