software.amazon.awssdk.services.iot.model

Interface FirehoseAction.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FirehoseAction.Builder,FirehoseAction>, SdkBuilder<FirehoseAction.Builder,FirehoseAction>, SdkPojo

Enclosing class:

FirehoseAction

public static interface FirehoseAction.Builder
extends SdkPojo, CopyableBuilder<FirehoseAction.Builder,FirehoseAction>

Method Summary

Modifier and Type	Method and Description
FirehoseAction.Builder	batchMode(Boolean batchMode) Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch .
FirehoseAction.Builder	deliveryStreamName(String deliveryStreamName) The delivery stream name.
FirehoseAction.Builder	roleArn(String roleArn) The IAM role that grants access to the Amazon Kinesis Firehose stream.
FirehoseAction.Builder	separator(String separator) A character separator that will be used to separate records written to the Firehose stream.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

roleArn

FirehoseAction.Builder roleArn(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.

deliveryStreamName

FirehoseAction.Builder deliveryStreamName(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.

separator

FirehoseAction.Builder separator(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.

batchMode

FirehoseAction.Builder batchMode(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.