/* * 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; /** *

* Describes an action that writes data to an Amazon Kinesis Firehose stream. *

*/ public class FirehoseAction implements Serializable { /** *

* The IAM role that grants access to the Amazon Kinesis Firehose stream. *

*/ private String roleArn; /** *

* The delivery stream name. *

*/ private String deliveryStreamName; /** *

* A character separator that will be used to separate records written to * the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' * (Windows newline), ',' (comma). *

*

* Constraints:
* Pattern: ([\n\t])|(\r\n)|(,)
*/ private String separator; /** *

* Whether to deliver the Kinesis Data Firehose stream as a batch by using * PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's SQL * statement evaluates to an Array, each Array element forms one record in * the PutRecordBatch request. The resulting array can't * have more than 500 records. *

*/ private Boolean batchMode; /** *

* The IAM role that grants access to the Amazon Kinesis Firehose stream. *

* * @return

* The IAM role that grants access to the Amazon Kinesis Firehose * stream. *

*/ public String getRoleArn() { return roleArn; } /** *

* The IAM role that grants access to the Amazon Kinesis Firehose stream. *

* * @param roleArn

* The IAM role that grants access to the Amazon Kinesis Firehose * stream. *

*/ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The IAM role that grants access to the Amazon Kinesis Firehose stream. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param roleArn

* The IAM role that grants access to the Amazon Kinesis Firehose * stream. *

* @return A reference to this updated object so that method calls can be * chained together. */ public FirehoseAction withRoleArn(String roleArn) { this.roleArn = roleArn; return this; } /** *

* The delivery stream name. *

* * @return

* The delivery stream name. *

*/ public String getDeliveryStreamName() { return deliveryStreamName; } /** *

* The delivery stream name. *

* * @param deliveryStreamName

* The delivery stream name. *

*/ public void setDeliveryStreamName(String deliveryStreamName) { this.deliveryStreamName = deliveryStreamName; } /** *

* The delivery stream name. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param deliveryStreamName

* The delivery stream name. *

* @return A reference to this updated object so that method calls can be * chained together. */ public FirehoseAction withDeliveryStreamName(String deliveryStreamName) { this.deliveryStreamName = deliveryStreamName; return this; } /** *

* A character separator that will be used to separate records written to * the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' * (Windows newline), ',' (comma). *

*

* Constraints:
* Pattern: ([\n\t])|(\r\n)|(,)
* * @return

* A character separator that will be used to separate records * written to the Firehose stream. Valid values are: '\n' (newline), * '\t' (tab), '\r\n' (Windows newline), ',' (comma). *

*/ public String getSeparator() { return separator; } /** *

* A character separator that will be used to separate records written to * the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' * (Windows newline), ',' (comma). *

*

* Constraints:
* Pattern: ([\n\t])|(\r\n)|(,)
* * @param separator

* A character separator that will be used to separate records * written to the Firehose stream. Valid values are: '\n' * (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). *

*/ public void setSeparator(String separator) { this.separator = separator; } /** *

* A character separator that will be used to separate records written to * the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' * (Windows newline), ',' (comma). *

*

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

* Constraints:
* Pattern: ([\n\t])|(\r\n)|(,)
* * @param separator

* A character separator that will be used to separate records * written to the Firehose stream. Valid values are: '\n' * (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). *

* @return A reference to this updated object so that method calls can be * chained together. */ public FirehoseAction withSeparator(String separator) { this.separator = separator; return this; } /** *

* Whether to deliver the Kinesis Data Firehose stream as a batch by using * PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's SQL * statement evaluates to an Array, each Array element forms one record in * the PutRecordBatch request. The resulting array can't * have more than 500 records. *

* * @return

* Whether to deliver the Kinesis Data Firehose stream as a batch by * using PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's * SQL statement evaluates to an Array, each Array element forms one * record in the PutRecordBatch request. The resulting array * can't have more than 500 records. *

*/ public Boolean isBatchMode() { return batchMode; } /** *

* Whether to deliver the Kinesis Data Firehose stream as a batch by using * PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's SQL * statement evaluates to an Array, each Array element forms one record in * the PutRecordBatch request. The resulting array can't * have more than 500 records. *

* * @return

* Whether to deliver the Kinesis Data Firehose stream as a batch by * using PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's * SQL statement evaluates to an Array, each Array element forms one * record in the PutRecordBatch request. The resulting array * can't have more than 500 records. *

*/ public Boolean getBatchMode() { return batchMode; } /** *

* Whether to deliver the Kinesis Data Firehose stream as a batch by using * PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's SQL * statement evaluates to an Array, each Array element forms one record in * the PutRecordBatch request. The resulting array can't * have more than 500 records. *

* * @param batchMode

* Whether to deliver the Kinesis Data Firehose stream as a batch * by using PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the * rule's SQL statement evaluates to an Array, each Array element * forms one record in the PutRecordBatch request. The resulting * array can't have more than 500 records. *

*/ public void setBatchMode(Boolean batchMode) { this.batchMode = batchMode; } /** *

* Whether to deliver the Kinesis Data Firehose stream as a batch by using * PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the rule's SQL * statement evaluates to an Array, each Array element forms one record in * the PutRecordBatch request. The resulting array can't * have more than 500 records. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param batchMode

* Whether to deliver the Kinesis Data Firehose stream as a batch * by using PutRecordBatch . The default value is * false. *

*

* When batchMode is true and the * rule's SQL statement evaluates to an Array, each Array element * forms one record in the PutRecordBatch request. The resulting * array can't have more than 500 records. *

* @return A reference to this updated object so that method calls can be * chained together. */ public FirehoseAction withBatchMode(Boolean batchMode) { this.batchMode = batchMode; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getRoleArn() != null) sb.append("roleArn: " + getRoleArn() + ","); if (getDeliveryStreamName() != null) sb.append("deliveryStreamName: " + getDeliveryStreamName() + ","); if (getSeparator() != null) sb.append("separator: " + getSeparator() + ","); if (getBatchMode() != null) sb.append("batchMode: " + getBatchMode()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getDeliveryStreamName() == null) ? 0 : getDeliveryStreamName().hashCode()); hashCode = prime * hashCode + ((getSeparator() == null) ? 0 : getSeparator().hashCode()); hashCode = prime * hashCode + ((getBatchMode() == null) ? 0 : getBatchMode().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof FirehoseAction == false) return false; FirehoseAction other = (FirehoseAction) obj; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getDeliveryStreamName() == null ^ this.getDeliveryStreamName() == null) return false; if (other.getDeliveryStreamName() != null && other.getDeliveryStreamName().equals(this.getDeliveryStreamName()) == false) return false; if (other.getSeparator() == null ^ this.getSeparator() == null) return false; if (other.getSeparator() != null && other.getSeparator().equals(this.getSeparator()) == false) return false; if (other.getBatchMode() == null ^ this.getBatchMode() == null) return false; if (other.getBatchMode() != null && other.getBatchMode().equals(this.getBatchMode()) == false) return false; return true; } }