list method

Future<ListUserProcessesResponse> list({ int? pageSize, String? pageToken, String? userProcessFilter_deploymentId, String? userProcessFilter_endTime, String? userProcessFilter_functionName, String? userProcessFilter_projectName, String? userProcessFilter_scriptId, String? userProcessFilter_startTime, List<String>? userProcessFilter_statuses, List<String>? userProcessFilter_types, List<String>? userProcessFilter_userAccessLevels, String? $fields, })

List information about processes made by or on behalf of a user, such as process type and current status.

Request parameters:

pageSize - The maximum number of returned processes per page of results. Defaults to 50.

pageToken - The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

userProcessFilter_deploymentId - Optional field used to limit returned processes to those originating from projects with a specific deployment ID.

userProcessFilter_endTime - Optional field used to limit returned processes to those that completed on or before the given timestamp.

userProcessFilter_functionName - Optional field used to limit returned processes to those originating from a script function with the given function name.

userProcessFilter_projectName - Optional field used to limit returned processes to those originating from projects with project names containing a specific string.

userProcessFilter_scriptId - Optional field used to limit returned processes to those originating from projects with a specific script ID.

userProcessFilter_startTime - Optional field used to limit returned processes to those that were started on or after the given timestamp.

userProcessFilter_statuses - Optional field used to limit returned processes to those having one of the specified process statuses.

userProcessFilter_types - Optional field used to limit returned processes to those having one of the specified process types.

userProcessFilter_userAccessLevels - Optional field used to limit returned processes to those having one of the specified user access levels.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListUserProcessesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListUserProcessesResponse> list({
  core.int? pageSize,
  core.String? pageToken,
  core.String? userProcessFilter_deploymentId,
  core.String? userProcessFilter_endTime,
  core.String? userProcessFilter_functionName,
  core.String? userProcessFilter_projectName,
  core.String? userProcessFilter_scriptId,
  core.String? userProcessFilter_startTime,
  core.List<core.String>? userProcessFilter_statuses,
  core.List<core.String>? userProcessFilter_types,
  core.List<core.String>? userProcessFilter_userAccessLevels,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'userProcessFilter.deploymentId': ?userProcessFilter_deploymentId == null
        ? null
        : [userProcessFilter_deploymentId],
    'userProcessFilter.endTime': ?userProcessFilter_endTime == null
        ? null
        : [userProcessFilter_endTime],
    'userProcessFilter.functionName': ?userProcessFilter_functionName == null
        ? null
        : [userProcessFilter_functionName],
    'userProcessFilter.projectName': ?userProcessFilter_projectName == null
        ? null
        : [userProcessFilter_projectName],
    'userProcessFilter.scriptId': ?userProcessFilter_scriptId == null
        ? null
        : [userProcessFilter_scriptId],
    'userProcessFilter.startTime': ?userProcessFilter_startTime == null
        ? null
        : [userProcessFilter_startTime],
    'userProcessFilter.statuses': ?userProcessFilter_statuses,
    'userProcessFilter.types': ?userProcessFilter_types,
    'userProcessFilter.userAccessLevels': ?userProcessFilter_userAccessLevels,
    'fields': ?$fields == null ? null : [$fields],
  };

  const url_ = 'v1/processes';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListUserProcessesResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}