@Generated(value="software.amazon.awssdk:codegen") public final class CreateEventSourceMappingRequest extends LambdaRequest implements ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateEventSourceMappingRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
batchSize()
The maximum number of items to retrieve in a single batch.
|
Boolean |
bisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
|
static CreateEventSourceMappingRequest.Builder |
builder() |
DestinationConfig |
destinationConfig()
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
|
Boolean |
enabled()
Disables the event source mapping to pause polling and invocation.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
eventSourceArn()
The Amazon Resource Name (ARN) of the event source.
|
String |
functionName()
The name of the Lambda function.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
maximumBatchingWindowInSeconds()
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
|
Integer |
maximumRecordAgeInSeconds()
(Streams) The maximum age of a record that Lambda sends to a function for processing.
|
Integer |
maximumRetryAttempts()
(Streams) The maximum number of times to retry when the function returns an error.
|
Integer |
parallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateEventSourceMappingRequest.Builder> |
serializableBuilderClass() |
EventSourcePosition |
startingPosition()
The position in a stream from which to start reading.
|
String |
startingPositionAsString()
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. |
CreateEventSourceMappingRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String eventSourceArn()
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
public String functionName()
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
public Boolean enabled()
Disables the event source mapping to pause polling and invocation.
public Integer batchSize()
The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
public Integer maximumBatchingWindowInSeconds()
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
public Integer parallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
public EventSourcePosition startingPosition()
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
If the service returns an enum value that is not available in the current SDK version, startingPosition
will return EventSourcePosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from startingPositionAsString()
.
AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public String startingPositionAsString()
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
If the service returns an enum value that is not available in the current SDK version, startingPosition
will return EventSourcePosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from startingPositionAsString()
.
AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public Instant startingPositionTimestamp()
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPosition
set to AT_TIMESTAMP
, the time from which to start
reading.public DestinationConfig destinationConfig()
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
public Integer maximumRecordAgeInSeconds()
(Streams) The maximum age of a record that Lambda sends to a function for processing.
public Boolean bisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
public Integer maximumRetryAttempts()
(Streams) The maximum number of times to retry when the function returns an error.
public CreateEventSourceMappingRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
toBuilder
in class LambdaRequest
public static CreateEventSourceMappingRequest.Builder builder()
public static Class<? extends CreateEventSourceMappingRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2020. All rights reserved.