Class DomainsGrpc.DomainsStub (1.0.4)

public static final class DomainsGrpc.DomainsStub extends AbstractAsyncStub<DomainsGrpc.DomainsStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > DomainsGrpc.DomainsStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected DomainsGrpc.DomainsStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
DomainsGrpc.DomainsStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

configureContactSettings(ConfigureContactSettingsRequest request, StreamObserver<Operation> responseObserver)

public 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 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 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 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:

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`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

exportRegistration(ExportRegistrationRequest request, StreamObserver<Operation> responseObserver)

public 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 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 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 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 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 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 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 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 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 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 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>`