- 1.50.0 (latest)
- 1.49.0
- 1.48.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.6
- 0.7.0
- 0.6.1
- 0.5.4
public static interface DomainsGrpc.AsyncServiceThe Cloud Domains API enables management and configuration of domain names.
Methods
configureContactSettings(ConfigureContactSettingsRequest request, StreamObserver<Operation> responseObserver)
public default void configureContactSettings(ConfigureContactSettingsRequest request, StreamObserver<Operation> responseObserver) Updates a Registration's contact settings. Some changes require
confirmation by the domain's registrant contact .
| Parameters | |
|---|---|
| Name | Description |
request |
ConfigureContactSettingsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
configureDnsSettings(ConfigureDnsSettingsRequest request, StreamObserver<Operation> responseObserver)
public default void configureDnsSettings(ConfigureDnsSettingsRequest request, StreamObserver<Operation> responseObserver) Updates a Registration's DNS settings.
| Parameters | |
|---|---|
| Name | Description |
request |
ConfigureDnsSettingsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
configureManagementSettings(ConfigureManagementSettingsRequest request, StreamObserver<Operation> responseObserver)
public default void configureManagementSettings(ConfigureManagementSettingsRequest request, StreamObserver<Operation> responseObserver) Updates a Registration's management settings.
| Parameters | |
|---|---|
| Name | Description |
request |
ConfigureManagementSettingsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deleteRegistration(DeleteRegistrationRequest request, StreamObserver<Operation> responseObserver)
public default void deleteRegistration(DeleteRegistrationRequest request, StreamObserver<Operation> responseObserver) 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:
stateisEXPORTEDwithexpire_timein the paststateisREGISTRATION_FAILEDstateisTRANSFER_FAILEDWhen 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 |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
exportRegistration(ExportRegistrationRequest request, StreamObserver<Operation> responseObserver)
public default void exportRegistration(ExportRegistrationRequest request, StreamObserver<Operation> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
getRegistration(GetRegistrationRequest request, StreamObserver<Registration> responseObserver)
public default void getRegistration(GetRegistrationRequest request, StreamObserver<Registration> responseObserver) Gets the details of a Registration resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRegistrationRequest |
responseObserver |
io.grpc.stub.StreamObserver<Registration> |
listRegistrations(ListRegistrationsRequest request, StreamObserver<ListRegistrationsResponse> responseObserver)
public default void listRegistrations(ListRegistrationsRequest request, StreamObserver<ListRegistrationsResponse> responseObserver) Lists the Registration resources in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRegistrationsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListRegistrationsResponse> |
registerDomain(RegisterDomainRequest request, StreamObserver<Operation> responseObserver)
public default void registerDomain(RegisterDomainRequest request, StreamObserver<Operation> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
resetAuthorizationCode(ResetAuthorizationCodeRequest request, StreamObserver<AuthorizationCode> responseObserver)
public default void resetAuthorizationCode(ResetAuthorizationCodeRequest request, StreamObserver<AuthorizationCode> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<AuthorizationCode> |
retrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, StreamObserver<AuthorizationCode> responseObserver)
public default void retrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, StreamObserver<AuthorizationCode> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<AuthorizationCode> |
retrieveRegisterParameters(RetrieveRegisterParametersRequest request, StreamObserver<RetrieveRegisterParametersResponse> responseObserver)
public default void retrieveRegisterParameters(RetrieveRegisterParametersRequest request, StreamObserver<RetrieveRegisterParametersResponse> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<RetrieveRegisterParametersResponse> |
retrieveTransferParameters(RetrieveTransferParametersRequest request, StreamObserver<RetrieveTransferParametersResponse> responseObserver)
public default void retrieveTransferParameters(RetrieveTransferParametersRequest request, StreamObserver<RetrieveTransferParametersResponse> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<RetrieveTransferParametersResponse> |
searchDomains(SearchDomainsRequest request, StreamObserver<SearchDomainsResponse> responseObserver)
public default void searchDomains(SearchDomainsRequest request, StreamObserver<SearchDomainsResponse> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<SearchDomainsResponse> |
transferDomain(TransferDomainRequest request, StreamObserver<Operation> responseObserver)
public default void transferDomain(TransferDomainRequest request, StreamObserver<Operation> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateRegistration(UpdateRegistrationRequest request, StreamObserver<Operation> responseObserver)
public default void updateRegistration(UpdateRegistrationRequest request, StreamObserver<Operation> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |