Package software.amazon.awssdk.services.firehose.model

Class BufferingHints

java.lang.Object

software.amazon.awssdk.services.firehose.model.BufferingHints

All Implemented Interfaces:

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

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

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BufferingHints.Builder

Method Summary

Modifier and Type	Method	Description
static BufferingHints.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	intervalInSeconds()	Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
List<SdkField<?>>	sdkFields()
static Class<? extends BufferingHints.Builder>	serializableBuilderClass()
Integer	sizeInMBs()	Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.
BufferingHints.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

sizeInMBs

public final Integer sizeInMBs()

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

Returns:

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

intervalInSeconds

public final Integer intervalInSeconds()

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Returns:

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

toBuilder

public BufferingHints.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BufferingHints.Builder,BufferingHints>

builder

public static BufferingHints.Builder builder()

serializableBuilderClass

public static Class<? extends BufferingHints.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