FirehoseAction (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.iot.model.FirehoseAction

All Implemented Interfaces:

java.io.Serializable
```
public class FirehoseAction
extends java.lang.Object
implements java.io.Serializable
```
Describes an action that writes data to an Amazon Kinesis Firehose stream.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FirehoseAction()

Constructors
Constructor and Description
`FirehoseAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getBatchMode()` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`java.lang.String`	`getDeliveryStreamName()` The delivery stream name.
`java.lang.String`	`getRoleArn()` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`java.lang.String`	`getSeparator()` A character separator that will be used to separate records written to the Firehose stream.
`int`	`hashCode()`
`java.lang.Boolean`	`isBatchMode()` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`void`	`setBatchMode(java.lang.Boolean batchMode)` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`void`	`setDeliveryStreamName(java.lang.String deliveryStreamName)` The delivery stream name.
`void`	`setRoleArn(java.lang.String roleArn)` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`void`	`setSeparator(java.lang.String separator)` A character separator that will be used to separate records written to the Firehose stream.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`FirehoseAction`	`withBatchMode(java.lang.Boolean batchMode)` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`FirehoseAction`	`withDeliveryStreamName(java.lang.String deliveryStreamName)` The delivery stream name.
`FirehoseAction`	`withRoleArn(java.lang.String roleArn)` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`FirehoseAction`	`withSeparator(java.lang.String separator)` A character separator that will be used to separate records written to the Firehose stream.

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

- Constructor Detail
  - FirehoseAction
```
public FirehoseAction()
```
- Method Detail
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The IAM role that grants access to the Amazon Kinesis Firehose stream.
    
    Returns:
    
    The IAM role that grants access to the Amazon Kinesis Firehose stream.
  - setRoleArn
```
public void setRoleArn(java.lang.String roleArn)
```
    The IAM role that grants access to the Amazon Kinesis Firehose stream.
    
    Parameters:
    
    roleArn -
    The IAM role that grants access to the Amazon Kinesis Firehose stream.
  - withRoleArn
```
public FirehoseAction withRoleArn(java.lang.String 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.
    
    Parameters:
    
    roleArn -
    The IAM role that grants access to the Amazon Kinesis Firehose stream.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDeliveryStreamName
```
public java.lang.String getDeliveryStreamName()
```
    The delivery stream name.
    
    Returns:
    
    The delivery stream name.
  - setDeliveryStreamName
```
public void setDeliveryStreamName(java.lang.String deliveryStreamName)
```
    The delivery stream name.
    
    Parameters:
    
    deliveryStreamName -
    The delivery stream name.
  - withDeliveryStreamName
```
public FirehoseAction withDeliveryStreamName(java.lang.String deliveryStreamName)
```
    The delivery stream name.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deliveryStreamName -
    The delivery stream name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSeparator
```
public java.lang.String getSeparator()
```
    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)|(,)
    
    Returns:
    
    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).
  - setSeparator
```
public void setSeparator(java.lang.String 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)|(,)
    
    Parameters:
    
    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).
  - withSeparator
```
public FirehoseAction withSeparator(java.lang.String 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)|(,)
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - isBatchMode
```
public java.lang.Boolean isBatchMode()
```
    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:
    
    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.
  - getBatchMode
```
public java.lang.Boolean getBatchMode()
```
    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:
    
    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.
  - setBatchMode
```
public void setBatchMode(java.lang.Boolean 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.
    
    Parameters:
    
    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.
  - withBatchMode
```
public FirehoseAction withBatchMode(java.lang.Boolean 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.
    
    Parameters:
    
    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 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 FirehoseAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FirehoseAction

Method Detail

getRoleArn

setRoleArn

withRoleArn

getDeliveryStreamName

setDeliveryStreamName

withDeliveryStreamName

getSeparator

setSeparator

withSeparator

isBatchMode

getBatchMode

setBatchMode

withBatchMode

toString

hashCode

equals