describeTask method

Future<DescribeTaskResponse> describeTask({
  1. required String taskName,
  2. required String workspaceName,
  3. String? taskVersion,
})

Retrieves detailed information about a specific task in a workspace.

May throw AccessDeniedException. May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter taskName : The name of the task.

Parameter workspaceName : The name of the workspace.

Parameter taskVersion : The version number of the task to retrieve. If not specified, returns the latest version.

Implementation

Future<DescribeTaskResponse> describeTask({
  required String taskName,
  required String workspaceName,
  String? taskVersion,
}) async {
  final $query = <String, List<String>>{
    if (taskVersion != null) 'version': [taskVersion],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/workspaces/${Uri.encodeComponent(workspaceName)}/tasks/${Uri.encodeComponent(taskName)}',
    queryParams: $query,
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeTaskResponse.fromJson(response);
}