getNatIpInfo method

Future<NatIpInfoResponse> getNatIpInfo(String project, String region, String router, { String? natName, String? $fields, })

Retrieves runtime NAT IP information.

Request parameters:

project - Project ID for this request. Value must have pattern (?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).

region - Name of the region for this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

router - Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.

natName - Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

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

Completes with a NatIpInfoResponse.

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<NatIpInfoResponse> getNatIpInfo(
  core.String project,
  core.String region,
  core.String router, {
  core.String? natName,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (natName != null) 'natName': [natName],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/regions/' +
      commons.escapeVariable('$region') +
      '/routers/' +
      commons.escapeVariable('$router') +
      '/getNatIpInfo';

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