Struct gapi_grpc::google::cloud::domains::v1alpha2::domains_client::DomainsClient

pub struct DomainsClient<T> { /* fields omitted */ }

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

Implementations

impl DomainsClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> DomainsClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn search_domains(
    &mut self,
    request: impl IntoRequest<SearchDomainsRequest>
) -> Result<Response<SearchDomainsResponse>, Status>

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.

pub async fn retrieve_register_parameters(
    &mut self,
    request: impl IntoRequest<RetrieveRegisterParametersRequest>
) -> Result<Response<RetrieveRegisterParametersResponse>, Status>

Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain.

pub async fn register_domain(
    &mut self,
    request: impl IntoRequest<RegisterDomainRequest>
) -> Result<Response<Operation>, Status>

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.

pub async fn list_registrations(
    &mut self,
    request: impl IntoRequest<ListRegistrationsRequest>
) -> Result<Response<ListRegistrationsResponse>, Status>

Lists the Registration resources in a project.

pub async fn get_registration(
    &mut self,
    request: impl IntoRequest<GetRegistrationRequest>
) -> Result<Response<Registration>, Status>

Gets the details of a Registration resource.

pub async fn update_registration(
    &mut self,
    request: impl IntoRequest<UpdateRegistrationRequest>
) -> Result<Response<Operation>, Status>

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

pub async fn configure_management_settings(
    &mut self,
    request: impl IntoRequest<ConfigureManagementSettingsRequest>
) -> Result<Response<Operation>, Status>

Updates a Registration’s management settings.

pub async fn configure_dns_settings(
    &mut self,
    request: impl IntoRequest<ConfigureDnsSettingsRequest>
) -> Result<Response<Operation>, Status>

Updates a Registration’s DNS settings.

pub async fn configure_contact_settings(
    &mut self,
    request: impl IntoRequest<ConfigureContactSettingsRequest>
) -> Result<Response<Operation>, Status>

Updates a Registration’s contact settings. Some changes require confirmation by the domain’s registrant contact .

pub async fn export_registration(
    &mut self,
    request: impl IntoRequest<ExportRegistrationRequest>
) -> Result<Response<Operation>, Status>

Exports a Registration that you no longer want to use with Cloud Domains. You can continue to use the domain in Google Domains until it expires.

If the export is successful:

• The resource’s state becomes EXPORTED, meaning that it is no longer managed by Cloud Domains
• Because individual users can own domains in Google Domains, the calling user becomes the domain’s sole owner. Permissions for the domain are subsequently managed in Google Domains.
• Without further action, the domain does not renew automatically. The new owner can set up billing in Google Domains to renew the domain if needed.

pub async fn delete_registration(
    &mut self,
    request: impl IntoRequest<DeleteRegistrationRequest>
) -> Result<Response<Operation>, Status>

Deletes a Registration resource.

This method only works on resources in one of the following states:

• state is EXPORTED with expire_time in the past
• state is REGISTRATION_FAILED

pub async fn retrieve_authorization_code(
    &mut self,
    request: impl IntoRequest<RetrieveAuthorizationCodeRequest>
) -> Result<Response<AuthorizationCode>, Status>

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.

pub async fn reset_authorization_code(
    &mut self,
    request: impl IntoRequest<ResetAuthorizationCodeRequest>
) -> Result<Response<AuthorizationCode>, Status>

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.

Trait Implementations

impl<T: Clone> Clone for DomainsClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for DomainsClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.