com.azure.resourcemanager.securityinsights.fluent.models.ScheduledAlertRuleTemplateProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-securityinsights Show documentation
Show all versions of azure-resourcemanager-securityinsights Show documentation
This package contains Microsoft Azure SDK for SecurityInsights Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider. Package tag package-preview-2021-09.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.securityinsights.fluent.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.util.CoreUtils;
import com.azure.json.JsonReader;
import com.azure.json.JsonSerializable;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import com.azure.resourcemanager.securityinsights.models.AlertDetailsOverride;
import com.azure.resourcemanager.securityinsights.models.AlertRuleTemplateDataSource;
import com.azure.resourcemanager.securityinsights.models.AlertSeverity;
import com.azure.resourcemanager.securityinsights.models.AttackTactic;
import com.azure.resourcemanager.securityinsights.models.EntityMapping;
import com.azure.resourcemanager.securityinsights.models.EventGroupingSettings;
import com.azure.resourcemanager.securityinsights.models.TemplateStatus;
import com.azure.resourcemanager.securityinsights.models.TriggerOperator;
import java.io.IOException;
import java.time.Duration;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;
/**
* Scheduled alert rule template properties.
*/
@Fluent
public final class ScheduledAlertRuleTemplateProperties
implements JsonSerializable {
/*
* the number of alert rules that were created by this template
*/
private Integer alertRulesCreatedByTemplateCount;
/*
* The time that this alert rule template has been added.
*/
private OffsetDateTime createdDateUtc;
/*
* The time that this alert rule template was last updated.
*/
private OffsetDateTime lastUpdatedDateUtc;
/*
* The description of the alert rule template.
*/
private String description;
/*
* The display name for alert rule template.
*/
private String displayName;
/*
* The required data connectors for this template
*/
private List requiredDataConnectors;
/*
* The alert rule template status.
*/
private TemplateStatus status;
/*
* The query that creates alerts for this rule.
*/
private String query;
/*
* The frequency (in ISO 8601 duration format) for this alert rule to run.
*/
private Duration queryFrequency;
/*
* The period (in ISO 8601 duration format) that this alert rule looks at.
*/
private Duration queryPeriod;
/*
* The severity for alerts created by this alert rule.
*/
private AlertSeverity severity;
/*
* The operation against the threshold that triggers alert rule.
*/
private TriggerOperator triggerOperator;
/*
* The threshold triggers this alert rule.
*/
private Integer triggerThreshold;
/*
* The tactics of the alert rule template
*/
private List tactics;
/*
* The techniques of the alert rule
*/
private List techniques;
/*
* The version of this template - in format , where all are numbers. For example <1.0.2>.
*/
private String version;
/*
* The event grouping settings.
*/
private EventGroupingSettings eventGroupingSettings;
/*
* Dictionary of string key-value pairs of columns to be attached to the alert
*/
private Map customDetails;
/*
* Array of the entity mappings of the alert rule
*/
private List entityMappings;
/*
* The alert details override settings
*/
private AlertDetailsOverride alertDetailsOverride;
/**
* Creates an instance of ScheduledAlertRuleTemplateProperties class.
*/
public ScheduledAlertRuleTemplateProperties() {
}
/**
* Get the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.
*
* @return the alertRulesCreatedByTemplateCount value.
*/
public Integer alertRulesCreatedByTemplateCount() {
return this.alertRulesCreatedByTemplateCount;
}
/**
* Set the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.
*
* @param alertRulesCreatedByTemplateCount the alertRulesCreatedByTemplateCount value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties
withAlertRulesCreatedByTemplateCount(Integer alertRulesCreatedByTemplateCount) {
this.alertRulesCreatedByTemplateCount = alertRulesCreatedByTemplateCount;
return this;
}
/**
* Get the createdDateUtc property: The time that this alert rule template has been added.
*
* @return the createdDateUtc value.
*/
public OffsetDateTime createdDateUtc() {
return this.createdDateUtc;
}
/**
* Get the lastUpdatedDateUtc property: The time that this alert rule template was last updated.
*
* @return the lastUpdatedDateUtc value.
*/
public OffsetDateTime lastUpdatedDateUtc() {
return this.lastUpdatedDateUtc;
}
/**
* Get the description property: The description of the alert rule template.
*
* @return the description value.
*/
public String description() {
return this.description;
}
/**
* Set the description property: The description of the alert rule template.
*
* @param description the description value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withDescription(String description) {
this.description = description;
return this;
}
/**
* Get the displayName property: The display name for alert rule template.
*
* @return the displayName value.
*/
public String displayName() {
return this.displayName;
}
/**
* Set the displayName property: The display name for alert rule template.
*
* @param displayName the displayName value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withDisplayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Get the requiredDataConnectors property: The required data connectors for this template.
*
* @return the requiredDataConnectors value.
*/
public List requiredDataConnectors() {
return this.requiredDataConnectors;
}
/**
* Set the requiredDataConnectors property: The required data connectors for this template.
*
* @param requiredDataConnectors the requiredDataConnectors value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties
withRequiredDataConnectors(List requiredDataConnectors) {
this.requiredDataConnectors = requiredDataConnectors;
return this;
}
/**
* Get the status property: The alert rule template status.
*
* @return the status value.
*/
public TemplateStatus status() {
return this.status;
}
/**
* Set the status property: The alert rule template status.
*
* @param status the status value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withStatus(TemplateStatus status) {
this.status = status;
return this;
}
/**
* Get the query property: The query that creates alerts for this rule.
*
* @return the query value.
*/
public String query() {
return this.query;
}
/**
* Set the query property: The query that creates alerts for this rule.
*
* @param query the query value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withQuery(String query) {
this.query = query;
return this;
}
/**
* Get the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.
*
* @return the queryFrequency value.
*/
public Duration queryFrequency() {
return this.queryFrequency;
}
/**
* Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.
*
* @param queryFrequency the queryFrequency value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withQueryFrequency(Duration queryFrequency) {
this.queryFrequency = queryFrequency;
return this;
}
/**
* Get the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.
*
* @return the queryPeriod value.
*/
public Duration queryPeriod() {
return this.queryPeriod;
}
/**
* Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.
*
* @param queryPeriod the queryPeriod value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withQueryPeriod(Duration queryPeriod) {
this.queryPeriod = queryPeriod;
return this;
}
/**
* Get the severity property: The severity for alerts created by this alert rule.
*
* @return the severity value.
*/
public AlertSeverity severity() {
return this.severity;
}
/**
* Set the severity property: The severity for alerts created by this alert rule.
*
* @param severity the severity value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withSeverity(AlertSeverity severity) {
this.severity = severity;
return this;
}
/**
* Get the triggerOperator property: The operation against the threshold that triggers alert rule.
*
* @return the triggerOperator value.
*/
public TriggerOperator triggerOperator() {
return this.triggerOperator;
}
/**
* Set the triggerOperator property: The operation against the threshold that triggers alert rule.
*
* @param triggerOperator the triggerOperator value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withTriggerOperator(TriggerOperator triggerOperator) {
this.triggerOperator = triggerOperator;
return this;
}
/**
* Get the triggerThreshold property: The threshold triggers this alert rule.
*
* @return the triggerThreshold value.
*/
public Integer triggerThreshold() {
return this.triggerThreshold;
}
/**
* Set the triggerThreshold property: The threshold triggers this alert rule.
*
* @param triggerThreshold the triggerThreshold value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withTriggerThreshold(Integer triggerThreshold) {
this.triggerThreshold = triggerThreshold;
return this;
}
/**
* Get the tactics property: The tactics of the alert rule template.
*
* @return the tactics value.
*/
public List tactics() {
return this.tactics;
}
/**
* Set the tactics property: The tactics of the alert rule template.
*
* @param tactics the tactics value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withTactics(List tactics) {
this.tactics = tactics;
return this;
}
/**
* Get the techniques property: The techniques of the alert rule.
*
* @return the techniques value.
*/
public List techniques() {
return this.techniques;
}
/**
* Set the techniques property: The techniques of the alert rule.
*
* @param techniques the techniques value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withTechniques(List techniques) {
this.techniques = techniques;
return this;
}
/**
* Get the version property: The version of this template - in format <a.b.c>, where all are numbers. For
* example <1.0.2>.
*
* @return the version value.
*/
public String version() {
return this.version;
}
/**
* Set the version property: The version of this template - in format <a.b.c>, where all are numbers. For
* example <1.0.2>.
*
* @param version the version value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withVersion(String version) {
this.version = version;
return this;
}
/**
* Get the eventGroupingSettings property: The event grouping settings.
*
* @return the eventGroupingSettings value.
*/
public EventGroupingSettings eventGroupingSettings() {
return this.eventGroupingSettings;
}
/**
* Set the eventGroupingSettings property: The event grouping settings.
*
* @param eventGroupingSettings the eventGroupingSettings value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withEventGroupingSettings(EventGroupingSettings eventGroupingSettings) {
this.eventGroupingSettings = eventGroupingSettings;
return this;
}
/**
* Get the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.
*
* @return the customDetails value.
*/
public Map customDetails() {
return this.customDetails;
}
/**
* Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.
*
* @param customDetails the customDetails value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withCustomDetails(Map customDetails) {
this.customDetails = customDetails;
return this;
}
/**
* Get the entityMappings property: Array of the entity mappings of the alert rule.
*
* @return the entityMappings value.
*/
public List entityMappings() {
return this.entityMappings;
}
/**
* Set the entityMappings property: Array of the entity mappings of the alert rule.
*
* @param entityMappings the entityMappings value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withEntityMappings(List entityMappings) {
this.entityMappings = entityMappings;
return this;
}
/**
* Get the alertDetailsOverride property: The alert details override settings.
*
* @return the alertDetailsOverride value.
*/
public AlertDetailsOverride alertDetailsOverride() {
return this.alertDetailsOverride;
}
/**
* Set the alertDetailsOverride property: The alert details override settings.
*
* @param alertDetailsOverride the alertDetailsOverride value to set.
* @return the ScheduledAlertRuleTemplateProperties object itself.
*/
public ScheduledAlertRuleTemplateProperties withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride) {
this.alertDetailsOverride = alertDetailsOverride;
return this;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
public void validate() {
if (requiredDataConnectors() != null) {
requiredDataConnectors().forEach(e -> e.validate());
}
if (eventGroupingSettings() != null) {
eventGroupingSettings().validate();
}
if (entityMappings() != null) {
entityMappings().forEach(e -> e.validate());
}
if (alertDetailsOverride() != null) {
alertDetailsOverride().validate();
}
}
/**
* {@inheritDoc}
*/
@Override
public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
jsonWriter.writeStartObject();
jsonWriter.writeNumberField("alertRulesCreatedByTemplateCount", this.alertRulesCreatedByTemplateCount);
jsonWriter.writeStringField("description", this.description);
jsonWriter.writeStringField("displayName", this.displayName);
jsonWriter.writeArrayField("requiredDataConnectors", this.requiredDataConnectors,
(writer, element) -> writer.writeJson(element));
jsonWriter.writeStringField("status", this.status == null ? null : this.status.toString());
jsonWriter.writeStringField("query", this.query);
jsonWriter.writeStringField("queryFrequency", CoreUtils.durationToStringWithDays(this.queryFrequency));
jsonWriter.writeStringField("queryPeriod", CoreUtils.durationToStringWithDays(this.queryPeriod));
jsonWriter.writeStringField("severity", this.severity == null ? null : this.severity.toString());
jsonWriter.writeStringField("triggerOperator",
this.triggerOperator == null ? null : this.triggerOperator.toString());
jsonWriter.writeNumberField("triggerThreshold", this.triggerThreshold);
jsonWriter.writeArrayField("tactics", this.tactics,
(writer, element) -> writer.writeString(element == null ? null : element.toString()));
jsonWriter.writeArrayField("techniques", this.techniques, (writer, element) -> writer.writeString(element));
jsonWriter.writeStringField("version", this.version);
jsonWriter.writeJsonField("eventGroupingSettings", this.eventGroupingSettings);
jsonWriter.writeMapField("customDetails", this.customDetails, (writer, element) -> writer.writeString(element));
jsonWriter.writeArrayField("entityMappings", this.entityMappings,
(writer, element) -> writer.writeJson(element));
jsonWriter.writeJsonField("alertDetailsOverride", this.alertDetailsOverride);
return jsonWriter.writeEndObject();
}
/**
* Reads an instance of ScheduledAlertRuleTemplateProperties from the JsonReader.
*
* @param jsonReader The JsonReader being read.
* @return An instance of ScheduledAlertRuleTemplateProperties if the JsonReader was pointing to an instance of it,
* or null if it was pointing to JSON null.
* @throws IOException If an error occurs while reading the ScheduledAlertRuleTemplateProperties.
*/
public static ScheduledAlertRuleTemplateProperties fromJson(JsonReader jsonReader) throws IOException {
return jsonReader.readObject(reader -> {
ScheduledAlertRuleTemplateProperties deserializedScheduledAlertRuleTemplateProperties
= new ScheduledAlertRuleTemplateProperties();
while (reader.nextToken() != JsonToken.END_OBJECT) {
String fieldName = reader.getFieldName();
reader.nextToken();
if ("alertRulesCreatedByTemplateCount".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.alertRulesCreatedByTemplateCount
= reader.getNullable(JsonReader::getInt);
} else if ("createdDateUTC".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.createdDateUtc = reader
.getNullable(nonNullReader -> CoreUtils.parseBestOffsetDateTime(nonNullReader.getString()));
} else if ("lastUpdatedDateUTC".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.lastUpdatedDateUtc = reader
.getNullable(nonNullReader -> CoreUtils.parseBestOffsetDateTime(nonNullReader.getString()));
} else if ("description".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.description = reader.getString();
} else if ("displayName".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.displayName = reader.getString();
} else if ("requiredDataConnectors".equals(fieldName)) {
List requiredDataConnectors
= reader.readArray(reader1 -> AlertRuleTemplateDataSource.fromJson(reader1));
deserializedScheduledAlertRuleTemplateProperties.requiredDataConnectors = requiredDataConnectors;
} else if ("status".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.status
= TemplateStatus.fromString(reader.getString());
} else if ("query".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.query = reader.getString();
} else if ("queryFrequency".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.queryFrequency
= reader.getNullable(nonNullReader -> Duration.parse(nonNullReader.getString()));
} else if ("queryPeriod".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.queryPeriod
= reader.getNullable(nonNullReader -> Duration.parse(nonNullReader.getString()));
} else if ("severity".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.severity
= AlertSeverity.fromString(reader.getString());
} else if ("triggerOperator".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.triggerOperator
= TriggerOperator.fromString(reader.getString());
} else if ("triggerThreshold".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.triggerThreshold
= reader.getNullable(JsonReader::getInt);
} else if ("tactics".equals(fieldName)) {
List tactics
= reader.readArray(reader1 -> AttackTactic.fromString(reader1.getString()));
deserializedScheduledAlertRuleTemplateProperties.tactics = tactics;
} else if ("techniques".equals(fieldName)) {
List techniques = reader.readArray(reader1 -> reader1.getString());
deserializedScheduledAlertRuleTemplateProperties.techniques = techniques;
} else if ("version".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.version = reader.getString();
} else if ("eventGroupingSettings".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.eventGroupingSettings
= EventGroupingSettings.fromJson(reader);
} else if ("customDetails".equals(fieldName)) {
Map customDetails = reader.readMap(reader1 -> reader1.getString());
deserializedScheduledAlertRuleTemplateProperties.customDetails = customDetails;
} else if ("entityMappings".equals(fieldName)) {
List entityMappings = reader.readArray(reader1 -> EntityMapping.fromJson(reader1));
deserializedScheduledAlertRuleTemplateProperties.entityMappings = entityMappings;
} else if ("alertDetailsOverride".equals(fieldName)) {
deserializedScheduledAlertRuleTemplateProperties.alertDetailsOverride
= AlertDetailsOverride.fromJson(reader);
} else {
reader.skipChildren();
}
}
return deserializedScheduledAlertRuleTemplateProperties;
});
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy