Class BufferingHints
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BufferingHints.Builder
builder()
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 Integer
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.static Class
<? extends BufferingHints.Builder> final Integer
Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.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
-
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
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
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<BufferingHints.Builder,
BufferingHints> - 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
-