Package com.smartsheet.api.models
Class AutomationRule
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.AutomationRule
-
public class AutomationRule extends NamedModel<java.lang.Long>
-
-
Constructor Summary
Constructors Constructor Description AutomationRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AutomationActiongetAction()Gets the automation action for this rule.java.util.DategetCreatedAt()Gets a timestamp of when the rule was created.UsergetCreatedBy()Gets the User object for the author of this rule.AutomationRuleDisabledReasongetDisabledReason()Gets a machine-readable reason a rule is disabled.java.lang.StringgetDisabledReasonText()Gets descriptive text for why this rule is disabled.java.lang.BooleangetEnabled()Gets flag indicating if rule is activejava.util.DategetModifiedAt()Gets a timestamp for the last modification to this rule.UsergetModifiedBy()Gets the User who last modified this rule.java.lang.BooleangetUserCanModify()Gets a flag indicating if the current user can modify this rule.AutomationRulesetAction(AutomationAction action)Sets the automation action for this rule.AutomationRulesetCreatedAt(java.util.Date createdAt)Sets a timestamp for when the rule was created.AutomationRulesetCreatedBy(User createdBy)Sets the User object for the author of this rule.AutomationRulesetDisabledReason(AutomationRuleDisabledReason disabledReason)Sets a machine-readable reason a rule is disabled.AutomationRulesetDisabledReasonText(java.lang.String disabledReasonText)Sets descriptive text for why this rule is disabled.AutomationRulesetEnabled(java.lang.Boolean enabled)Sets flag indicating if rule is activeAutomationRulesetModifiedAt(java.util.Date modifiedAt)Sets a timestamp for the last modification to this ruleAutomationRulesetModifiedBy(User modifiedBy)Sets the User who last modified this rule.AutomationRulesetUserCanModify(java.lang.Boolean userCanModify)Sets a flag indicating if the current user can modify this rule.-
Methods inherited from class com.smartsheet.api.models.NamedModel
getName, setName
-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
getAction
public AutomationAction getAction()
Gets the automation action for this rule.- Returns:
- the automation action
-
setAction
public AutomationRule setAction(AutomationAction action)
Sets the automation action for this rule.- Parameters:
action- the automation action
-
getCreatedAt
public java.util.Date getCreatedAt()
Gets a timestamp of when the rule was created.- Returns:
- the timestamp
-
setCreatedAt
public AutomationRule setCreatedAt(java.util.Date createdAt)
Sets a timestamp for when the rule was created.- Parameters:
createdAt- the timestamp
-
getCreatedBy
public User getCreatedBy()
Gets the User object for the author of this rule.- Returns:
- the User object
-
setCreatedBy
public AutomationRule setCreatedBy(User createdBy)
Sets the User object for the author of this rule.- Parameters:
createdBy- the User object
-
getDisabledReason
public AutomationRuleDisabledReason getDisabledReason()
Gets a machine-readable reason a rule is disabled.- Returns:
- the reason
-
setDisabledReason
public AutomationRule setDisabledReason(AutomationRuleDisabledReason disabledReason)
Sets a machine-readable reason a rule is disabled.- Parameters:
disabledReason- the reason
-
getDisabledReasonText
public java.lang.String getDisabledReasonText()
Gets descriptive text for why this rule is disabled.- Returns:
- the reason
-
setDisabledReasonText
public AutomationRule setDisabledReasonText(java.lang.String disabledReasonText)
Sets descriptive text for why this rule is disabled.- Parameters:
disabledReasonText- the reason
-
getEnabled
public java.lang.Boolean getEnabled()
Gets flag indicating if rule is active- Returns:
- the flag
-
setEnabled
public AutomationRule setEnabled(java.lang.Boolean enabled)
Sets flag indicating if rule is active- Parameters:
enabled- the flag
-
getModifiedAt
public java.util.Date getModifiedAt()
Gets a timestamp for the last modification to this rule.- Returns:
- the timestamp
-
setModifiedAt
public AutomationRule setModifiedAt(java.util.Date modifiedAt)
Sets a timestamp for the last modification to this rule- Parameters:
modifiedAt- the timestamp
-
getModifiedBy
public User getModifiedBy()
Gets the User who last modified this rule.- Returns:
- the User
-
setModifiedBy
public AutomationRule setModifiedBy(User modifiedBy)
Sets the User who last modified this rule.
-
getUserCanModify
public java.lang.Boolean getUserCanModify()
Gets a flag indicating if the current user can modify this rule.- Returns:
- the flag
-
setUserCanModify
public AutomationRule setUserCanModify(java.lang.Boolean userCanModify)
Sets a flag indicating if the current user can modify this rule.- Parameters:
userCanModify- the flag
-
-