get method

Future<ConsumerConfig> get(
  1. String name, {
  2. bool? includeUsedIpRanges,
  3. String? $fields,
})

Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.

Request parameters:

name - Required. Name of the consumer config to retrieve in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is a project number e.g. 12345 that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network. Value must have pattern ^services/\[^/\]+/projects/\[^/\]+/global/networks/\[^/\]+$.

includeUsedIpRanges - Optional. When true, include the used IP ranges as part of the GetConsumerConfig output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false

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

Completes with a ConsumerConfig.

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<ConsumerConfig> get(
  core.String name, {
  core.bool? includeUsedIpRanges,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (includeUsedIpRanges != null)
      'includeUsedIpRanges': ['${includeUsedIpRanges}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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