Package com.mypurecloud.sdk.v2.model

Class CommonRule

java.lang.Object
com.mypurecloud.sdk.v2.model.CommonRule
All Implemented Interfaces:
Serializable
public class CommonRule extends Object implements Serializable
CommonRule
See Also:

  • Constructor Details

    • CommonRule

      public CommonRule()

    • CommonRule

      public CommonRule(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public CommonRule name(String name)
      Name of the rule

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • description

      public CommonRule description(String description)
      The description of the rule.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • enabled

      public CommonRule enabled(Boolean enabled)
      Indicates if the rule is enabled.

    • getEnabled

      public Boolean getEnabled()

    • setEnabled

      public void setEnabled(Boolean enabled)

    • notifications

      public CommonRule notifications(List<AlertNotification> notifications)
      The alert notification types to trigger when alarm state changes as well as the users they will be sent to.

    • getNotifications

      public List<AlertNotification> getNotifications()

    • setNotifications

      public void setNotifications(List<AlertNotification> notifications)

    • sendExitingAlarmNotifications

      public CommonRule sendExitingAlarmNotifications(Boolean sendExitingAlarmNotifications)
      Indicates if the alert will send a notification when it is closed.

    • getSendExitingAlarmNotifications

      public Boolean getSendExitingAlarmNotifications()

    • setSendExitingAlarmNotifications

      public void setSendExitingAlarmNotifications(Boolean sendExitingAlarmNotifications)

    • waitBetweenNotificationMs

      public CommonRule waitBetweenNotificationMs(Long waitBetweenNotificationMs)
      The amount of time in milliseconds to wait between notification.

    • getWaitBetweenNotificationMs

      public Long getWaitBetweenNotificationMs()

    • setWaitBetweenNotificationMs

      public void setWaitBetweenNotificationMs(Long waitBetweenNotificationMs)

    • conditions

      public CommonRule conditions(CommonRuleConditions conditions)
      The set of metric conditions that would trigger an alert.

    • getConditions

      public CommonRuleConditions getConditions()

    • setConditions

      public void setConditions(CommonRuleConditions conditions)

    • type

      public CommonRule type(CommonRule.TypeEnum type)
      The type of the rule.

    • getType

      public CommonRule.TypeEnum getType()

    • setType

      public void setType(CommonRule.TypeEnum type)

    • inAlarm

      public CommonRule inAlarm(Boolean inAlarm)
      Indicates if the rule is in alarm state.

    • getInAlarm

      public Boolean getInAlarm()

    • setInAlarm

      public void setInAlarm(Boolean inAlarm)

    • user

      public CommonRule user(UserReference user)
      The entity that created the rule.

    • getUser

      public UserReference getUser()

    • setUser

      public void setUser(UserReference user)

    • version

      public CommonRule version(Integer version)
      The current version number of the rule.

    • getVersion

      public Integer getVersion()

    • setVersion

      public void setVersion(Integer version)

    • dateCreated

      public CommonRule dateCreated(Date dateCreated)
      The creation date of the rule when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateCreated

      public Date getDateCreated()

    • setDateCreated

      public void setDateCreated(Date dateCreated)

    • dateLastModified

      public CommonRule dateLastModified(Date dateLastModified)
      The timestamp of the last update to the rule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateLastModified

      public Date getDateLastModified()

    • setDateLastModified

      public void setDateLastModified(Date dateLastModified)

    • getSelfUri

      public String getSelfUri()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object