listVirtualRouters method

Future<ListVirtualRoutersOutput> listVirtualRouters({ required String meshName, int? limit, String? nextToken, })

Returns a list of existing virtual routers in a service mesh.

May throw BadRequestException. May throw ForbiddenException. May throw InternalServerErrorException. May throw NotFoundException. May throw ServiceUnavailableException. May throw TooManyRequestsException.

Parameter meshName : The name of the service mesh in which to list virtual routers.

Parameter limit : The maximum number of mesh results returned by ListVirtualRouters in paginated output. When this parameter is used, ListVirtualRouters only returns limit results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

Parameter nextToken : The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Implementation

Future<ListVirtualRoutersOutput> listVirtualRouters({
  required String meshName,
  int? limit,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(meshName, 'meshName');
  _s.validateStringLength(
    'meshName',
    meshName,
    1,
    255,
    isRequired: true,
  );
  _s.validateNumRange(
    'limit',
    limit,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (limit != null) 'limit': [limit.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/meshes/${Uri.encodeComponent(meshName)}/virtualRouters',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListVirtualRoutersOutput.fromJson(response);
}