list method

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

Lists ExternalAccessRule resources in the specified network policy.

Request parameters:

parent - Required. The resource name of the network policy to query for external access firewall rules. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/networkPolicies/\[^/\]+$.

filter - A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <. For example, if you are filtering a list of external access rules, you can exclude the ones named example-rule by specifying name != "example-rule". To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-rule") (createTime > "2021-04-12T08:15:10.40Z") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ``` (name = "example-rule-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-rule-2")


[orderBy] - Sorts list results by a certain order. By default, returned
results are ordered by `name` in ascending order. You can also sort
results in descending order based on the `name` value using `orderBy="name
desc"`. Currently, only ordering by `name` is supported.

[pageSize] - The maximum number of external access rules to return in one
page. The service may return fewer than this value. The maximum value is
coerced to 1000. The default value of this field is 500.

[pageToken] - A page token, received from a previous
`ListExternalAccessRulesRequest` call. Provide this to retrieve the
subsequent page. When paginating, all other parameters provided to
`ListExternalAccessRulesRequest` must match the call that provided the
page token.

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

Completes with a [ListExternalAccessRulesResponse].

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

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

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