startSuiteRun method

Future<StartSuiteRunResponse> startSuiteRun({ required String suiteDefinitionId, required SuiteRunConfiguration suiteRunConfiguration, String? suiteDefinitionVersion, Map<String, String>? tags, })

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

May throw ConflictException. May throw InternalServerException. May throw ValidationException.

Parameter suiteDefinitionId : Suite definition ID of the test suite.

Parameter suiteRunConfiguration : Suite run configuration.

Parameter suiteDefinitionVersion : Suite definition version of the test suite.

Parameter tags : The tags to be attached to the suite run.

Implementation

Future<StartSuiteRunResponse> startSuiteRun({
  required String suiteDefinitionId,
  required SuiteRunConfiguration suiteRunConfiguration,
  String? suiteDefinitionVersion,
  Map<String, String>? tags,
}) async {
  final $payload = <String, dynamic>{
    'suiteRunConfiguration': suiteRunConfiguration,
    if (suiteDefinitionVersion != null)
      'suiteDefinitionVersion': suiteDefinitionVersion,
    if (tags != null) 'tags': tags,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/suiteDefinitions/${Uri.encodeComponent(suiteDefinitionId)}/suiteRuns',
    exceptionFnMap: _exceptionFns,
  );
  return StartSuiteRunResponse.fromJson(response);
}