software.amazon.awssdk.services.pipes.model

Class PipeSourceKinesisStreamParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeSourceKinesisStreamParameters

All Implemented Interfaces:

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

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

The parameters for using a Kinesis stream as a source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipeSourceKinesisStreamParameters.Builder

Method Summary

Modifier and Type	Method and Description
Integer	batchSize() The maximum number of records to include in each batch.
static PipeSourceKinesisStreamParameters.Builder	builder()
DeadLetterConfig	deadLetterConfig() Define the target queue to send dead-letter queue events to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumBatchingWindowInSeconds() The maximum length of a time to wait for events.
Integer	maximumRecordAgeInSeconds() (Streams only) Discard records older than the specified age.
Integer	maximumRetryAttempts() (Streams only) Discard records after the specified number of retries.
OnPartialBatchItemFailureStreams	onPartialBatchItemFailure() (Streams only) Define how to handle item process failures.
String	onPartialBatchItemFailureAsString() (Streams only) Define how to handle item process failures.
Integer	parallelizationFactor() (Streams only) The number of batches to process concurrently from each shard.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeSourceKinesisStreamParameters.Builder>	serializableBuilderClass()
KinesisStreamStartPosition	startingPosition() (Streams only) The position in a stream from which to start reading.
String	startingPositionAsString() (Streams only) The position in a stream from which to start reading.
Instant	startingPositionTimestamp() With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
PipeSourceKinesisStreamParameters.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

batchSize

public final Integer batchSize()

The maximum number of records to include in each batch.

Returns:

The maximum number of records to include in each batch.

deadLetterConfig

public final DeadLetterConfig deadLetterConfig()

Define the target queue to send dead-letter queue events to.

Returns:

Define the target queue to send dead-letter queue events to.

maximumBatchingWindowInSeconds

public final Integer maximumBatchingWindowInSeconds()

The maximum length of a time to wait for events.

Returns:

The maximum length of a time to wait for events.

maximumRecordAgeInSeconds

public final 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.

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.

maximumRetryAttempts

public final 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.

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.

onPartialBatchItemFailure

public final 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.

If the service returns an enum value that is not available in the current SDK version, onPartialBatchItemFailure will return OnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onPartialBatchItemFailureAsString().

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

onPartialBatchItemFailureAsString

public final String onPartialBatchItemFailureAsString()

(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.

If the service returns an enum value that is not available in the current SDK version, onPartialBatchItemFailure will return OnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onPartialBatchItemFailureAsString().

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

parallelizationFactor

public final Integer parallelizationFactor()

(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.

startingPosition

public final KinesisStreamStartPosition startingPosition()

(Streams only) The position in a stream from which to start reading.

If the service returns an enum value that is not available in the current SDK version, startingPosition will return KinesisStreamStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

Returns:

(Streams only) The position in a stream from which to start reading.

See Also:

KinesisStreamStartPosition

startingPositionAsString

public final String startingPositionAsString()

(Streams only) The position in a stream from which to start reading.

If the service returns an enum value that is not available in the current SDK version, startingPosition will return KinesisStreamStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

Returns:

(Streams only) The position in a stream from which to start reading.

See Also:

KinesisStreamStartPosition

startingPositionTimestamp

public final Instant startingPositionTimestamp()

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.

toBuilder

public PipeSourceKinesisStreamParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeSourceKinesisStreamParameters.Builder,PipeSourceKinesisStreamParameters>

builder

public static PipeSourceKinesisStreamParameters.Builder builder()

serializableBuilderClass

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