software.amazon.awssdk.services.lambda.model

Class CreateEventSourceMappingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEventSourceMappingRequest.Builder

Method Summary

Modifier and Type	Method and Description
Integer	batchSize() The maximum number of items to retrieve in a single batch.
static CreateEventSourceMappingRequest.Builder	builder()
Boolean	enabled() Disables the event source mapping to pause polling and invocation.
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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 Unix time in seconds 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.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

eventSourceArn

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.

Returns:

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.

functionName

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.

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 Boolean enabled()

Disables the event source mapping to pause polling and invocation.

Returns:

Disables the event source mapping to pause polling and invocation.

batchSize

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.

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. Max 10.

startingPosition

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

Returns:

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.

See Also:

EventSourcePosition

startingPositionAsString

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

Returns:

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.

See Also:

EventSourcePosition

startingPositionTimestamp

public Instant startingPositionTimestamp()

With StartingPosition set to AT_TIMESTAMP, the Unix time in seconds from which to start reading.

Returns:

With StartingPosition set to AT_TIMESTAMP, the Unix time in seconds from which to start reading.

toBuilder

public CreateEventSourceMappingRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>

Specified by:

toBuilder in class LambdaRequest

Returns:

a builder for type T

builder

public static CreateEventSourceMappingRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.