com.amazonaws.services.s3control.model.LambdaInvokeOperation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.s3control.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Contains the configuration parameters for a Lambda Invoke operation.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LambdaInvokeOperation implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the
* manifest.
*
*/
private String functionArn;
/**
*
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to
* invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For
* more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*
*/
private String invocationSchemaVersion;
/**
*
* Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You
* must specify InvocationSchemaVersion 2.0 for LambdaInvoke operations that
* include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*
*/
private java.util.Map userArguments;
/**
*
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the
* manifest.
*
*
* @param functionArn
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object
* in the manifest.
*/
public void setFunctionArn(String functionArn) {
this.functionArn = functionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the
* manifest.
*
*
* @return The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object
* in the manifest.
*/
public String getFunctionArn() {
return this.functionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the
* manifest.
*
*
* @param functionArn
* The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object
* in the manifest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LambdaInvokeOperation withFunctionArn(String functionArn) {
setFunctionArn(functionArn);
return this;
}
/**
*
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to
* invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For
* more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*
*
* @param invocationSchemaVersion
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch
* Operations to invoke Lambda functions that act on directory buckets, or if you need to specify
* UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*/
public void setInvocationSchemaVersion(String invocationSchemaVersion) {
this.invocationSchemaVersion = invocationSchemaVersion;
}
/**
*
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to
* invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For
* more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*
*
* @return Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda
* function. Version 1.0 is the default. Version 2.0 is required when you use
* Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify
* UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*/
public String getInvocationSchemaVersion() {
return this.invocationSchemaVersion;
}
/**
*
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to
* invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For
* more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
*
*
* @param invocationSchemaVersion
* Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function.
* Version 1.0 is the default. Version 2.0 is required when you use Batch
* Operations to invoke Lambda functions that act on directory buckets, or if you need to specify
* UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda 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 the InvocationSchemaVersion 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LambdaInvokeOperation withInvocationSchemaVersion(String invocationSchemaVersion) {
setInvocationSchemaVersion(invocationSchemaVersion);
return this;
}
/**
*
* Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You
* must specify InvocationSchemaVersion 2.0 for LambdaInvoke operations that
* include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*
*
* @return Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda
* function. You must specify InvocationSchemaVersion 2.0 for LambdaInvoke
* operations that include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*/
public java.util.Map getUserArguments() {
return 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 for LambdaInvoke operations that
* include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*
*
* @param 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 for LambdaInvoke
* operations that include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*/
public void setUserArguments(java.util.Map userArguments) {
this.userArguments = 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 for LambdaInvoke operations that
* include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
*
*
* @param 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 for LambdaInvoke
* operations that include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the
* Amazon Web Services Storage Blog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LambdaInvokeOperation withUserArguments(java.util.Map userArguments) {
setUserArguments(userArguments);
return this;
}
/**
* Add a single UserArguments entry
*
* @see LambdaInvokeOperation#withUserArguments
* @returns a reference to this object so that method calls can be chained together.
*/
public LambdaInvokeOperation addUserArgumentsEntry(String key, String value) {
if (null == this.userArguments) {
this.userArguments = new java.util.HashMap();
}
if (this.userArguments.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.userArguments.put(key, value);
return this;
}
/**
* Removes all the entries added into UserArguments.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LambdaInvokeOperation clearUserArgumentsEntries() {
this.userArguments = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFunctionArn() != null)
sb.append("FunctionArn: ").append(getFunctionArn()).append(",");
if (getInvocationSchemaVersion() != null)
sb.append("InvocationSchemaVersion: ").append(getInvocationSchemaVersion()).append(",");
if (getUserArguments() != null)
sb.append("UserArguments: ").append(getUserArguments());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LambdaInvokeOperation == false)
return false;
LambdaInvokeOperation other = (LambdaInvokeOperation) obj;
if (other.getFunctionArn() == null ^ this.getFunctionArn() == null)
return false;
if (other.getFunctionArn() != null && other.getFunctionArn().equals(this.getFunctionArn()) == false)
return false;
if (other.getInvocationSchemaVersion() == null ^ this.getInvocationSchemaVersion() == null)
return false;
if (other.getInvocationSchemaVersion() != null && other.getInvocationSchemaVersion().equals(this.getInvocationSchemaVersion()) == false)
return false;
if (other.getUserArguments() == null ^ this.getUserArguments() == null)
return false;
if (other.getUserArguments() != null && other.getUserArguments().equals(this.getUserArguments()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFunctionArn() == null) ? 0 : getFunctionArn().hashCode());
hashCode = prime * hashCode + ((getInvocationSchemaVersion() == null) ? 0 : getInvocationSchemaVersion().hashCode());
hashCode = prime * hashCode + ((getUserArguments() == null) ? 0 : getUserArguments().hashCode());
return hashCode;
}
@Override
public LambdaInvokeOperation clone() {
try {
return (LambdaInvokeOperation) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}