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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<FirehoseAction.Builder,FirehoseAction>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.