Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connect.model.Rule

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a rule.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Rule`	`clearTagsEntries()` Removes all the entries added into Tags.
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`List<RuleAction>`	`getActions()` A list of actions to be run when the rule is triggered.
`Date`	`getCreatedTime()` The timestamp for when the rule was created.
`String`	`getFunction()` The conditions of the rule.
`String`	`getLastUpdatedBy()` The Amazon Resource Name (ARN) of the user who last updated the rule.
`Date`	`getLastUpdatedTime()` The timestamp for the when the rule was last updated.
`String`	`getName()` The name of the rule.
`String`	`getPublishStatus()` The publish status of the rule.
`String`	`getRuleArn()` The Amazon Resource Name (ARN) of the rule.
`String`	`getRuleId()` A unique identifier for the rule.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`RuleTriggerEventSource`	`getTriggerEventSource()` The event source to trigger the rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActions(Collection<RuleAction> actions)` A list of actions to be run when the rule is triggered.
`void`	`setCreatedTime(Date createdTime)` The timestamp for when the rule was created.
`void`	`setFunction(String function)` The conditions of the rule.
`void`	`setLastUpdatedBy(String lastUpdatedBy)` The Amazon Resource Name (ARN) of the user who last updated the rule.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The timestamp for the when the rule was last updated.
`void`	`setName(String name)` The name of the rule.
`void`	`setPublishStatus(String publishStatus)` The publish status of the rule.
`void`	`setRuleArn(String ruleArn)` The Amazon Resource Name (ARN) of the rule.
`void`	`setRuleId(String ruleId)` A unique identifier for the rule.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setTriggerEventSource(RuleTriggerEventSource triggerEventSource)` The event source to trigger the rule.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withActions(Collection<RuleAction> actions)` A list of actions to be run when the rule is triggered.
`Rule`	`withActions(RuleAction... actions)` A list of actions to be run when the rule is triggered.
`Rule`	`withCreatedTime(Date createdTime)` The timestamp for when the rule was created.
`Rule`	`withFunction(String function)` The conditions of the rule.
`Rule`	`withLastUpdatedBy(String lastUpdatedBy)` The Amazon Resource Name (ARN) of the user who last updated the rule.
`Rule`	`withLastUpdatedTime(Date lastUpdatedTime)` The timestamp for the when the rule was last updated.
`Rule`	`withName(String name)` The name of the rule.
`Rule`	`withPublishStatus(RulePublishStatus publishStatus)` The publish status of the rule.
`Rule`	`withPublishStatus(String publishStatus)` The publish status of the rule.
`Rule`	`withRuleArn(String ruleArn)` The Amazon Resource Name (ARN) of the rule.
`Rule`	`withRuleId(String ruleId)` A unique identifier for the rule.
`Rule`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`Rule`	`withTriggerEventSource(RuleTriggerEventSource triggerEventSource)` The event source to trigger the rule.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
  - getName
```
public String getName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - withName
```
public Rule withName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleId
```
public void setRuleId(String ruleId)
```
    A unique identifier for the rule.
    
    Parameters:
    
    ruleId - A unique identifier for the rule.
  - getRuleId
```
public String getRuleId()
```
    A unique identifier for the rule.
    
    Returns:
    
    A unique identifier for the rule.
  - withRuleId
```
public Rule withRuleId(String ruleId)
```
    A unique identifier for the rule.
    
    Parameters:
    
    ruleId - A unique identifier for the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleArn
```
public void setRuleArn(String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    ruleArn - The Amazon Resource Name (ARN) of the rule.
  - getRuleArn
```
public String getRuleArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - withRuleArn
```
public Rule withRuleArn(String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    ruleArn - The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTriggerEventSource
```
public void setTriggerEventSource(RuleTriggerEventSource triggerEventSource)
```
    The event source to trigger the rule.
    
    Parameters:
    
    triggerEventSource - The event source to trigger the rule.
  - getTriggerEventSource
```
public RuleTriggerEventSource getTriggerEventSource()
```
    The event source to trigger the rule.
    
    Returns:
    
    The event source to trigger the rule.
  - withTriggerEventSource
```
public Rule withTriggerEventSource(RuleTriggerEventSource triggerEventSource)
```
    The event source to trigger the rule.
    
    Parameters:
    
    triggerEventSource - The event source to trigger the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFunction
```
public void setFunction(String function)
```
    The conditions of the rule.
    
    Parameters:
    
    function - The conditions of the rule.
  - getFunction
```
public String getFunction()
```
    The conditions of the rule.
    
    Returns:
    
    The conditions of the rule.
  - withFunction
```
public Rule withFunction(String function)
```
    The conditions of the rule.
    
    Parameters:
    
    function - The conditions of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<RuleAction> getActions()
```
    A list of actions to be run when the rule is triggered.
    
    Returns:
    
    A list of actions to be run when the rule is triggered.
  - setActions
```
public void setActions(Collection<RuleAction> actions)
```
    A list of actions to be run when the rule is triggered.
    
    Parameters:
    
    actions - A list of actions to be run when the rule is triggered.
  - withActions
```
public Rule withActions(RuleAction... actions)
```
    A list of actions to be run when the rule is triggered.
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actions - A list of actions to be run when the rule is triggered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public Rule withActions(Collection<RuleAction> actions)
```
    A list of actions to be run when the rule is triggered.
    
    Parameters:
    
    actions - A list of actions to be run when the rule is triggered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublishStatus
```
public void setPublishStatus(String publishStatus)
```
    The publish status of the rule.
    
    Parameters:
    
    publishStatus - The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - getPublishStatus
```
public String getPublishStatus()
```
    The publish status of the rule.
    
    Returns:
    
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - withPublishStatus
```
public Rule withPublishStatus(String publishStatus)
```
    The publish status of the rule.
    
    Parameters:
    
    publishStatus - The publish status of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RulePublishStatus
  - withPublishStatus
```
public Rule withPublishStatus(RulePublishStatus publishStatus)
```
    The publish status of the rule.
    
    Parameters:
    
    publishStatus - The publish status of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RulePublishStatus
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The timestamp for when the rule was created.
    
    Parameters:
    
    createdTime - The timestamp for when the rule was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The timestamp for when the rule was created.
    
    Returns:
    
    The timestamp for when the rule was created.
  - withCreatedTime
```
public Rule withCreatedTime(Date createdTime)
```
    The timestamp for when the rule was created.
    
    Parameters:
    
    createdTime - The timestamp for when the rule was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The timestamp for the when the rule was last updated.
    
    Parameters:
    
    lastUpdatedTime - The timestamp for the when the rule was last updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The timestamp for the when the rule was last updated.
    
    Returns:
    
    The timestamp for the when the rule was last updated.
  - withLastUpdatedTime
```
public Rule withLastUpdatedTime(Date lastUpdatedTime)
```
    The timestamp for the when the rule was last updated.
    
    Parameters:
    
    lastUpdatedTime - The timestamp for the when the rule was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedBy
```
public void setLastUpdatedBy(String lastUpdatedBy)
```
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Parameters:
    
    lastUpdatedBy - The Amazon Resource Name (ARN) of the user who last updated the rule.
  - getLastUpdatedBy
```
public String getLastUpdatedBy()
```
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user who last updated the rule.
  - withLastUpdatedBy
```
public Rule withLastUpdatedBy(String lastUpdatedBy)
```
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Parameters:
    
    lastUpdatedBy - The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public Rule withTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Rule addTagsEntry(String key,
                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Rule clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Rule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setName

getName

withName

setRuleId

getRuleId

withRuleId

setRuleArn

getRuleArn

withRuleArn

setTriggerEventSource

getTriggerEventSource

withTriggerEventSource

setFunction

getFunction

withFunction

getActions

setActions

withActions

withActions

setPublishStatus

getPublishStatus

withPublishStatus

withPublishStatus

setCreatedTime

getCreatedTime

withCreatedTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setLastUpdatedBy

getLastUpdatedBy

withLastUpdatedBy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall