Class UpdatePipeSourceKinesisStreamParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,
UpdatePipeSourceKinesisStreamParameters>
The parameters for using a Kinesis stream as a source.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The maximum number of records to include in each batch.builder()
final DeadLetterConfig
Define the target queue to send dead-letter queue events to.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
The maximum length of a time to wait for events.final Integer
(Streams only) Discard records older than the specified age.final Integer
(Streams only) Discard records after the specified number of retries.(Streams only) Define how to handle item process failures.final String
(Streams only) Define how to handle item process failures.final Integer
(Streams only) The number of batches to process concurrently from each shard.static Class
<? extends UpdatePipeSourceKinesisStreamParameters.Builder> 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
-
batchSize
The maximum number of records to include in each batch.
- Returns:
- The maximum number of records to include in each batch.
-
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
The maximum length of a time to wait for events.
- Returns:
- The maximum length of a time to wait for events.
-
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
(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
(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 returnOnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonPartialBatchItemFailureAsString()
.- 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:
-
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 returnOnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonPartialBatchItemFailureAsString()
.- 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:
-
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.
-
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<UpdatePipeSourceKinesisStreamParameters.Builder,
UpdatePipeSourceKinesisStreamParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdatePipeSourceKinesisStreamParameters.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
-