software.amazon.awssdk.services.lambda.model

Class GetEventSourceMappingResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lambda.model.LambdaResponse

software.amazon.awssdk.services.lambda.model.GetEventSourceMappingResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetEventSourceMappingResponse.Builder,GetEventSourceMappingResponse>

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

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetEventSourceMappingResponse.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 GetEventSourceMappingResponse.Builder	builder()
DestinationConfig	destinationConfig() (Streams) 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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 its state changed.
String	lastProcessingResult() The result of the last AWS Lambda invocation of your Lambda function.
Integer	maximumBatchingWindowInSeconds() (Streams) 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()
static Class<? extends GetEventSourceMappingResponse.Builder>	serializableBuilderClass()
List<SourceAccessConfiguration>	sourceAccessConfigurations() (MQ) The Secrets Manager secret that stores your broker credentials.
String	state() The state of the event source mapping.
String	stateTransitionReason() Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
GetEventSourceMappingResponse.Builder	toBuilder()
List<String>	topics() (MSK) The name of the Kafka topic to consume.
String	toString() Returns a string representation of this object.
String	uuid() The identifier of the event source mapping.

Methods inherited from class software.amazon.awssdk.services.lambda.model.LambdaResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 String uuid()

The identifier of the event source mapping.

Returns:

The identifier of the event source mapping.

batchSize

public 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 Integer maximumBatchingWindowInSeconds()

(Streams) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

Returns:

(Streams) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

parallelizationFactor

public Integer parallelizationFactor()

(Streams) The number of batches to process from each shard concurrently. The default value is 1.

Returns:

(Streams) The number of batches to process from each shard concurrently. The default value is 1.

eventSourceArn

public String eventSourceArn()

The Amazon Resource Name (ARN) of the event source.

Returns:

The Amazon Resource Name (ARN) of the event source.

functionArn

public String functionArn()

The ARN of the Lambda function.

Returns:

The ARN of the Lambda function.

lastModified

public Instant lastModified()

The date that the event source mapping was last updated, or its state changed.

Returns:

The date that the event source mapping was last updated, or its state changed.

lastProcessingResult

public String lastProcessingResult()

The result of the last AWS Lambda invocation of your Lambda function.

Returns:

The result of the last AWS Lambda invocation of your Lambda function.

state

public 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 String stateTransitionReason()

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

Returns:

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

destinationConfig

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

hasTopics

public 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 List<String> topics()

(MSK) The name of the Kafka topic to consume.

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:

(MSK) The name of the Kafka topic to consume.

hasQueues

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

Returns:

(MQ) The name of the Amazon MQ broker destination queue to consume.

hasSourceAccessConfigurations

public 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 List<SourceAccessConfiguration> sourceAccessConfigurations()

(MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format: { "username": "your username", "password": "your password" }

To reference the secret, use the following format: [ { "Type": "BASIC_AUTH", "URI": "secretARN" } ]

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

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:

(MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format: { "username": "your username", "password": "your password" }

To reference the secret, use the following format: [ { "Type": "BASIC_AUTH", "URI": "secretARN" } ]

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

maximumRecordAgeInSeconds

public Integer maximumRecordAgeInSeconds()

(Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

Returns:

(Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

bisectBatchOnFunctionError

public Boolean bisectBatchOnFunctionError()

(Streams) If the function returns an error, split the batch in two and retry. The default value is false.

Returns:

(Streams) If the function returns an error, split the batch in two and retry. The default value is false.

maximumRetryAttempts

public Integer maximumRetryAttempts()

(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are 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 are retried until the record expires.

toBuilder

public GetEventSourceMappingResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetEventSourceMappingResponse.Builder,GetEventSourceMappingResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetEventSourceMappingResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo