FirehoseAction (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

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
`FirehoseAction`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getBatchMode()` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`String`	`getDeliveryStreamName()` The delivery stream name.
`String`	`getRoleArn()` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`String`	`getSeparator()` A character separator that will be used to separate records written to the Firehose stream.
`int`	`hashCode()`
`Boolean`	`isBatchMode()` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchMode(Boolean batchMode)` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`void`	`setDeliveryStreamName(String deliveryStreamName)` The delivery stream name.
`void`	`setRoleArn(String roleArn)` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`void`	`setSeparator(String separator)` A character separator that will be used to separate records written to the Firehose stream.
`String`	`toString()` Returns a string representation of this object.
`FirehoseAction`	`withBatchMode(Boolean batchMode)` Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch` .
`FirehoseAction`	`withDeliveryStreamName(String deliveryStreamName)` The delivery stream name.
`FirehoseAction`	`withRoleArn(String roleArn)` The IAM role that grants access to the Amazon Kinesis Firehose stream.
`FirehoseAction`	`withSeparator(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
  - setRoleArn
```
public void setRoleArn(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.
  - getRoleArn
```
public 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.
  - withRoleArn
```
public FirehoseAction withRoleArn(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliveryStreamName
```
public void setDeliveryStreamName(String deliveryStreamName)
```
    The delivery stream name.
    
    Parameters:
    
    deliveryStreamName - The delivery stream name.
  - getDeliveryStreamName
```
public String getDeliveryStreamName()
```
    The delivery stream name.
    
    Returns:
    
    The delivery stream name.
  - withDeliveryStreamName
```
public FirehoseAction withDeliveryStreamName(String deliveryStreamName)
```
    The delivery stream name.
    
    Parameters:
    
    deliveryStreamName - The delivery stream name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSeparator
```
public void setSeparator(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).
    
    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).
  - getSeparator
```
public 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).
    
    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).
  - withSeparator
```
public FirehoseAction withSeparator(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).
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchMode
```
public void setBatchMode(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.
  - getBatchMode
```
public 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.
  - withBatchMode
```
public FirehoseAction withBatchMode(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBatchMode
```
public 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.
  - 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 FirehoseAction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FirehoseAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FirehoseAction

Method Detail

setRoleArn

getRoleArn

withRoleArn

setDeliveryStreamName

getDeliveryStreamName

withDeliveryStreamName

setSeparator

getSeparator

withSeparator

setBatchMode

getBatchMode

withBatchMode

isBatchMode

toString

equals

hashCode

clone

marshall