patch method

Future<EventThreatDetectionCustomModule> patch(
  1. EventThreatDetectionCustomModule request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Updates the Event Threat Detection custom module with the given name based on the given update mask.

Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

request - The metadata request object.

Request parameters:

name - Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}".

  • "folders/{folder}/eventThreatDetectionSettings/customModules/{module}".

"projects/{project}/eventThreatDetectionSettings/customModules/{module}". Value must have pattern ^organizations/\[^/\]+/eventThreatDetectionSettings/customModules/\[^/\]+$.

updateMask - The list of fields to be updated. If empty all mutable fields will be updated.

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

Completes with a EventThreatDetectionCustomModule.

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<EventThreatDetectionCustomModule> patch(
  EventThreatDetectionCustomModule request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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