PipeSourceKinesisStreamParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.model.PipeSourceKinesisStreamParameters

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeSourceKinesisStreamParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

The parameters for using a Kinesis stream as a source.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeSourceKinesisStreamParameters()

Constructors
Constructor and Description
`PipeSourceKinesisStreamParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeSourceKinesisStreamParameters`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBatchSize()` The maximum number of records to include in each batch.
`DeadLetterConfig`	`getDeadLetterConfig()` Define the target queue to send dead-letter queue events to.
`Integer`	`getMaximumBatchingWindowInSeconds()` The maximum length of a time to wait for events.
`Integer`	`getMaximumRecordAgeInSeconds()` (Streams only) Discard records older than the specified age.
`Integer`	`getMaximumRetryAttempts()` (Streams only) Discard records after the specified number of retries.
`String`	`getOnPartialBatchItemFailure()` (Streams only) Define how to handle item process failures.
`Integer`	`getParallelizationFactor()` (Streams only) The number of batches to process concurrently from each shard.
`String`	`getStartingPosition()` (Streams only) The position in a stream from which to start reading.
`Date`	`getStartingPositionTimestamp()` With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchSize(Integer batchSize)` The maximum number of records to include in each batch.
`void`	`setDeadLetterConfig(DeadLetterConfig deadLetterConfig)` Define the target queue to send dead-letter queue events to.
`void`	`setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`void`	`setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)` (Streams only) Discard records older than the specified age.
`void`	`setMaximumRetryAttempts(Integer maximumRetryAttempts)` (Streams only) Discard records after the specified number of retries.
`void`	`setOnPartialBatchItemFailure(String onPartialBatchItemFailure)` (Streams only) Define how to handle item process failures.
`void`	`setParallelizationFactor(Integer parallelizationFactor)` (Streams only) The number of batches to process concurrently from each shard.
`void`	`setStartingPosition(String startingPosition)` (Streams only) The position in a stream from which to start reading.
`void`	`setStartingPositionTimestamp(Date startingPositionTimestamp)` With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds.
`String`	`toString()` Returns a string representation of this object.
`PipeSourceKinesisStreamParameters`	`withBatchSize(Integer batchSize)` The maximum number of records to include in each batch.
`PipeSourceKinesisStreamParameters`	`withDeadLetterConfig(DeadLetterConfig deadLetterConfig)` Define the target queue to send dead-letter queue events to.
`PipeSourceKinesisStreamParameters`	`withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`PipeSourceKinesisStreamParameters`	`withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)` (Streams only) Discard records older than the specified age.
`PipeSourceKinesisStreamParameters`	`withMaximumRetryAttempts(Integer maximumRetryAttempts)` (Streams only) Discard records after the specified number of retries.
`PipeSourceKinesisStreamParameters`	`withOnPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)` (Streams only) Define how to handle item process failures.
`PipeSourceKinesisStreamParameters`	`withOnPartialBatchItemFailure(String onPartialBatchItemFailure)` (Streams only) Define how to handle item process failures.
`PipeSourceKinesisStreamParameters`	`withParallelizationFactor(Integer parallelizationFactor)` (Streams only) The number of batches to process concurrently from each shard.
`PipeSourceKinesisStreamParameters`	`withStartingPosition(KinesisStreamStartPosition startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceKinesisStreamParameters`	`withStartingPosition(String startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceKinesisStreamParameters`	`withStartingPositionTimestamp(Date startingPositionTimestamp)` With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds.

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

- Constructor Detail
  - PipeSourceKinesisStreamParameters
```
public PipeSourceKinesisStreamParameters()
```
- Method Detail
  - setBatchSize
```
public void setBatchSize(Integer batchSize)
```
    The maximum number of records to include in each batch.
    
    Parameters:
    
    batchSize - The maximum number of records to include in each batch.
  - getBatchSize
```
public Integer getBatchSize()
```
    The maximum number of records to include in each batch.
    
    Returns:
    
    The maximum number of records to include in each batch.
  - withBatchSize
```
public PipeSourceKinesisStreamParameters withBatchSize(Integer batchSize)
```
    The maximum number of records to include in each batch.
    
    Parameters:
    
    batchSize - The maximum number of records to include in each batch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeadLetterConfig
```
public void setDeadLetterConfig(DeadLetterConfig deadLetterConfig)
```
    Define the target queue to send dead-letter queue events to.
    
    Parameters:
    
    deadLetterConfig - Define the target queue to send dead-letter queue events to.
  - getDeadLetterConfig
```
public DeadLetterConfig getDeadLetterConfig()
```
    Define the target queue to send dead-letter queue events to.
    
    Returns:
    
    Define the target queue to send dead-letter queue events to.
  - withDeadLetterConfig
```
public PipeSourceKinesisStreamParameters withDeadLetterConfig(DeadLetterConfig deadLetterConfig)
```
    Define the target queue to send dead-letter queue events to.
    
    Parameters:
    
    deadLetterConfig - Define the target queue to send dead-letter queue events to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOnPartialBatchItemFailure
```
public void setOnPartialBatchItemFailure(String onPartialBatchItemFailure)
```
    (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Parameters:
    
    onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    See Also:
    
    OnPartialBatchItemFailureStreams
  - getOnPartialBatchItemFailure
```
public String getOnPartialBatchItemFailure()
```
    (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Returns:
    
    (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    See Also:
    
    OnPartialBatchItemFailureStreams
  - withOnPartialBatchItemFailure
```
public PipeSourceKinesisStreamParameters withOnPartialBatchItemFailure(String onPartialBatchItemFailure)
```
    (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Parameters:
    
    onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OnPartialBatchItemFailureStreams
  - withOnPartialBatchItemFailure
```
public PipeSourceKinesisStreamParameters withOnPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)
```
    (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Parameters:
    
    onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OnPartialBatchItemFailureStreams
  - setMaximumBatchingWindowInSeconds
```
public void setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
```
    The maximum length of a time to wait for events.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
  - getMaximumBatchingWindowInSeconds
```
public Integer getMaximumBatchingWindowInSeconds()
```
    The maximum length of a time to wait for events.
    
    Returns:
    
    The maximum length of a time to wait for events.
  - withMaximumBatchingWindowInSeconds
```
public PipeSourceKinesisStreamParameters withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
```
    The maximum length of a time to wait for events.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumRecordAgeInSeconds
```
public void setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
```
    (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
    
    Parameters:
    
    maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
  - getMaximumRecordAgeInSeconds
```
public Integer getMaximumRecordAgeInSeconds()
```
    (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
    
    Returns:
    
    (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
  - withMaximumRecordAgeInSeconds
```
public PipeSourceKinesisStreamParameters withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
```
    (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
    
    Parameters:
    
    maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumRetryAttempts
```
public void setMaximumRetryAttempts(Integer maximumRetryAttempts)
```
    (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
    
    Parameters:
    
    maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
  - getMaximumRetryAttempts
```
public Integer getMaximumRetryAttempts()
```
    (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
    
    Returns:
    
    (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
  - withMaximumRetryAttempts
```
public PipeSourceKinesisStreamParameters withMaximumRetryAttempts(Integer maximumRetryAttempts)
```
    (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
    
    Parameters:
    
    maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParallelizationFactor
```
public void setParallelizationFactor(Integer parallelizationFactor)
```
    (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    
    Parameters:
    
    parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
  - getParallelizationFactor
```
public Integer getParallelizationFactor()
```
    (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    
    Returns:
    
    (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
  - withParallelizationFactor
```
public PipeSourceKinesisStreamParameters withParallelizationFactor(Integer parallelizationFactor)
```
    (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    
    Parameters:
    
    parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartingPosition
```
public void setStartingPosition(String startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    See Also:
    
    KinesisStreamStartPosition
  - getStartingPosition
```
public String getStartingPosition()
```
    (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    (Streams only) The position in a stream from which to start reading.
    
    See Also:
    
    KinesisStreamStartPosition
  - withStartingPosition
```
public PipeSourceKinesisStreamParameters withStartingPosition(String startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KinesisStreamStartPosition
  - withStartingPosition
```
public PipeSourceKinesisStreamParameters withStartingPosition(KinesisStreamStartPosition startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KinesisStreamStartPosition
  - setStartingPositionTimestamp
```
public void setStartingPositionTimestamp(Date startingPositionTimestamp)
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
    
    Parameters:
    
    startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
  - getStartingPositionTimestamp
```
public Date getStartingPositionTimestamp()
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
    
    Returns:
    
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
  - withStartingPositionTimestamp
```
public PipeSourceKinesisStreamParameters withStartingPositionTimestamp(Date startingPositionTimestamp)
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
    
    Parameters:
    
    startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
    
    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 PipeSourceKinesisStreamParameters 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class PipeSourceKinesisStreamParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeSourceKinesisStreamParameters

Method Detail

setBatchSize

getBatchSize

withBatchSize

setDeadLetterConfig

getDeadLetterConfig

withDeadLetterConfig

setOnPartialBatchItemFailure

getOnPartialBatchItemFailure

withOnPartialBatchItemFailure

withOnPartialBatchItemFailure

setMaximumBatchingWindowInSeconds

getMaximumBatchingWindowInSeconds

withMaximumBatchingWindowInSeconds

setMaximumRecordAgeInSeconds

getMaximumRecordAgeInSeconds

withMaximumRecordAgeInSeconds

setMaximumRetryAttempts

getMaximumRetryAttempts

withMaximumRetryAttempts

setParallelizationFactor

getParallelizationFactor

withParallelizationFactor

setStartingPosition

getStartingPosition

withStartingPosition

withStartingPosition

setStartingPositionTimestamp

getStartingPositionTimestamp

withStartingPositionTimestamp

toString

equals

hashCode

clone

marshall