@Generated(value="software.amazon.awssdk:codegen") public final class UpdateEventSourceMappingResponse extends LambdaResponse implements ToCopyableBuilder<UpdateEventSourceMappingResponse.Builder,UpdateEventSourceMappingResponse>
A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateEventSourceMappingResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AmazonManagedKafkaEventSourceConfig |
amazonManagedKafkaEventSourceConfig()
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
Integer |
batchSize()
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your
function.
|
Boolean |
bisectBatchOnFunctionError()
(Streams only) If the function returns an error, split the batch in two and retry.
|
static UpdateEventSourceMappingResponse.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.
|
FilterCriteria |
filterCriteria()
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process
an event.
|
String |
functionArn()
The ARN of the Lambda function.
|
List<FunctionResponseType> |
functionResponseTypes()
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
|
List<String> |
functionResponseTypesAsStrings()
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFunctionResponseTypes()
For responses, this returns true if the service returned a value for the FunctionResponseTypes property.
|
int |
hashCode() |
boolean |
hasQueues()
For responses, this returns true if the service returned a value for the Queues property.
|
boolean |
hasSourceAccessConfigurations()
For responses, this returns true if the service returned a value for the SourceAccessConfigurations property.
|
boolean |
hasTopics()
For responses, this returns true if the service returned a value for the Topics property.
|
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, in seconds, that Lambda spends gathering
records before invoking the function.
|
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.
|
SelfManagedKafkaEventSourceConfig |
selfManagedKafkaEventSourceConfig()
Specific configuration settings for a self-managed Apache Kafka event source.
|
static Class<? extends UpdateEventSourceMappingResponse.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.
|
UpdateEventSourceMappingResponse.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.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String uuid()
The identifier of the event source mapping.
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()
.
AT_TIMESTAMP
is supported only 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 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()
.
AT_TIMESTAMP
is supported only 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 Integer batchSize()
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
public final Integer maximumBatchingWindowInSeconds()
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
public final Integer parallelizationFactor()
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
public final String eventSourceArn()
The Amazon Resource Name (ARN) of the event source.
public final FilterCriteria filterCriteria()
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
public final String functionArn()
The ARN of the Lambda function.
public final Instant lastModified()
The date that the event source mapping was last updated or that its state changed.
public final String lastProcessingResult()
The result of the last Lambda invocation of your function.
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
.
Creating
,
Enabling
, Enabled
, Disabling
, Disabled
,
Updating
, or Deleting
.public final String stateTransitionReason()
Indicates whether a user or Lambda made the last change to the event source mapping.
public final DestinationConfig destinationConfig()
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
public final boolean hasTopics()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTopics()
method.
public final boolean hasQueues()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasQueues()
method.
public final boolean hasSourceAccessConfigurations()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSourceAccessConfigurations()
method.
public final SelfManagedEventSource selfManagedEventSource()
The self-managed Apache Kafka cluster for your event source.
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.
public final Boolean bisectBatchOnFunctionError()
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
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.
public final Integer tumblingWindowInSeconds()
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
public final List<FunctionResponseType> functionResponseTypes()
(Streams and Amazon SQS) 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFunctionResponseTypes()
method.
public final boolean hasFunctionResponseTypes()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> functionResponseTypesAsStrings()
(Streams and Amazon SQS) 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFunctionResponseTypes()
method.
public final AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig()
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
public final SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig()
Specific configuration settings for a self-managed Apache Kafka event source.
public UpdateEventSourceMappingResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<UpdateEventSourceMappingResponse.Builder,UpdateEventSourceMappingResponse>
toBuilder
in class AwsResponse
public static UpdateEventSourceMappingResponse.Builder builder()
public static Class<? extends UpdateEventSourceMappingResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2022. All rights reserved.