@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()
If true, the event source mapping is active.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
eventSourceArn()
The Amazon Resource Name (ARN) of the event source.
|
String |
functionName()
The name of the Lambda function.
|
List<FunctionResponseType> |
functionResponseTypes()
(Streams) A list of current response type enums applied to the event source mapping.
|
List<String> |
functionResponseTypesAsStrings()
(Streams) A list of current response type enums applied to the event source mapping.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasFunctionResponseTypes()
Returns true if the FunctionResponseTypes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasQueues()
Returns true if the Queues property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasSourceAccessConfigurations()
Returns true if the SourceAccessConfigurations property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
boolean |
hasTopics()
Returns true if the Topics property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
Integer |
maximumBatchingWindowInSeconds()
(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in
seconds.
|
Integer |
maximumRecordAgeInSeconds()
(Streams) Discard records older than the specified age.
|
Integer |
maximumRetryAttempts()
(Streams) Discard records after the specified number of retries.
|
Integer |
parallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
|
List<String> |
queues()
(MQ) The name of the Amazon MQ broker destination queue to consume.
|
List<SdkField<?>> |
sdkFields() |
SelfManagedEventSource |
selfManagedEventSource()
The Self-Managed Apache Kafka cluster to send records.
|
static Class<? extends CreateEventSourceMappingRequest.Builder> |
serializableBuilderClass() |
List<SourceAccessConfiguration> |
sourceAccessConfigurations()
An array of the authentication protocol, or the VPC components to secure your event source.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
List<String> |
topics()
The name of the Kafka topic.
|
String |
toString()
Returns a string representation of this object.
|
Integer |
tumblingWindowInSeconds()
(Streams) The duration in seconds of a processing window.
|
overrideConfiguration
copy
public final 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.
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 final 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 final Boolean enabled()
If true, the event source mapping is active. Set to false to pause polling and invocation.
public final 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. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
Self-Managed 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. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
Self-Managed Apache Kafka - Default 100. Max 10,000.
public final Integer maximumBatchingWindowInSeconds()
(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.
public final Integer parallelizationFactor()
(Streams) The number of batches to process from each shard concurrently.
public final 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.
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 final String startingPositionAsString()
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.
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 final 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 final DestinationConfig destinationConfig()
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
public final Integer maximumRecordAgeInSeconds()
(Streams) Discard records older than the specified age. The default value is infinite (-1).
public final Boolean bisectBatchOnFunctionError()
(Streams) If the function returns an error, split the batch in two and retry.
public final 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.
public final Integer tumblingWindowInSeconds()
(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
public final boolean hasTopics()
public final List<String> topics()
The name of the Kafka topic.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTopics()
to see if a value was sent in this field.
public final boolean hasQueues()
public final List<String> queues()
(MQ) The name of the Amazon MQ broker destination queue to consume.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasQueues()
to see if a value was sent in this field.
public final boolean hasSourceAccessConfigurations()
public final List<SourceAccessConfiguration> sourceAccessConfigurations()
An array of the authentication protocol, or the VPC components to secure your event source.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSourceAccessConfigurations()
to see if a value was sent in this field.
public final SelfManagedEventSource selfManagedEventSource()
The Self-Managed Apache Kafka cluster to send records.
public final List<FunctionResponseType> functionResponseTypes()
(Streams) A list of current response type enums applied to the event source mapping.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFunctionResponseTypes()
to see if a value was sent in this field.
public final boolean hasFunctionResponseTypes()
public final List<String> functionResponseTypesAsStrings()
(Streams) A list of current response type enums applied to the event source mapping.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFunctionResponseTypes()
to see if a value was sent in this field.
public CreateEventSourceMappingRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
toBuilder
in class LambdaRequest
public static CreateEventSourceMappingRequest.Builder builder()
public static Class<? extends CreateEventSourceMappingRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.