addAssociation method

Future<Operation> addAssociation(SecurityPolicyAssociation request, String securityPolicy, { bool? replaceExistingAssociation, String? requestId, String? $fields, })

Inserts an association for the specified security policy.

This has billing implications.

Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled.

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

request - The metadata request object.

Request parameters:

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

replaceExistingAssociation - Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

requestId - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

Completes with a Operation.

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<Operation> addAssociation(
  SecurityPolicyAssociation request,
  core.String securityPolicy, {
  core.bool? replaceExistingAssociation,
  core.String? requestId,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'replaceExistingAssociation': ?replaceExistingAssociation == null
        ? null
        : ['${replaceExistingAssociation}'],
    'requestId': ?requestId == null ? null : [requestId],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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