com.aliyun.ros.cdk.cms.SiteMonitorProps Maven / Gradle / Ivy
Show all versions of ros-cdk-cms Show documentation
package com.aliyun.ros.cdk.cms;
/**
* Properties for defining a SiteMonitor.
*
* See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms-sitemonitor
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-12-13T06:45:05.751Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.cms.$Module.class, fqn = "@alicloud/ros-cdk-cms.SiteMonitorProps")
@software.amazon.jsii.Jsii.Proxy(SiteMonitorProps.Jsii$Proxy.class)
public interface SiteMonitorProps extends software.amazon.jsii.JsiiSerializable {
/**
* Property address: The URL or IP address monitored by the monitoring task.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getAddress();
/**
* Property taskName: The name of the site monitoring task.
*
* The name must be 4 to 100 characters in length.
* It can contain letters, digits, and underscores (_).
*/
@org.jetbrains.annotations.NotNull java.lang.Object getTaskName();
/**
* Property taskType: The protocol used by the site monitoring task.
*
* Valid values: HTTP, HTTPS, PING, TCP,
* UDP, DNS, SMTP, POP3, and FTP.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getTaskType();
/**
* Property alertIds:.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getAlertIds() {
return null;
}
/**
* Property interval: The interval at which detection requests are sent.
*
* Valid values: 1, 5, and 15. Unit:
* minutes. Default value: 1.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getInterval() {
return null;
}
/**
* Property ispCities: The information about detection points, which is specified in a JSON array.
*
* Example:
* [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. The three city codes represent Beijing, Hangzhou, and Qingdao.
* Note You can call the DescribeSiteMonitorISPCityList API operation to query the detection
* points that can be used to create site monitoring tasks. For more information, see
* DescribeSiteMonitorISPCityList . If this parameter is not specified, the system randomly selects three detection
* points for site monitoring.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getIspCities() {
return null;
}
/**
* Property optionsJson: The extended options of the protocol that is used by the site monitoring task.
*
* The
* options vary based on the protocol.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getOptionsJson() {
return null;
}
/**
* @return a {@link Builder} of {@link SiteMonitorProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link SiteMonitorProps}
*/
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Object address;
java.lang.Object taskName;
java.lang.Object taskType;
java.lang.Object alertIds;
java.lang.Object interval;
java.lang.Object ispCities;
java.lang.Object optionsJson;
/**
* Sets the value of {@link SiteMonitorProps#getAddress}
* @param address Property address: The URL or IP address monitored by the monitoring task. This parameter is required.
* @return {@code this}
*/
public Builder address(java.lang.String address) {
this.address = address;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getAddress}
* @param address Property address: The URL or IP address monitored by the monitoring task. This parameter is required.
* @return {@code this}
*/
public Builder address(com.aliyun.ros.cdk.core.IResolvable address) {
this.address = address;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getTaskName}
* @param taskName Property taskName: The name of the site monitoring task. This parameter is required.
* The name must be 4 to 100 characters in length.
* It can contain letters, digits, and underscores (_).
* @return {@code this}
*/
public Builder taskName(java.lang.String taskName) {
this.taskName = taskName;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getTaskName}
* @param taskName Property taskName: The name of the site monitoring task. This parameter is required.
* The name must be 4 to 100 characters in length.
* It can contain letters, digits, and underscores (_).
* @return {@code this}
*/
public Builder taskName(com.aliyun.ros.cdk.core.IResolvable taskName) {
this.taskName = taskName;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getTaskType}
* @param taskType Property taskType: The protocol used by the site monitoring task. This parameter is required.
* Valid values: HTTP, HTTPS, PING, TCP,
* UDP, DNS, SMTP, POP3, and FTP.
* @return {@code this}
*/
public Builder taskType(java.lang.String taskType) {
this.taskType = taskType;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getTaskType}
* @param taskType Property taskType: The protocol used by the site monitoring task. This parameter is required.
* Valid values: HTTP, HTTPS, PING, TCP,
* UDP, DNS, SMTP, POP3, and FTP.
* @return {@code this}
*/
public Builder taskType(com.aliyun.ros.cdk.core.IResolvable taskType) {
this.taskType = taskType;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getAlertIds}
* @param alertIds Property alertIds:.
* @return {@code this}
*/
public Builder alertIds(com.aliyun.ros.cdk.core.IResolvable alertIds) {
this.alertIds = alertIds;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getAlertIds}
* @param alertIds Property alertIds:.
* @return {@code this}
*/
public Builder alertIds(java.util.List alertIds) {
this.alertIds = alertIds;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getInterval}
* @param interval Property interval: The interval at which detection requests are sent.
* Valid values: 1, 5, and 15. Unit:
* minutes. Default value: 1.
* @return {@code this}
*/
public Builder interval(java.lang.Number interval) {
this.interval = interval;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getInterval}
* @param interval Property interval: The interval at which detection requests are sent.
* Valid values: 1, 5, and 15. Unit:
* minutes. Default value: 1.
* @return {@code this}
*/
public Builder interval(com.aliyun.ros.cdk.core.IResolvable interval) {
this.interval = interval;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getIspCities}
* @param ispCities Property ispCities: The information about detection points, which is specified in a JSON array.
* Example:
* [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. The three city codes represent Beijing, Hangzhou, and Qingdao.
* Note You can call the DescribeSiteMonitorISPCityList API operation to query the detection
* points that can be used to create site monitoring tasks. For more information, see
* DescribeSiteMonitorISPCityList . If this parameter is not specified, the system randomly selects three detection
* points for site monitoring.
* @return {@code this}
*/
public Builder ispCities(com.aliyun.ros.cdk.core.IResolvable ispCities) {
this.ispCities = ispCities;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getIspCities}
* @param ispCities Property ispCities: The information about detection points, which is specified in a JSON array.
* Example:
* [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. The three city codes represent Beijing, Hangzhou, and Qingdao.
* Note You can call the DescribeSiteMonitorISPCityList API operation to query the detection
* points that can be used to create site monitoring tasks. For more information, see
* DescribeSiteMonitorISPCityList . If this parameter is not specified, the system randomly selects three detection
* points for site monitoring.
* @return {@code this}
*/
public Builder ispCities(java.util.List ispCities) {
this.ispCities = ispCities;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getOptionsJson}
* @param optionsJson Property optionsJson: The extended options of the protocol that is used by the site monitoring task.
* The
* options vary based on the protocol.
* @return {@code this}
*/
public Builder optionsJson(java.lang.String optionsJson) {
this.optionsJson = optionsJson;
return this;
}
/**
* Sets the value of {@link SiteMonitorProps#getOptionsJson}
* @param optionsJson Property optionsJson: The extended options of the protocol that is used by the site monitoring task.
* The
* options vary based on the protocol.
* @return {@code this}
*/
public Builder optionsJson(com.aliyun.ros.cdk.core.IResolvable optionsJson) {
this.optionsJson = optionsJson;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link SiteMonitorProps}
* @throws NullPointerException if any required attribute was not provided
*/
@Override
public SiteMonitorProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link SiteMonitorProps}
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SiteMonitorProps {
private final java.lang.Object address;
private final java.lang.Object taskName;
private final java.lang.Object taskType;
private final java.lang.Object alertIds;
private final java.lang.Object interval;
private final java.lang.Object ispCities;
private final java.lang.Object optionsJson;
/**
* 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.address = software.amazon.jsii.Kernel.get(this, "address", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.taskName = software.amazon.jsii.Kernel.get(this, "taskName", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.taskType = software.amazon.jsii.Kernel.get(this, "taskType", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.alertIds = software.amazon.jsii.Kernel.get(this, "alertIds", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.interval = software.amazon.jsii.Kernel.get(this, "interval", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.ispCities = software.amazon.jsii.Kernel.get(this, "ispCities", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.optionsJson = software.amazon.jsii.Kernel.get(this, "optionsJson", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.address = java.util.Objects.requireNonNull(builder.address, "address is required");
this.taskName = java.util.Objects.requireNonNull(builder.taskName, "taskName is required");
this.taskType = java.util.Objects.requireNonNull(builder.taskType, "taskType is required");
this.alertIds = builder.alertIds;
this.interval = builder.interval;
this.ispCities = builder.ispCities;
this.optionsJson = builder.optionsJson;
}
@Override
public final java.lang.Object getAddress() {
return this.address;
}
@Override
public final java.lang.Object getTaskName() {
return this.taskName;
}
@Override
public final java.lang.Object getTaskType() {
return this.taskType;
}
@Override
public final java.lang.Object getAlertIds() {
return this.alertIds;
}
@Override
public final java.lang.Object getInterval() {
return this.interval;
}
@Override
public final java.lang.Object getIspCities() {
return this.ispCities;
}
@Override
public final java.lang.Object getOptionsJson() {
return this.optionsJson;
}
@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("address", om.valueToTree(this.getAddress()));
data.set("taskName", om.valueToTree(this.getTaskName()));
data.set("taskType", om.valueToTree(this.getTaskType()));
if (this.getAlertIds() != null) {
data.set("alertIds", om.valueToTree(this.getAlertIds()));
}
if (this.getInterval() != null) {
data.set("interval", om.valueToTree(this.getInterval()));
}
if (this.getIspCities() != null) {
data.set("ispCities", om.valueToTree(this.getIspCities()));
}
if (this.getOptionsJson() != null) {
data.set("optionsJson", om.valueToTree(this.getOptionsJson()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@alicloud/ros-cdk-cms.SiteMonitorProps"));
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;
SiteMonitorProps.Jsii$Proxy that = (SiteMonitorProps.Jsii$Proxy) o;
if (!address.equals(that.address)) return false;
if (!taskName.equals(that.taskName)) return false;
if (!taskType.equals(that.taskType)) return false;
if (this.alertIds != null ? !this.alertIds.equals(that.alertIds) : that.alertIds != null) return false;
if (this.interval != null ? !this.interval.equals(that.interval) : that.interval != null) return false;
if (this.ispCities != null ? !this.ispCities.equals(that.ispCities) : that.ispCities != null) return false;
return this.optionsJson != null ? this.optionsJson.equals(that.optionsJson) : that.optionsJson == null;
}
@Override
public final int hashCode() {
int result = this.address.hashCode();
result = 31 * result + (this.taskName.hashCode());
result = 31 * result + (this.taskType.hashCode());
result = 31 * result + (this.alertIds != null ? this.alertIds.hashCode() : 0);
result = 31 * result + (this.interval != null ? this.interval.hashCode() : 0);
result = 31 * result + (this.ispCities != null ? this.ispCities.hashCode() : 0);
result = 31 * result + (this.optionsJson != null ? this.optionsJson.hashCode() : 0);
return result;
}
}
}