CreateRuleRequest (AWS SDK for Java

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

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

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
`CreateRuleRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<RuleAction>`	`getActions()` A list of actions to be run when the rule is triggered.
`String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`getFunction()` The conditions of the rule.
`String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`String`	`getName()` A unique name for the rule.
`String`	`getPublishStatus()` The publish status of the rule.
`RuleTriggerEventSource`	`getTriggerEventSource()` The event source to trigger the rule.
`int`	`hashCode()`
`void`	`setActions(Collection<RuleAction> actions)` A list of actions to be run when the rule is triggered.
`void`	`setClientToken(String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setFunction(String function)` The conditions of the rule.
`void`	`setInstanceId(String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setName(String name)` A unique name for the rule.
`void`	`setPublishStatus(String publishStatus)` The publish status of the rule.
`void`	`setTriggerEventSource(RuleTriggerEventSource triggerEventSource)` The event source to trigger the rule.
`String`	`toString()` Returns a string representation of this object.
`CreateRuleRequest`	`withActions(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(String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateRuleRequest`	`withFunction(String function)` The conditions of the rule.
`CreateRuleRequest`	`withInstanceId(String instanceId)` The identifier of the Amazon Connect instance.
`CreateRuleRequest`	`withName(String name)` A unique name for the rule.
`CreateRuleRequest`	`withPublishStatus(RulePublishStatus publishStatus)` The publish status of the rule.
`CreateRuleRequest`	`withPublishStatus(String publishStatus)` The publish status of the rule.
`CreateRuleRequest`	`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
  - CreateRuleRequest
```
public CreateRuleRequest()
```
- Method Detail
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Parameters:
    
    instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - getInstanceId
```
public String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    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(String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A unique name for the rule.
    
    Parameters:
    
    name - A unique name for the rule.
  - getName
```
public String getName()
```
    A unique name for the rule.
    
    Returns:
    
    A unique name for the rule.
  - withName
```
public CreateRuleRequest withName(String name)
```
    A unique name for the rule.
    
    Parameters:
    
    name - A unique name for 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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
  - setClientToken
```
public void setClientToken(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.
    
    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.
  - getClientToken
```
public 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.
    
    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.
  - withClientToken
```
public CreateRuleRequest withClientToken(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.
    
    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:
    
    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 CreateRuleRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.777

Class CreateRuleRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRuleRequest

Method Detail

setInstanceId

getInstanceId

withInstanceId

setName

getName

withName

setTriggerEventSource

getTriggerEventSource

withTriggerEventSource

setFunction

getFunction

withFunction

getActions

setActions

withActions

withActions

setPublishStatus

getPublishStatus

withPublishStatus

withPublishStatus

setClientToken

getClientToken

withClientToken

toString

equals

hashCode

clone