com.amazonaws.services.iot.model

Class CreateTopicRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateTopicRuleRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateTopicRuleRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateTopicRuleRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getRuleName() The name of the rule.
java.lang.String	getTags() Metadata which can be used to manage the topic rule.
TopicRulePayload	getTopicRulePayload() The rule payload.
int	hashCode()
void	setRuleName(java.lang.String ruleName) The name of the rule.
void	setTags(java.lang.String tags) Metadata which can be used to manage the topic rule.
void	setTopicRulePayload(TopicRulePayload topicRulePayload) The rule payload.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateTopicRuleRequest	withRuleName(java.lang.String ruleName) The name of the rule.
CreateTopicRuleRequest	withTags(java.lang.String tags) Metadata which can be used to manage the topic rule.
CreateTopicRuleRequest	withTopicRulePayload(TopicRulePayload topicRulePayload) The rule payload.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTopicRuleRequest

public CreateTopicRuleRequest()

Method Detail

getRuleName

public java.lang.String getRuleName()

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Returns:

The name of the rule.

setRuleName

public void setRuleName(java.lang.String ruleName)

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Parameters:

ruleName -

The name of the rule.

withRuleName

public CreateTopicRuleRequest withRuleName(java.lang.String ruleName)

The name of the rule.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Parameters:

ruleName -

The name of the rule.

Returns:

A reference to this updated object so that method calls can be chained together.

getTopicRulePayload

public TopicRulePayload getTopicRulePayload()

The rule payload.

Returns:

The rule payload.

setTopicRulePayload

public void setTopicRulePayload(TopicRulePayload topicRulePayload)

The rule payload.

Parameters:

topicRulePayload -

The rule payload.

withTopicRulePayload

public CreateTopicRuleRequest withTopicRulePayload(TopicRulePayload topicRulePayload)

The rule payload.

Returns a reference to this object so that method calls can be chained together.

Parameters:

topicRulePayload -

The rule payload.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.lang.String getTags()

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

setTags

public void setTags(java.lang.String tags)

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags -

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

withTags

public CreateTopicRuleRequest withTags(java.lang.String tags)

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags -

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

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