listRoutes method

Future<ListRoutesOutput> listRoutes({ required String meshName, required String virtualRouterName, int? limit, String? nextToken, })

Returns a list of existing routes 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 routes.

Parameter virtualRouterName : The name of the virtual router in which to list routes.

Parameter limit : The maximum number of mesh results returned by ListRoutes in paginated output. When this parameter is used, ListRoutes 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 ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRoutes returns up to 100 results and a nextToken value if applicable.

Parameter nextToken : The nextToken value returned from a previous paginated ListRoutes 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<ListRoutesOutput> listRoutes({
  required String meshName,
  required String virtualRouterName,
  int? limit,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(meshName, 'meshName');
  _s.validateStringLength(
    'meshName',
    meshName,
    1,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(virtualRouterName, 'virtualRouterName');
  _s.validateStringLength(
    'virtualRouterName',
    virtualRouterName,
    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)}/virtualRouter/${Uri.encodeComponent(virtualRouterName)}/routes',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListRoutesOutput.fromJson(response);
}