retrieveRegisterParameters method

Future<RetrieveRegisterParametersResponse> retrieveRegisterParameters(
  1. String location, {
  2. String? domainName,
  3. String? $fields,
})

Gets parameters needed to register a new domain name, including price and up-to-date availability.

Use the returned values to call RegisterDomain.

Request parameters:

location - Required. The location. Must be in the format projects / * /locations / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

domainName - Required. The domain name. Unicode domain names must be expressed in Punycode format.

$fields - Selector specifying which fields to include in a partial response.

Completes with a RetrieveRegisterParametersResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<RetrieveRegisterParametersResponse> retrieveRegisterParameters(
  core.String location, {
  core.String? domainName,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (domainName != null) 'domainName': [domainName],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' +
      core.Uri.encodeFull('$location') +
      '/registrations:retrieveRegisterParameters';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return RetrieveRegisterParametersResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}