/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.iot.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* 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. *
** Requires permission to access the CreateTopicRule action. *
*/ public class CreateTopicRuleRequest extends AmazonWebServiceRequest implements Serializable { /** ** The name of the rule. *
*
* Constraints:
* Length: 1 - 128
* Pattern: ^[a-zA-Z0-9_]+$
*/
private String ruleName;
/**
*
* The rule payload. *
*/ private TopicRulePayload topicRulePayload; /** ** 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..." *
** The name of the rule. *
*
* Constraints:
* Length: 1 - 128
* Pattern: ^[a-zA-Z0-9_]+$
*
* @return
* The name of the rule. *
*/ public String getRuleName() { return ruleName; } /** ** The name of the rule. *
*
* Constraints:
* Length: 1 - 128
* Pattern: ^[a-zA-Z0-9_]+$
*
* @param ruleName
* The name of the rule. *
*/ public void setRuleName(String ruleName) { this.ruleName = 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_]+$
*
* @param ruleName
* The name of the rule. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateTopicRuleRequest withRuleName(String ruleName) { this.ruleName = ruleName; return this; } /** ** The rule payload. *
* * @return* The rule payload. *
*/ public TopicRulePayload getTopicRulePayload() { return topicRulePayload; } /** ** The rule payload. *
* * @param topicRulePayload* The rule payload. *
*/ public void setTopicRulePayload(TopicRulePayload topicRulePayload) { this.topicRulePayload = topicRulePayload; } /** ** The rule payload. *
** Returns a reference to this object so that method calls can be chained * together. * * @param topicRulePayload
* The rule payload. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateTopicRuleRequest withTopicRulePayload(TopicRulePayload topicRulePayload) { this.topicRulePayload = topicRulePayload; return this; } /** ** 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..." *
** 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..." *
** 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..." *
** 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..." *
** 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. * * @param 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..." *
*