Rule (aws-android-sdk-connect 2.81.1 API)

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

All Implemented Interfaces:

java.io.Serializable
```
public class Rule
extends java.lang.Object
implements java.io.Serializable
```
Information about a rule.

See Also:

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(java.lang.String key, java.lang.String value)` The tags used to organize, track, or control access for this resource.
`Rule`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<RuleAction>`	`getActions()` A list of actions to be run when the rule is triggered.
`java.util.Date`	`getCreatedTime()` The timestamp for when the rule was created.
`java.lang.String`	`getFunction()` The conditions of the rule.
`java.lang.String`	`getLastUpdatedBy()` The Amazon Resource Name (ARN) of the user who last updated the rule.
`java.util.Date`	`getLastUpdatedTime()` The timestamp for the when the rule was last updated.
`java.lang.String`	`getName()` The name of the rule.
`java.lang.String`	`getPublishStatus()` The publish status of the rule.
`java.lang.String`	`getRuleArn()` The Amazon Resource Name (ARN) of the rule.
`java.lang.String`	`getRuleId()` A unique identifier for the rule.
`java.util.Map<java.lang.String,java.lang.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`	`setActions(java.util.Collection<RuleAction> actions)` A list of actions to be run when the rule is triggered.
`void`	`setCreatedTime(java.util.Date createdTime)` The timestamp for when the rule was created.
`void`	`setFunction(java.lang.String function)` The conditions of the rule.
`void`	`setLastUpdatedBy(java.lang.String lastUpdatedBy)` The Amazon Resource Name (ARN) of the user who last updated the rule.
`void`	`setLastUpdatedTime(java.util.Date lastUpdatedTime)` The timestamp for the when the rule was last updated.
`void`	`setName(java.lang.String name)` The name of the rule.
`void`	`setPublishStatus(RulePublishStatus publishStatus)` The publish status of the rule.
`void`	`setPublishStatus(java.lang.String publishStatus)` The publish status of the rule.
`void`	`setRuleArn(java.lang.String ruleArn)` The Amazon Resource Name (ARN) of the rule.
`void`	`setRuleId(java.lang.String ruleId)` A unique identifier for the rule.
`void`	`setTags(java.util.Map<java.lang.String,java.lang.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.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Rule`	`withActions(java.util.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(java.util.Date createdTime)` The timestamp for when the rule was created.
`Rule`	`withFunction(java.lang.String function)` The conditions of the rule.
`Rule`	`withLastUpdatedBy(java.lang.String lastUpdatedBy)` The Amazon Resource Name (ARN) of the user who last updated the rule.
`Rule`	`withLastUpdatedTime(java.util.Date lastUpdatedTime)` The timestamp for the when the rule was last updated.
`Rule`	`withName(java.lang.String name)` The name of the rule.
`Rule`	`withPublishStatus(RulePublishStatus publishStatus)` The publish status of the rule.
`Rule`	`withPublishStatus(java.lang.String publishStatus)` The publish status of the rule.
`Rule`	`withRuleArn(java.lang.String ruleArn)` The Amazon Resource Name (ARN) of the rule.
`Rule`	`withRuleId(java.lang.String ruleId)` A unique identifier for the rule.
`Rule`	`withTags(java.util.Map<java.lang.String,java.lang.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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    The name of the rule.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    The name of the rule.
  - setName
```
public void setName(java.lang.String name)
```
    The name of the rule.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    name -
    The name of the rule.
  - withName
```
public Rule withName(java.lang.String name)
```
    The name of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    name -
    The name of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRuleId
```
public java.lang.String getRuleId()
```
    A unique identifier for the rule.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    A unique identifier for the rule.
  - setRuleId
```
public void setRuleId(java.lang.String ruleId)
```
    A unique identifier for the rule.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    ruleId -
    A unique identifier for the rule.
  - withRuleId
```
public Rule withRuleId(java.lang.String ruleId)
```
    A unique identifier for the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    ruleId -
    A unique identifier for the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRuleArn
```
public java.lang.String getRuleArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - setRuleArn
```
public void setRuleArn(java.lang.String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    ruleArn -
    The Amazon Resource Name (ARN) of the rule.
  - withRuleArn
```
public Rule withRuleArn(java.lang.String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ruleArn -
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTriggerEventSource
```
public RuleTriggerEventSource getTriggerEventSource()
```
    The event source to trigger the rule.
    
    Returns:
    
    The event source to trigger the rule.
  - setTriggerEventSource
```
public void setTriggerEventSource(RuleTriggerEventSource triggerEventSource)
```
    The event source to trigger the rule.
    
    Parameters:
    
    triggerEventSource -
    The event source to trigger the rule.
  - withTriggerEventSource
```
public Rule withTriggerEventSource(RuleTriggerEventSource triggerEventSource)
```
    The event source to trigger the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    triggerEventSource -
    The event source to trigger the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFunction
```
public java.lang.String getFunction()
```
    The conditions of the rule.
    
    Returns:
    
    The conditions of the rule.
  - setFunction
```
public void setFunction(java.lang.String function)
```
    The conditions of the rule.
    
    Parameters:
    
    function -
    The conditions of the rule.
  - withFunction
```
public Rule withFunction(java.lang.String function)
```
    The conditions of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    function -
    The conditions of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getActions
```
public java.util.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(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    actions -
    A list of actions to be run when the rule is triggered.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withActions
```
public Rule withActions(java.util.Collection<RuleAction> actions)
```
    A list of actions to be run when the rule is triggered.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    actions -
    A list of actions to be run when the rule is triggered.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPublishStatus
```
public java.lang.String getPublishStatus()
```
    The publish status of the rule.
    
    Constraints:
    Allowed Values: DRAFT, PUBLISHED
    
    Returns:
    
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - setPublishStatus
```
public void setPublishStatus(java.lang.String publishStatus)
```
    The publish status of the rule.
    
    Constraints:
    Allowed Values: DRAFT, PUBLISHED
    
    Parameters:
    
    publishStatus -
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - withPublishStatus
```
public Rule withPublishStatus(java.lang.String publishStatus)
```
    The publish status of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: DRAFT, PUBLISHED
    
    Parameters:
    
    publishStatus -
    The publish status of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    RulePublishStatus
  - setPublishStatus
```
public void setPublishStatus(RulePublishStatus publishStatus)
```
    The publish status of the rule.
    
    Constraints:
    Allowed Values: DRAFT, PUBLISHED
    
    Parameters:
    
    publishStatus -
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - withPublishStatus
```
public Rule withPublishStatus(RulePublishStatus publishStatus)
```
    The publish status of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: DRAFT, PUBLISHED
    
    Parameters:
    
    publishStatus -
    The publish status of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    RulePublishStatus
  - getCreatedTime
```
public java.util.Date getCreatedTime()
```
    The timestamp for when the rule was created.
    
    Returns:
    
    The timestamp for when the rule was created.
  - setCreatedTime
```
public void setCreatedTime(java.util.Date createdTime)
```
    The timestamp for when the rule was created.
    
    Parameters:
    
    createdTime -
    The timestamp for when the rule was created.
  - withCreatedTime
```
public Rule withCreatedTime(java.util.Date createdTime)
```
    The timestamp for when the rule was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    createdTime -
    The timestamp for when the rule was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLastUpdatedTime
```
public java.util.Date getLastUpdatedTime()
```
    The timestamp for the when the rule was last updated.
    
    Returns:
    
    The timestamp for the when the rule was last updated.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(java.util.Date lastUpdatedTime)
```
    The timestamp for the when the rule was last updated.
    
    Parameters:
    
    lastUpdatedTime -
    The timestamp for the when the rule was last updated.
  - withLastUpdatedTime
```
public Rule withLastUpdatedTime(java.util.Date lastUpdatedTime)
```
    The timestamp for the when the rule was last updated.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastUpdatedTime -
    The timestamp for the when the rule was last updated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLastUpdatedBy
```
public java.lang.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.
  - setLastUpdatedBy
```
public void setLastUpdatedBy(java.lang.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.
  - withLastUpdatedBy
```
public Rule withLastUpdatedBy(java.lang.String lastUpdatedBy)
```
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastUpdatedBy -
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public Rule addTagsEntry(java.lang.String key,
                         java.lang.String value)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public Rule clearTagsEntries()
```
    Removes all the entries added into Tags.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

getName

setName

withName

getRuleId

setRuleId

withRuleId

getRuleArn

setRuleArn

withRuleArn

getTriggerEventSource

setTriggerEventSource

withTriggerEventSource

getFunction

setFunction

withFunction

getActions

setActions

withActions

withActions

getPublishStatus

setPublishStatus

withPublishStatus

setPublishStatus

withPublishStatus

getCreatedTime

setCreatedTime

withCreatedTime

getLastUpdatedTime

setLastUpdatedTime

withLastUpdatedTime

getLastUpdatedBy

setLastUpdatedBy

withLastUpdatedBy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

hashCode

equals