Package com.ibm.cloud.networking.alerts.v1.model

Class UpdateAlertPolicyOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.networking.alerts.v1.model.UpdateAlertPolicyOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateAlertPolicyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateAlertPolicy options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAlertPolicyOptions.AlertType	Condition for the alert.
static class	UpdateAlertPolicyOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	alertType()	Gets the alertType.
Map<String,Object>	conditions()	Gets the conditions.
String	description()	Gets the description.
Boolean	enabled()	Gets the enabled.
Map<String,Object>	filters()	Gets the filters.
UpdateAlertPolicyInputMechanisms	mechanisms()	Gets the mechanisms.
String	name()	Gets the name.
UpdateAlertPolicyOptions.Builder	newBuilder()	New builder.
String	policyId()	Gets the policyId.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public UpdateAlertPolicyOptions.Builder newBuilder()

New builder.

Returns:

a UpdateAlertPolicyOptions builder

policyId

public String policyId()

Gets the policyId. Alert policy identifier.

Returns:

the policyId

name

public String name()

Gets the name. Policy name.

Returns:

the name

description

public String description()

Gets the description. Policy description.

Returns:

the description

enabled

public Boolean enabled()

Gets the enabled. Is the alert policy active.

Returns:

the enabled

alertType

public String alertType()

Gets the alertType. Condition for the alert. Use 'dos_attack_l7' to set up an HTTP DDOS Attack Alerter, use 'g6_pool_toggle_alert' to set up Load Balancing Pool Enablement Alerter, use 'clickhouse_alert_fw_anomaly' to set up WAF Alerter and 'clickhouse_alert_fw_ent_anomaly' to set up Advanced Security Alerter.

Returns:

the alertType

mechanisms

public UpdateAlertPolicyInputMechanisms mechanisms()

Gets the mechanisms. Delivery mechanisms for the alert, can include an email, a webhook, or both.

Returns:

the mechanisms

conditions

public Map<String,Object> conditions()

Gets the conditions. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both.

Returns:

the conditions

filters

public Map<String,Object> filters()

Gets the filters. Optional filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.

Returns:

the filters