describeTestCases method

Future<DescribeTestCasesOutput> describeTestCases({ required String reportArn, TestCaseFilter? filter, int? maxResults, String? nextToken, })

Returns a list of details about test cases for a report.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter reportArn : The ARN of the report for which test cases are returned.

Parameter filter : A TestCaseFilter object used to filter the returned reports.

Parameter maxResults : The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.

Parameter nextToken : During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Implementation

Future<DescribeTestCasesOutput> describeTestCases({
  required String reportArn,
  TestCaseFilter? filter,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(reportArn, 'reportArn');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CodeBuild_20161006.DescribeTestCases'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'reportArn': reportArn,
      if (filter != null) 'filter': filter,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeTestCasesOutput.fromJson(jsonResponse.body);
}