EventSourceMappingConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.lambda.model.EventSourceMappingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class EventSourceMappingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>
```
A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EventSourceMappingConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EventSourceMappingConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`batchSize()` The maximum number of items to retrieve in a single batch.
`Boolean`	`bisectBatchOnFunctionError()` (Streams only) If the function returns an error, split the batch in two and retry.
`static EventSourceMappingConfiguration.Builder`	`builder()`
`DestinationConfig`	`destinationConfig()` (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventSourceArn()` The Amazon Resource Name (ARN) of the event source.
`String`	`functionArn()` The ARN of the Lambda function.
`List<FunctionResponseType>`	`functionResponseTypes()` (Streams only) A list of current response type enums applied to the event source mapping.
`List<String>`	`functionResponseTypesAsStrings()` (Streams only) A list of current response type enums applied to the event source mapping.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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).
`Instant`	`lastModified()` The date that the event source mapping was last updated or that its state changed.
`String`	`lastProcessingResult()` The result of the last Lambda invocation of your function.
`Integer`	`maximumBatchingWindowInSeconds()` (Streams and Amazon SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.
`Integer`	`maximumRecordAgeInSeconds()` (Streams only) Discard records older than the specified age.
`Integer`	`maximumRetryAttempts()` (Streams only) Discard records after the specified number of retries.
`Integer`	`parallelizationFactor()` (Streams only) The number of batches to process concurrently from each shard.
`List<String>`	`queues()` (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
`List<SdkField<?>>`	`sdkFields()`
`SelfManagedEventSource`	`selfManagedEventSource()` The self-managed Apache Kafka cluster for your event source.
`static Class<? extends EventSourceMappingConfiguration.Builder>`	`serializableBuilderClass()`
`List<SourceAccessConfiguration>`	`sourceAccessConfigurations()` An array of the authentication protocol, VPC components, or virtual host to secure and define 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.
`String`	`state()` The state of the event source mapping.
`String`	`stateTransitionReason()` Indicates whether a user or Lambda made the last change to the event source mapping.
`EventSourceMappingConfiguration.Builder`	`toBuilder()`
`List<String>`	`topics()` The name of the Kafka topic.
`String`	`toString()` Returns a string representation of this object.
`Integer`	`tumblingWindowInSeconds()` (Streams only) The duration in seconds of a processing window.
`String`	`uuid()` The identifier of the event source mapping.

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
  - uuid
```
public final String uuid()
```
    The identifier of the event source mapping.
    
    Returns:
    
    The identifier of the event source mapping.
  - startingPosition
```
public final EventSourcePosition startingPosition()
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only 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().
    
    Returns:
    
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - startingPositionAsString
```
public final String startingPositionAsString()
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only 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().
    
    Returns:
    
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - startingPositionTimestamp
```
public final Instant startingPositionTimestamp()
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Returns:
    
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
  - batchSize
```
public final Integer batchSize()
```
    The maximum number of items to retrieve in a single batch.
    
    Returns:
    
    The maximum number of items to retrieve in a single batch.
  - maximumBatchingWindowInSeconds
```
public final Integer maximumBatchingWindowInSeconds()
```
    (Streams and Amazon SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
    
    Returns:
    
    (Streams and Amazon SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
  - 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.
  - eventSourceArn
```
public final String eventSourceArn()
```
    The Amazon Resource Name (ARN) of the event source.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the event source.
  - functionArn
```
public final String functionArn()
```
    The ARN of the Lambda function.
    
    Returns:
    
    The ARN of the Lambda function.
  - lastModified
```
public final Instant lastModified()
```
    The date that the event source mapping was last updated or that its state changed.
    
    Returns:
    
    The date that the event source mapping was last updated or that its state changed.
  - lastProcessingResult
```
public final String lastProcessingResult()
```
    The result of the last Lambda invocation of your function.
    
    Returns:
    
    The result of the last Lambda invocation of your function.
  - state
```
public final String state()
```
    The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating , or Deleting.
    
    Returns:
    
    The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
  - stateTransitionReason
```
public final String stateTransitionReason()
```
    Indicates whether a user or Lambda made the last change to the event source mapping.
    
    Returns:
    
    Indicates whether a user or Lambda made the last change to the event source mapping.
  - destinationConfig
```
public final DestinationConfig destinationConfig()
```
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Returns:
    
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - hasTopics
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - topics
```
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.
    
    Returns:
    
    The name of the Kafka topic.
  - hasQueues
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - queues
```
public final List<String> queues()
```
    (Amazon 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.
    
    Returns:
    
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
  - hasSourceAccessConfigurations
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - sourceAccessConfigurations
```
public final List<SourceAccessConfiguration> sourceAccessConfigurations()
```
    An array of the authentication protocol, VPC components, or virtual host to secure and define 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.
    
    Returns:
    
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
  - selfManagedEventSource
```
public final SelfManagedEventSource selfManagedEventSource()
```
    The self-managed Apache Kafka cluster for your event source.
    
    Returns:
    
    The self-managed Apache Kafka cluster for your event source.
  - 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, Lambda 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, Lambda never discards old records.
  - bisectBatchOnFunctionError
```
public final Boolean bisectBatchOnFunctionError()
```
    (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    
    Returns:
    
    (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
  - 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, Lambda 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, Lambda retries failed records until the record expires in the event source.
  - tumblingWindowInSeconds
```
public final Integer tumblingWindowInSeconds()
```
    (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
    
    Returns:
    
    (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
  - functionResponseTypes
```
public final List<FunctionResponseType> functionResponseTypes()
```
    (Streams only) 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.
    
    Returns:
    
    (Streams only) A list of current response type enums applied to the event source mapping.
  - hasFunctionResponseTypes
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - functionResponseTypesAsStrings
```
public final List<String> functionResponseTypesAsStrings()
```
    (Streams only) 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.
    
    Returns:
    
    (Streams only) A list of current response type enums applied to the event source mapping.
  - toBuilder
```
public EventSourceMappingConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>
  - builder
```
public static EventSourceMappingConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EventSourceMappingConfiguration.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

Class EventSourceMappingConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

uuid

startingPosition

startingPositionAsString

startingPositionTimestamp

batchSize

maximumBatchingWindowInSeconds

parallelizationFactor

eventSourceArn

functionArn

lastModified

lastProcessingResult

state

stateTransitionReason

destinationConfig

hasTopics

topics

hasQueues

queues

hasSourceAccessConfigurations

sourceAccessConfigurations

selfManagedEventSource

maximumRecordAgeInSeconds

bisectBatchOnFunctionError

maximumRetryAttempts

tumblingWindowInSeconds

functionResponseTypes

hasFunctionResponseTypes

functionResponseTypesAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields