io.github.cdklabs.cdkmonitoringconstructs.CustomMonitoringProps Maven / Gradle / Ivy
package io.github.cdklabs.cdkmonitoringconstructs;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.93.0 (build 1706ca5)", date = "2024-01-08T00:34:46.574Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdkmonitoringconstructs.$Module.class, fqn = "cdk-monitoring-constructs.CustomMonitoringProps")
@software.amazon.jsii.Jsii.Proxy(CustomMonitoringProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface CustomMonitoringProps extends software.amazon.jsii.JsiiSerializable, io.github.cdklabs.cdkmonitoringconstructs.BaseMonitoringProps {
/**
* (experimental) define metric groups and metrics inside them (each metric group represents a widget).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.util.List getMetricGroups();
/**
* (experimental) optional description of the whole section, in markdown.
*
* Default: no description
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return null;
}
/**
* (experimental) optional height of the description widget, so the content fits.
*
* Default: minimum height (should fit one or two lines of text)
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Number getDescriptionWidgetHeight() {
return null;
}
/**
* (experimental) height override.
*
* Default: default height
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Number getHeight() {
return null;
}
/**
* @return a {@link Builder} of {@link CustomMonitoringProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CustomMonitoringProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.util.List metricGroups;
java.lang.String description;
java.lang.Number descriptionWidgetHeight;
java.lang.Number height;
io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer useCreatedAlarms;
java.lang.String alarmFriendlyName;
java.lang.String humanReadableName;
java.lang.String localAlarmNamePrefixOverride;
java.lang.Boolean addToAlarmDashboard;
java.lang.Boolean addToDetailDashboard;
java.lang.Boolean addToSummaryDashboard;
/**
* Sets the value of {@link CustomMonitoringProps#getMetricGroups}
* @param metricGroups define metric groups and metrics inside them (each metric group represents a widget). This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@SuppressWarnings("unchecked")
public Builder metricGroups(java.util.List metricGroups) {
this.metricGroups = (java.util.List)metricGroups;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getDescription}
* @param description optional description of the whole section, in markdown.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getDescriptionWidgetHeight}
* @param descriptionWidgetHeight optional height of the description widget, so the content fits.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder descriptionWidgetHeight(java.lang.Number descriptionWidgetHeight) {
this.descriptionWidgetHeight = descriptionWidgetHeight;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getHeight}
* @param height height override.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder height(java.lang.Number height) {
this.height = height;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getUseCreatedAlarms}
* @param useCreatedAlarms Calls provided function to process all alarms created.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder useCreatedAlarms(io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer useCreatedAlarms) {
this.useCreatedAlarms = useCreatedAlarms;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getAlarmFriendlyName}
* @param alarmFriendlyName Plain name, used in naming alarms.
* This unique among other resources, and respect the AWS CDK restriction posed on alarm names.
* The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder alarmFriendlyName(java.lang.String alarmFriendlyName) {
this.alarmFriendlyName = alarmFriendlyName;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getHumanReadableName}
* @param humanReadableName Human-readable name is a freeform string, used as a caption or description.
* There are no limitations on what it can be.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder humanReadableName(java.lang.String humanReadableName) {
this.humanReadableName = humanReadableName;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getLocalAlarmNamePrefixOverride}
* @param localAlarmNamePrefixOverride If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value.
* The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder localAlarmNamePrefixOverride(java.lang.String localAlarmNamePrefixOverride) {
this.localAlarmNamePrefixOverride = localAlarmNamePrefixOverride;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getAddToAlarmDashboard}
* @param addToAlarmDashboard Flag indicating if the widgets should be added to alarm dashboard.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToAlarmDashboard(java.lang.Boolean addToAlarmDashboard) {
this.addToAlarmDashboard = addToAlarmDashboard;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getAddToDetailDashboard}
* @param addToDetailDashboard Flag indicating if the widgets should be added to detailed dashboard.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToDetailDashboard(java.lang.Boolean addToDetailDashboard) {
this.addToDetailDashboard = addToDetailDashboard;
return this;
}
/**
* Sets the value of {@link CustomMonitoringProps#getAddToSummaryDashboard}
* @param addToSummaryDashboard Flag indicating if the widgets should be added to summary dashboard.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToSummaryDashboard(java.lang.Boolean addToSummaryDashboard) {
this.addToSummaryDashboard = addToSummaryDashboard;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CustomMonitoringProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public CustomMonitoringProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CustomMonitoringProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CustomMonitoringProps {
private final java.util.List metricGroups;
private final java.lang.String description;
private final java.lang.Number descriptionWidgetHeight;
private final java.lang.Number height;
private final io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer useCreatedAlarms;
private final java.lang.String alarmFriendlyName;
private final java.lang.String humanReadableName;
private final java.lang.String localAlarmNamePrefixOverride;
private final java.lang.Boolean addToAlarmDashboard;
private final java.lang.Boolean addToDetailDashboard;
private final java.lang.Boolean addToSummaryDashboard;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.metricGroups = software.amazon.jsii.Kernel.get(this, "metricGroups", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.CustomMetricGroup.class)));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.descriptionWidgetHeight = software.amazon.jsii.Kernel.get(this, "descriptionWidgetHeight", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.height = software.amazon.jsii.Kernel.get(this, "height", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.useCreatedAlarms = software.amazon.jsii.Kernel.get(this, "useCreatedAlarms", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer.class));
this.alarmFriendlyName = software.amazon.jsii.Kernel.get(this, "alarmFriendlyName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.humanReadableName = software.amazon.jsii.Kernel.get(this, "humanReadableName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.localAlarmNamePrefixOverride = software.amazon.jsii.Kernel.get(this, "localAlarmNamePrefixOverride", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.addToAlarmDashboard = software.amazon.jsii.Kernel.get(this, "addToAlarmDashboard", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.addToDetailDashboard = software.amazon.jsii.Kernel.get(this, "addToDetailDashboard", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.addToSummaryDashboard = software.amazon.jsii.Kernel.get(this, "addToSummaryDashboard", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.metricGroups = (java.util.List)java.util.Objects.requireNonNull(builder.metricGroups, "metricGroups is required");
this.description = builder.description;
this.descriptionWidgetHeight = builder.descriptionWidgetHeight;
this.height = builder.height;
this.useCreatedAlarms = builder.useCreatedAlarms;
this.alarmFriendlyName = builder.alarmFriendlyName;
this.humanReadableName = builder.humanReadableName;
this.localAlarmNamePrefixOverride = builder.localAlarmNamePrefixOverride;
this.addToAlarmDashboard = builder.addToAlarmDashboard;
this.addToDetailDashboard = builder.addToDetailDashboard;
this.addToSummaryDashboard = builder.addToSummaryDashboard;
}
@Override
public final java.util.List getMetricGroups() {
return this.metricGroups;
}
@Override
public final java.lang.String getDescription() {
return this.description;
}
@Override
public final java.lang.Number getDescriptionWidgetHeight() {
return this.descriptionWidgetHeight;
}
@Override
public final java.lang.Number getHeight() {
return this.height;
}
@Override
public final io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer getUseCreatedAlarms() {
return this.useCreatedAlarms;
}
@Override
public final java.lang.String getAlarmFriendlyName() {
return this.alarmFriendlyName;
}
@Override
public final java.lang.String getHumanReadableName() {
return this.humanReadableName;
}
@Override
public final java.lang.String getLocalAlarmNamePrefixOverride() {
return this.localAlarmNamePrefixOverride;
}
@Override
public final java.lang.Boolean getAddToAlarmDashboard() {
return this.addToAlarmDashboard;
}
@Override
public final java.lang.Boolean getAddToDetailDashboard() {
return this.addToDetailDashboard;
}
@Override
public final java.lang.Boolean getAddToSummaryDashboard() {
return this.addToSummaryDashboard;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("metricGroups", om.valueToTree(this.getMetricGroups()));
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getDescriptionWidgetHeight() != null) {
data.set("descriptionWidgetHeight", om.valueToTree(this.getDescriptionWidgetHeight()));
}
if (this.getHeight() != null) {
data.set("height", om.valueToTree(this.getHeight()));
}
if (this.getUseCreatedAlarms() != null) {
data.set("useCreatedAlarms", om.valueToTree(this.getUseCreatedAlarms()));
}
if (this.getAlarmFriendlyName() != null) {
data.set("alarmFriendlyName", om.valueToTree(this.getAlarmFriendlyName()));
}
if (this.getHumanReadableName() != null) {
data.set("humanReadableName", om.valueToTree(this.getHumanReadableName()));
}
if (this.getLocalAlarmNamePrefixOverride() != null) {
data.set("localAlarmNamePrefixOverride", om.valueToTree(this.getLocalAlarmNamePrefixOverride()));
}
if (this.getAddToAlarmDashboard() != null) {
data.set("addToAlarmDashboard", om.valueToTree(this.getAddToAlarmDashboard()));
}
if (this.getAddToDetailDashboard() != null) {
data.set("addToDetailDashboard", om.valueToTree(this.getAddToDetailDashboard()));
}
if (this.getAddToSummaryDashboard() != null) {
data.set("addToSummaryDashboard", om.valueToTree(this.getAddToSummaryDashboard()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk-monitoring-constructs.CustomMonitoringProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CustomMonitoringProps.Jsii$Proxy that = (CustomMonitoringProps.Jsii$Proxy) o;
if (!metricGroups.equals(that.metricGroups)) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.descriptionWidgetHeight != null ? !this.descriptionWidgetHeight.equals(that.descriptionWidgetHeight) : that.descriptionWidgetHeight != null) return false;
if (this.height != null ? !this.height.equals(that.height) : that.height != null) return false;
if (this.useCreatedAlarms != null ? !this.useCreatedAlarms.equals(that.useCreatedAlarms) : that.useCreatedAlarms != null) return false;
if (this.alarmFriendlyName != null ? !this.alarmFriendlyName.equals(that.alarmFriendlyName) : that.alarmFriendlyName != null) return false;
if (this.humanReadableName != null ? !this.humanReadableName.equals(that.humanReadableName) : that.humanReadableName != null) return false;
if (this.localAlarmNamePrefixOverride != null ? !this.localAlarmNamePrefixOverride.equals(that.localAlarmNamePrefixOverride) : that.localAlarmNamePrefixOverride != null) return false;
if (this.addToAlarmDashboard != null ? !this.addToAlarmDashboard.equals(that.addToAlarmDashboard) : that.addToAlarmDashboard != null) return false;
if (this.addToDetailDashboard != null ? !this.addToDetailDashboard.equals(that.addToDetailDashboard) : that.addToDetailDashboard != null) return false;
return this.addToSummaryDashboard != null ? this.addToSummaryDashboard.equals(that.addToSummaryDashboard) : that.addToSummaryDashboard == null;
}
@Override
public final int hashCode() {
int result = this.metricGroups.hashCode();
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.descriptionWidgetHeight != null ? this.descriptionWidgetHeight.hashCode() : 0);
result = 31 * result + (this.height != null ? this.height.hashCode() : 0);
result = 31 * result + (this.useCreatedAlarms != null ? this.useCreatedAlarms.hashCode() : 0);
result = 31 * result + (this.alarmFriendlyName != null ? this.alarmFriendlyName.hashCode() : 0);
result = 31 * result + (this.humanReadableName != null ? this.humanReadableName.hashCode() : 0);
result = 31 * result + (this.localAlarmNamePrefixOverride != null ? this.localAlarmNamePrefixOverride.hashCode() : 0);
result = 31 * result + (this.addToAlarmDashboard != null ? this.addToAlarmDashboard.hashCode() : 0);
result = 31 * result + (this.addToDetailDashboard != null ? this.addToDetailDashboard.hashCode() : 0);
result = 31 * result + (this.addToSummaryDashboard != null ? this.addToSummaryDashboard.hashCode() : 0);
return result;
}
}
}