listTypes method
Future<ListTypesResponse>
listTypes({
- required String apiId,
- required TypeDefinitionFormat format,
- int? maxResults,
- String? nextToken,
Lists the types for a given API.
May throw BadRequestException. May throw ConcurrentModificationException. May throw NotFoundException. May throw UnauthorizedException. May throw InternalFailureException.
Parameter apiId
:
The API ID.
Parameter format
:
The type format: SDL or JSON.
Parameter maxResults
:
The maximum number of results you want the request to return.
Parameter nextToken
:
An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
Implementation
Future<ListTypesResponse> listTypes({
required String apiId,
required TypeDefinitionFormat format,
int? maxResults,
String? nextToken,
}) async {
ArgumentError.checkNotNull(apiId, 'apiId');
ArgumentError.checkNotNull(format, 'format');
_s.validateNumRange(
'maxResults',
maxResults,
0,
25,
);
_s.validateStringLength(
'nextToken',
nextToken,
1,
65536,
);
final $query = <String, List<String>>{
'format': [format.toValue()],
if (maxResults != null) 'maxResults': [maxResults.toString()],
if (nextToken != null) 'nextToken': [nextToken],
};
final response = await _protocol.send(
payload: null,
method: 'GET',
requestUri: '/v1/apis/${Uri.encodeComponent(apiId)}/types',
queryParams: $query,
exceptionFnMap: _exceptionFns,
);
return ListTypesResponse.fromJson(response);
}