Package software.amazon.awssdk.services.iot.model

Class FirehoseAction

java.lang.Object

software.amazon.awssdk.services.iot.model.FirehoseAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FirehoseAction.Builder,FirehoseAction>

@Generated("software.amazon.awssdk:codegen")
public final class FirehoseAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FirehoseAction.Builder,FirehoseAction>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FirehoseAction.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	batchMode()	Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch .
static FirehoseAction.Builder	builder()
String	deliveryStreamName()	The delivery stream name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The IAM role that grants access to the Amazon Kinesis Firehose stream.
List<SdkField<?>>	sdkFields()
String	separator()	A character separator that will be used to separate records written to the Firehose stream.
static Class<? extends FirehoseAction.Builder>	serializableBuilderClass()
FirehoseAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleArn

public final String roleArn()

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.

deliveryStreamName

public final String deliveryStreamName()

The delivery stream name.

Returns:

The delivery stream name.

separator

public final 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 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).

batchMode

public final 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:

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.

toBuilder

public FirehoseAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FirehoseAction.Builder,FirehoseAction>

builder

public static FirehoseAction.Builder builder()

serializableBuilderClass

public static Class<? extends FirehoseAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo