software.amazon.awssdk.services.lambda.model

Class UpdateEventSourceMappingRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lambda.model.LambdaRequest

software.amazon.awssdk.services.lambda.model.UpdateEventSourceMappingRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateEventSourceMappingRequest
extends LambdaRequest
implements ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateEventSourceMappingRequest.Builder

Method Summary

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 UpdateEventSourceMappingRequest.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)
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)
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	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).
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<SdkField<?>>	sdkFields()
static Class<? extends UpdateEventSourceMappingRequest.Builder>	serializableBuilderClass()
List<SourceAccessConfiguration>	sourceAccessConfigurations() An array of the authentication protocol, or the VPC components to secure your event source.
UpdateEventSourceMappingRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	tumblingWindowInSeconds() (Streams) The duration in seconds of a processing window.
String	uuid() The identifier of the event source mapping.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

functionName

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.

Returns:

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.

enabled

public final Boolean enabled()

If true, the event source mapping is active. Set to false to pause polling and invocation.

Returns:

If true, the event source mapping is active. Set to false to pause polling and invocation.

batchSize

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.

Returns:

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.

maximumBatchingWindowInSeconds

public final Integer maximumBatchingWindowInSeconds()

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

Returns:

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

destinationConfig

public final DestinationConfig destinationConfig()

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

maximumRecordAgeInSeconds

public final Integer maximumRecordAgeInSeconds()

(Streams) Discard records older than the specified age. The default value is infinite (-1).

Returns:

(Streams) Discard records older than the specified age. The default value is infinite (-1).

bisectBatchOnFunctionError

public final Boolean bisectBatchOnFunctionError()

(Streams) If the function returns an error, split the batch in two and retry.

Returns:

(Streams) If the function returns an error, split the batch in two and retry.

maximumRetryAttempts

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.

Returns:

(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.

parallelizationFactor

public final Integer parallelizationFactor()

(Streams) The number of batches to process from each shard concurrently.

Returns:

(Streams) The number of batches to process from each shard concurrently.

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, 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.

Returns:

An array of the authentication protocol, or the VPC components to secure your event source.

tumblingWindowInSeconds

public final Integer tumblingWindowInSeconds()

(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

Returns:

(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

functionResponseTypes

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.

Returns:

(Streams) 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) 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) A list of current response type enums applied to the event source mapping.

toBuilder

public UpdateEventSourceMappingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>

Specified by:

toBuilder in class LambdaRequest

builder

public static UpdateEventSourceMappingRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateEventSourceMappingRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo