list method

Future<ListAttackPathsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists the attack paths for a set of simulation results or valued resources and filter.

Request parameters:

parent - Required. Name of parent to list attack paths. Valid formats: organizations/{organization}, organizations/{organization}/simulations/{simulation} organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2} organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource} Value must have pattern ^organizations/\[^/\]+/simulations/\[^/\]+/attackExposureResults/\[^/\]+$.

filter - The filter expression that filters the attack path in the response. Supported fields: * valued_resources supports =

pageSize - The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

pageToken - The value returned by the last ListAttackPathsResponse; indicates that this is a continuation of a prior ListAttackPaths call, and that the system should return the next page of data.

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

Completes with a ListAttackPathsResponse.

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<ListAttackPathsResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/attackPaths';

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