@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEventSourceMappingRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEventSourceMappingRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getBatchSize()
The maximum number of items to retrieve in a single batch.
|
Boolean |
getBisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
|
DestinationConfig |
getDestinationConfig()
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
|
Boolean |
getEnabled()
If true, the event source mapping is active.
|
String |
getEventSourceArn()
The Amazon Resource Name (ARN) of the event source.
|
String |
getFunctionName()
The name of the Lambda function.
|
Integer |
getMaximumBatchingWindowInSeconds()
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
|
Integer |
getMaximumRecordAgeInSeconds()
(Streams) Discard records older than the specified age.
|
Integer |
getMaximumRetryAttempts()
(Streams) Discard records after the specified number of retries.
|
Integer |
getParallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
|
String |
getStartingPosition()
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. |
List<String> |
getTopics()
(MSK) The name of the Kafka topic.
|
int |
hashCode() |
Boolean |
isBisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
|
Boolean |
isEnabled()
If true, the event source mapping is active.
|
void |
setBatchSize(Integer batchSize)
The maximum number of items to retrieve in a single batch.
|
void |
setBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Streams) If the function returns an error, split the batch in two and retry.
|
void |
setDestinationConfig(DestinationConfig destinationConfig)
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
|
void |
setEnabled(Boolean enabled)
If true, the event source mapping is active.
|
void |
setEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
|
void |
setFunctionName(String functionName)
The name of the Lambda function.
|
void |
setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
|
void |
setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Streams) Discard records older than the specified age.
|
void |
setMaximumRetryAttempts(Integer maximumRetryAttempts)
(Streams) Discard records after the specified number of retries.
|
void |
setParallelizationFactor(Integer parallelizationFactor)
(Streams) The number of batches to process from each shard concurrently.
|
void |
setStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading.
|
void |
setStartingPosition(String startingPosition)
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. |
void |
setTopics(Collection<String> topics)
(MSK) The name of the Kafka topic.
|
String |
toString()
Returns a string representation of this object.
|
CreateEventSourceMappingRequest |
withBatchSize(Integer batchSize)
The maximum number of items to retrieve in a single batch.
|
CreateEventSourceMappingRequest |
withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Streams) If the function returns an error, split the batch in two and retry.
|
CreateEventSourceMappingRequest |
withDestinationConfig(DestinationConfig destinationConfig)
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
|
CreateEventSourceMappingRequest |
withEnabled(Boolean enabled)
If true, the event source mapping is active.
|
CreateEventSourceMappingRequest |
withEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
|
CreateEventSourceMappingRequest |
withFunctionName(String functionName)
The name of the Lambda function.
|
CreateEventSourceMappingRequest |
withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
|
CreateEventSourceMappingRequest |
withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Streams) Discard records older than the specified age.
|
CreateEventSourceMappingRequest |
withMaximumRetryAttempts(Integer maximumRetryAttempts)
(Streams) Discard records after the specified number of retries.
|
CreateEventSourceMappingRequest |
withParallelizationFactor(Integer parallelizationFactor)
(Streams) The number of batches to process from each shard concurrently.
|
CreateEventSourceMappingRequest |
withStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading.
|
CreateEventSourceMappingRequest |
withStartingPosition(String startingPosition)
The position in a stream from which to start reading.
|
CreateEventSourceMappingRequest |
withStartingPositionTimestamp(Date startingPositionTimestamp)
With
StartingPosition set to AT_TIMESTAMP , the time from which to start reading. |
CreateEventSourceMappingRequest |
withTopics(Collection<String> topics)
(MSK) The name of the Kafka topic.
|
CreateEventSourceMappingRequest |
withTopics(String... topics)
(MSK) The name of the Kafka topic.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setEventSourceArn(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 Managed Streaming for Apache Kafka - The ARN of the cluster.
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 Managed Streaming for Apache Kafka - The ARN of the cluster.
public String getEventSourceArn()
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 Managed Streaming for Apache Kafka - The ARN of the cluster.
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 Managed Streaming for Apache Kafka - The ARN of the cluster.
public CreateEventSourceMappingRequest withEventSourceArn(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 Managed Streaming for Apache Kafka - The ARN of the cluster.
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 Managed Streaming for Apache Kafka - The ARN of the cluster.
public void setFunctionName(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.
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.
public String getFunctionName()
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 CreateEventSourceMappingRequest withFunctionName(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.
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.
public void setEnabled(Boolean enabled)
If true, the event source mapping is active. Set to false to pause polling and invocation.
enabled
- If true, the event source mapping is active. Set to false to pause polling and invocation.public Boolean getEnabled()
If true, the event source mapping is active. Set to false to pause polling and invocation.
public CreateEventSourceMappingRequest withEnabled(Boolean enabled)
If true, the event source mapping is active. Set to false to pause polling and invocation.
enabled
- If true, the event source mapping is active. Set to false to pause polling and invocation.public Boolean isEnabled()
If true, the event source mapping is active. Set to false to pause polling and invocation.
public void setBatchSize(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 Managed Streaming for Apache Kafka - Default 100. Max 10,000.
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 Managed Streaming for Apache Kafka - Default 100. Max 10,000.
public Integer getBatchSize()
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 Managed Streaming for Apache Kafka - Default 100. Max 10,000.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
public CreateEventSourceMappingRequest withBatchSize(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 Managed Streaming for Apache Kafka - Default 100. Max 10,000.
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 Managed Streaming for Apache Kafka - Default 100. Max 10,000.
public void setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
maximumBatchingWindowInSeconds
- (Streams) The maximum amount of time to gather records before invoking the function, in seconds.public Integer getMaximumBatchingWindowInSeconds()
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
public CreateEventSourceMappingRequest withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
maximumBatchingWindowInSeconds
- (Streams) The maximum amount of time to gather records before invoking the function, in seconds.public void setParallelizationFactor(Integer parallelizationFactor)
(Streams) The number of batches to process from each shard concurrently.
parallelizationFactor
- (Streams) The number of batches to process from each shard concurrently.public Integer getParallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
public CreateEventSourceMappingRequest withParallelizationFactor(Integer parallelizationFactor)
(Streams) The number of batches to process from each shard concurrently.
parallelizationFactor
- (Streams) The number of batches to process from each shard concurrently.public void setStartingPosition(String startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and
Amazon MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public String getStartingPosition()
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public CreateEventSourceMappingRequest withStartingPosition(String startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and
Amazon MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public void setStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and
Amazon MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public CreateEventSourceMappingRequest withStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and
Amazon MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.EventSourcePosition
public void setStartingPositionTimestamp(Date startingPositionTimestamp)
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
startingPositionTimestamp
- With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.public Date getStartingPositionTimestamp()
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 CreateEventSourceMappingRequest withStartingPositionTimestamp(Date startingPositionTimestamp)
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
startingPositionTimestamp
- With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.public void setDestinationConfig(DestinationConfig destinationConfig)
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
destinationConfig
- (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.public DestinationConfig getDestinationConfig()
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
public CreateEventSourceMappingRequest withDestinationConfig(DestinationConfig destinationConfig)
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
destinationConfig
- (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.public void setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Streams) Discard records older than the specified age. The default value is infinite (-1).
maximumRecordAgeInSeconds
- (Streams) Discard records older than the specified age. The default value is infinite (-1).public Integer getMaximumRecordAgeInSeconds()
(Streams) Discard records older than the specified age. The default value is infinite (-1).
public CreateEventSourceMappingRequest withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Streams) Discard records older than the specified age. The default value is infinite (-1).
maximumRecordAgeInSeconds
- (Streams) Discard records older than the specified age. The default value is infinite (-1).public void setBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Streams) If the function returns an error, split the batch in two and retry.
bisectBatchOnFunctionError
- (Streams) If the function returns an error, split the batch in two and retry.public Boolean getBisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
public CreateEventSourceMappingRequest withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Streams) If the function returns an error, split the batch in two and retry.
bisectBatchOnFunctionError
- (Streams) If the function returns an error, split the batch in two and retry.public Boolean isBisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
public void setMaximumRetryAttempts(Integer maximumRetryAttempts)
(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
maximumRetryAttempts
- (Streams) Discard records after the specified number of retries. The default value is infinite (-1). When
set to infinite (-1), failed records will be retried until the record expires.public Integer getMaximumRetryAttempts()
(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
public CreateEventSourceMappingRequest withMaximumRetryAttempts(Integer maximumRetryAttempts)
(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
maximumRetryAttempts
- (Streams) Discard records after the specified number of retries. The default value is infinite (-1). When
set to infinite (-1), failed records will be retried until the record expires.public List<String> getTopics()
(MSK) The name of the Kafka topic.
public void setTopics(Collection<String> topics)
(MSK) The name of the Kafka topic.
topics
- (MSK) The name of the Kafka topic.public CreateEventSourceMappingRequest withTopics(String... topics)
(MSK) The name of the Kafka topic.
NOTE: This method appends the values to the existing list (if any). Use
setTopics(java.util.Collection)
or withTopics(java.util.Collection)
if you want to override the
existing values.
topics
- (MSK) The name of the Kafka topic.public CreateEventSourceMappingRequest withTopics(Collection<String> topics)
(MSK) The name of the Kafka topic.
topics
- (MSK) The name of the Kafka topic.public String toString()
toString
in class Object
Object.toString()
public CreateEventSourceMappingRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()