Package com.google.cloud.domains.v1alpha2

Class DomainsGrpc.DomainsBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<DomainsGrpc.DomainsBlockingV2Stub>
com.google.cloud.domains.v1alpha2.DomainsGrpc.DomainsBlockingV2Stub
Enclosing class:
DomainsGrpc
public static final class DomainsGrpc.DomainsBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<DomainsGrpc.DomainsBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service Domains. 
 The Cloud Domains API enables management and configuration of domain names.

  • Method Details

    • build

      protected DomainsGrpc.DomainsBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<DomainsGrpc.DomainsBlockingV2Stub>

    • searchDomains

      public SearchDomainsResponse searchDomains(SearchDomainsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • retrieveRegisterParameters

      public RetrieveRegisterParametersResponse retrieveRegisterParameters(RetrieveRegisterParametersRequest request) throws io.grpc.StatusException
       Gets parameters needed to register a new domain name, including price and
 up-to-date availability. Use the returned values to call `RegisterDomain`.
      Throws:
      io.grpc.StatusException

    • registerDomain

      public Operation registerDomain(RegisterDomainRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • retrieveTransferParameters

      public RetrieveTransferParametersResponse retrieveTransferParameters(RetrieveTransferParametersRequest request) throws io.grpc.StatusException
       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`.
      Throws:
      io.grpc.StatusException

    • transferDomain

      public Operation transferDomain(TransferDomainRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • listRegistrations

      public ListRegistrationsResponse listRegistrations(ListRegistrationsRequest request) throws io.grpc.StatusException
       Lists the `Registration` resources in a project.
      Throws:
      io.grpc.StatusException

    • getRegistration

      public Registration getRegistration(GetRegistrationRequest request) throws io.grpc.StatusException
       Gets the details of a `Registration` resource.
      Throws:
      io.grpc.StatusException

    • updateRegistration

      public Operation updateRegistration(UpdateRegistrationRequest request) throws io.grpc.StatusException
       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`
      Throws:
      io.grpc.StatusException

    • configureManagementSettings

      public Operation configureManagementSettings(ConfigureManagementSettingsRequest request) throws io.grpc.StatusException
       Updates a `Registration`'s management settings.
      Throws:
      io.grpc.StatusException

    • configureDnsSettings

      public Operation configureDnsSettings(ConfigureDnsSettingsRequest request) throws io.grpc.StatusException
       Updates a `Registration`'s DNS settings.
      Throws:
      io.grpc.StatusException

    • configureContactSettings

      public Operation configureContactSettings(ConfigureContactSettingsRequest request) throws io.grpc.StatusException
       Updates a `Registration`'s contact settings. Some changes require
 confirmation by the domain's registrant contact .
      Throws:
      io.grpc.StatusException

    • exportRegistration

      public Operation exportRegistration(ExportRegistrationRequest request) throws io.grpc.StatusException
       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](https://domains.google/) 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.
      Throws:
      io.grpc.StatusException

    • deleteRegistration

      public Operation deleteRegistration(DeleteRegistrationRequest request) throws io.grpc.StatusException
       Deletes a `Registration` resource.
 This method works on any `Registration` resource using [Subscription or
 Commitment billing](/domains/pricing#billing-models), provided that the
 resource was created at least 1 day in the past.
 For `Registration` resources using
 [Monthly billing](/domains/pricing#billing-models), 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](https://domains.google/) 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.
      Throws:
      io.grpc.StatusException

    • retrieveAuthorizationCode

      public AuthorizationCode retrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • resetAuthorizationCode

      public AuthorizationCode resetAuthorizationCode(ResetAuthorizationCodeRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException