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

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.CreateRuleRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateRuleRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateRuleRequest()

Constructors
Constructor and Description
`CreateRuleRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<RuleAction>`	`getActions()` A list of actions to be run when the rule is triggered.
`java.lang.String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`java.lang.String`	`getFunction()` The conditions of the rule.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.String`	`getName()` A unique name for the rule.
`java.lang.String`	`getPublishStatus()` The publish status of the rule.
`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`	`setClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setFunction(java.lang.String function)` The conditions of the rule.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setName(java.lang.String name)` A unique name for 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`	`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.
`CreateRuleRequest`	`withActions(java.util.Collection<RuleAction> actions)` A list of actions to be run when the rule is triggered.
`CreateRuleRequest`	`withActions(RuleAction... actions)` A list of actions to be run when the rule is triggered.
`CreateRuleRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateRuleRequest`	`withFunction(java.lang.String function)` The conditions of the rule.
`CreateRuleRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`CreateRuleRequest`	`withName(java.lang.String name)` A unique name for the rule.
`CreateRuleRequest`	`withPublishStatus(RulePublishStatus publishStatus)` The publish status of the rule.
`CreateRuleRequest`	`withPublishStatus(java.lang.String publishStatus)` The publish status of the rule.
`CreateRuleRequest`	`withTriggerEventSource(RuleTriggerEventSource triggerEventSource)` The event source to trigger the rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateRuleRequest
```
public CreateRuleRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public CreateRuleRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public java.lang.String getName()
```
    A unique name for the rule.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    A unique name for the rule.
  - setName
```
public void setName(java.lang.String name)
```
    A unique name for the rule.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    name -
    A unique name for the rule.
  - withName
```
public CreateRuleRequest withName(java.lang.String name)
```
    A unique name for 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 -
    A unique name for 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - withClientToken
```
public CreateRuleRequest withClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns:
    
    A reference to this updated 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 CreateRuleRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRuleRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getName

setName

withName

getTriggerEventSource

setTriggerEventSource

withTriggerEventSource

getFunction

setFunction

withFunction

getActions

setActions

withActions

withActions

getPublishStatus

setPublishStatus

withPublishStatus

setPublishStatus

withPublishStatus

getClientToken

setClientToken

withClientToken

toString

hashCode

equals