BufferingHints (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.BufferingHints

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BufferingHints
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BufferingHints()

Constructors
Constructor and Description
`BufferingHints()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BufferingHints`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getIntervalInSeconds()` Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
`Integer`	`getSizeInMBs()` Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIntervalInSeconds(Integer intervalInSeconds)` Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
`void`	`setSizeInMBs(Integer sizeInMBs)` Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.
`String`	`toString()` Returns a string representation of this object.
`BufferingHints`	`withIntervalInSeconds(Integer intervalInSeconds)` Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
`BufferingHints`	`withSizeInMBs(Integer sizeInMBs)` Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BufferingHints
```
public BufferingHints()
```
- Method Detail
  - setSizeInMBs
```
public void setSizeInMBs(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.
    
    Parameters:
    
    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.
  - getSizeInMBs
```
public Integer getSizeInMBs()
```
    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.
  - withSizeInMBs
```
public BufferingHints withSizeInMBs(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIntervalInSeconds
```
public void setIntervalInSeconds(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.
    
    Parameters:
    
    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.
  - getIntervalInSeconds
```
public Integer getIntervalInSeconds()
```
    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.
  - withIntervalInSeconds
```
public BufferingHints withIntervalInSeconds(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BufferingHints clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BufferingHints

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BufferingHints

Method Detail

setSizeInMBs

getSizeInMBs

withSizeInMBs

setIntervalInSeconds

getIntervalInSeconds

withIntervalInSeconds

toString

equals

hashCode

clone

marshall