getRule method

Future<SecurityPolicyRule> getRule(
  1. String securityPolicy, {
  2. int? priority,
  3. String? $fields,
})

Gets a rule at the specified priority.

Use this API to read Cloud Armor policies.

Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getRule instead.

Request parameters:

securityPolicy - Name of the security policy to which the queried rule belongs. Value must have pattern (securityPolicies/)?\[0-9\]{0,20}.

priority - The priority of the rule to get from the security policy.

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

Completes with a SecurityPolicyRule.

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<SecurityPolicyRule> getRule(
  core.String securityPolicy, {
  core.int? priority,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'priority': ?priority == null ? null : ['${priority}'],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'locations/global/securityPolicies/' +
      commons.escapeVariable('$securityPolicy') +
      '/getRule';

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