Class FirehoseAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FirehoseAction.Builder,
FirehoseAction>
Describes an action that writes data to an Amazon Kinesis Firehose stream.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch
.static FirehoseAction.Builder
builder()
final String
The delivery stream name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
roleArn()
The IAM role that grants access to the Amazon Kinesis Firehose stream.final String
A character separator that will be used to separate records written to the Firehose stream.static Class
<? extends FirehoseAction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The delivery stream name.
- Returns:
- The delivery stream name.
-
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
Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
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 isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FirehoseAction.Builder,
FirehoseAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-