Class LambdaInvokeOperation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LambdaInvokeOperation.Builder,
LambdaInvokeOperation>
Contains the configuration parameters for a Lambda Invoke
operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the UserArguments property.final String
Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.static Class
<? extends LambdaInvokeOperation.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
functionArn
The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.
- Returns:
- The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.
-
invocationSchemaVersion
Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function. Version
1.0
is the default. Version2.0
is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specifyUserArguments
. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.Ensure that your Lambda function code expects
InvocationSchemaVersion
2.0 and uses bucket name rather than bucket ARN. If theInvocationSchemaVersion
does not match what your Lambda function expects, your function might not work as expected.Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify
2.0
.- Returns:
- Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda
function. Version
1.0
is the default. Version2.0
is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specifyUserArguments
. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.Ensure that your Lambda function code expects
InvocationSchemaVersion
2.0 and uses bucket name rather than bucket ARN. If theInvocationSchemaVersion
does not match what your Lambda function expects, your function might not work as expected.Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify
2.0
.
-
hasUserArguments
public final boolean hasUserArguments()For responses, this returns true if the service returned a value for the UserArguments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
userArguments
Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You must specify
InvocationSchemaVersion
2.0 forLambdaInvoke
operations that includeUserArguments
. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.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
hasUserArguments()
method.- Returns:
- Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda
function. You must specify
InvocationSchemaVersion
2.0 forLambdaInvoke
operations that includeUserArguments
. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.
-
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 interfaceToCopyableBuilder<LambdaInvokeOperation.Builder,
LambdaInvokeOperation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-