com.amazonaws.services.lambda.model.CreateEventSourceMappingRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lambda Show documentation
/*
* Copyright 2010-2016 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.lambda.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class CreateEventSourceMappingRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this stream
* could cause AWS Lambda to invoke your Lambda function, it depends on the
* BatchSize. AWS Lambda POSTs the Amazon Kinesis event,
* containing records, to your Lambda function as JSON.
*
*/
private String eventSourceArn;
/**
*
* The Lambda function to invoke when AWS Lambda detects an event on the
* stream.
*
*
* You can specify the function name (for example, Thumbnail)
* or you can specify Amazon Resource Name (ARN) of the function (for
* example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail).
*
*
* If you are using versioning, you can also provide a qualified function
* ARN (ARN that is qualified with function version or alias name as
* suffix). For more information about versioning, see AWS
* Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with the
* account ID qualifier (for example, account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you specify
* only the function name, it is limited to 64 character in length.
*
*/
private String functionName;
/**
*
* Indicates whether AWS Lambda should begin polling the event source. By
* default, Enabled is true.
*
*/
private Boolean enabled;
/**
*
* The largest number of records that AWS Lambda will retrieve from your
* event source at the time of invoking your function. Your function
* receives an event with all the retrieved records. The default is 100
* records.
*
*/
private Integer batchSize;
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*/
private String startingPosition;
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this stream
* could cause AWS Lambda to invoke your Lambda function, it depends on the
* BatchSize. AWS Lambda POSTs the Amazon Kinesis event,
* containing records, to your Lambda function as JSON.
*
*
* @param eventSourceArn
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this
* stream could cause AWS Lambda to invoke your Lambda function, it
* depends on the BatchSize. AWS Lambda POSTs the Amazon
* Kinesis event, containing records, to your Lambda function as
* JSON.
*/
public void setEventSourceArn(String eventSourceArn) {
this.eventSourceArn = eventSourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this stream
* could cause AWS Lambda to invoke your Lambda function, it depends on the
* BatchSize. AWS Lambda POSTs the Amazon Kinesis event,
* containing records, to your Lambda function as JSON.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Kinesis or the
* Amazon DynamoDB stream that is the event source. Any record added
* to this stream could cause AWS Lambda to invoke your Lambda
* function, it depends on the BatchSize. AWS Lambda
* POSTs the Amazon Kinesis event, containing records, to your
* Lambda function as JSON.
*/
public String getEventSourceArn() {
return this.eventSourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this stream
* could cause AWS Lambda to invoke your Lambda function, it depends on the
* BatchSize. AWS Lambda POSTs the Amazon Kinesis event,
* containing records, to your Lambda function as JSON.
*
*
* @param eventSourceArn
* The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
* DynamoDB stream that is the event source. Any record added to this
* stream could cause AWS Lambda to invoke your Lambda function, it
* depends on the BatchSize. AWS Lambda POSTs the Amazon
* Kinesis event, containing records, to your Lambda function as
* JSON.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateEventSourceMappingRequest withEventSourceArn(
String eventSourceArn) {
setEventSourceArn(eventSourceArn);
return this;
}
/**
*
* The Lambda function to invoke when AWS Lambda detects an event on the
* stream.
*
*
* You can specify the function name (for example, Thumbnail)
* or you can specify Amazon Resource Name (ARN) of the function (for
* example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail).
*
*
* If you are using versioning, you can also provide a qualified function
* ARN (ARN that is qualified with function version or alias name as
* suffix). For more information about versioning, see AWS
* Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with the
* account ID qualifier (for example, account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you specify
* only the function name, it is limited to 64 character in length.
*
*
* @param functionName
* The Lambda function to invoke when AWS Lambda detects an event on
* the stream.
*
* You can specify the function name (for example,
* Thumbnail) or you can specify Amazon Resource Name
* (ARN) of the function (for example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail
* ).
*
*
* If you are using versioning, you can also provide a qualified
* function ARN (ARN that is qualified with function version or alias
* name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with
* the account ID qualifier (for example,
* account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you
* specify only the function name, it is limited to 64 character in
* length.
*/
public void setFunctionName(String functionName) {
this.functionName = functionName;
}
/**
*
* The Lambda function to invoke when AWS Lambda detects an event on the
* stream.
*
*
* You can specify the function name (for example, Thumbnail)
* or you can specify Amazon Resource Name (ARN) of the function (for
* example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail).
*
*
* If you are using versioning, you can also provide a qualified function
* ARN (ARN that is qualified with function version or alias name as
* suffix). For more information about versioning, see AWS
* Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with the
* account ID qualifier (for example, account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you specify
* only the function name, it is limited to 64 character in length.
*
*
* @return The Lambda function to invoke when AWS Lambda detects an event on
* the stream.
*
* You can specify the function name (for example,
* Thumbnail) or you can specify Amazon Resource Name
* (ARN) of the function (for example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail
* ).
*
*
* If you are using versioning, you can also provide a qualified
* function ARN (ARN that is qualified with function version or
* alias name as suffix). For more information about versioning, see
* AWS Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with
* the account ID qualifier (for example,
* account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you
* specify only the function name, it is limited to 64 character in
* length.
*/
public String getFunctionName() {
return this.functionName;
}
/**
*
* The Lambda function to invoke when AWS Lambda detects an event on the
* stream.
*
*
* You can specify the function name (for example, Thumbnail)
* or you can specify Amazon Resource Name (ARN) of the function (for
* example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail).
*
*
* If you are using versioning, you can also provide a qualified function
* ARN (ARN that is qualified with function version or alias name as
* suffix). For more information about versioning, see AWS
* Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with the
* account ID qualifier (for example, account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you specify
* only the function name, it is limited to 64 character in length.
*
*
* @param functionName
* The Lambda function to invoke when AWS Lambda detects an event on
* the stream.
*
* You can specify the function name (for example,
* Thumbnail) or you can specify Amazon Resource Name
* (ARN) of the function (for example,
* arn:aws:lambda:us-west-2:account-id:function:ThumbNail
* ).
*
*
* If you are using versioning, you can also provide a qualified
* function ARN (ARN that is qualified with function version or alias
* name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
*
*
* AWS Lambda also allows you to specify only the function name with
* the account ID qualifier (for example,
* account-id:Thumbnail).
*
*
* Note that the length constraint applies only to the ARN. If you
* specify only the function name, it is limited to 64 character in
* length.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateEventSourceMappingRequest withFunctionName(String functionName) {
setFunctionName(functionName);
return this;
}
/**
*
* Indicates whether AWS Lambda should begin polling the event source. By
* default, Enabled is true.
*
*
* @param enabled
* Indicates whether AWS Lambda should begin polling the event
* source. By default, Enabled is true.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* Indicates whether AWS Lambda should begin polling the event source. By
* default, Enabled is true.
*
*
* @return Indicates whether AWS Lambda should begin polling the event
* source. By default, Enabled is true.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* Indicates whether AWS Lambda should begin polling the event source. By
* default, Enabled is true.
*
*
* @param enabled
* Indicates whether AWS Lambda should begin polling the event
* source. By default, Enabled is true.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateEventSourceMappingRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* Indicates whether AWS Lambda should begin polling the event source. By
* default, Enabled is true.
*
*
* @return Indicates whether AWS Lambda should begin polling the event
* source. By default, Enabled is true.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* The largest number of records that AWS Lambda will retrieve from your
* event source at the time of invoking your function. Your function
* receives an event with all the retrieved records. The default is 100
* records.
*
*
* @param batchSize
* The largest number of records that AWS Lambda will retrieve from
* your event source at the time of invoking your function. Your
* function receives an event with all the retrieved records. The
* default is 100 records.
*/
public void setBatchSize(Integer batchSize) {
this.batchSize = batchSize;
}
/**
*
* The largest number of records that AWS Lambda will retrieve from your
* event source at the time of invoking your function. Your function
* receives an event with all the retrieved records. The default is 100
* records.
*
*
* @return The largest number of records that AWS Lambda will retrieve from
* your event source at the time of invoking your function. Your
* function receives an event with all the retrieved records. The
* default is 100 records.
*/
public Integer getBatchSize() {
return this.batchSize;
}
/**
*
* The largest number of records that AWS Lambda will retrieve from your
* event source at the time of invoking your function. Your function
* receives an event with all the retrieved records. The default is 100
* records.
*
*
* @param batchSize
* The largest number of records that AWS Lambda will retrieve from
* your event source at the time of invoking your function. Your
* function receives an event with all the retrieved records. The
* default is 100 records.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateEventSourceMappingRequest withBatchSize(Integer batchSize) {
setBatchSize(batchSize);
return this;
}
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*
* @param startingPosition
* The position in the stream where AWS Lambda should start reading.
* For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
* @see EventSourcePosition
*/
public void setStartingPosition(String startingPosition) {
this.startingPosition = startingPosition;
}
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*
* @return The position in the stream where AWS Lambda should start reading.
* For more information, go to ShardIteratorType in the Amazon Kinesis API
* Reference.
* @see EventSourcePosition
*/
public String getStartingPosition() {
return this.startingPosition;
}
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*
* @param startingPosition
* The position in the stream where AWS Lambda should start reading.
* For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see EventSourcePosition
*/
public CreateEventSourceMappingRequest withStartingPosition(
String startingPosition) {
setStartingPosition(startingPosition);
return this;
}
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*
* @param startingPosition
* The position in the stream where AWS Lambda should start reading.
* For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
* @see EventSourcePosition
*/
public void setStartingPosition(EventSourcePosition startingPosition) {
this.startingPosition = startingPosition.toString();
}
/**
*
* The position in the stream where AWS Lambda should start reading. For
* more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
*
*
* @param startingPosition
* The position in the stream where AWS Lambda should start reading.
* For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see EventSourcePosition
*/
public CreateEventSourceMappingRequest withStartingPosition(
EventSourcePosition startingPosition) {
setStartingPosition(startingPosition);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEventSourceArn() != null)
sb.append("EventSourceArn: " + getEventSourceArn() + ",");
if (getFunctionName() != null)
sb.append("FunctionName: " + getFunctionName() + ",");
if (getEnabled() != null)
sb.append("Enabled: " + getEnabled() + ",");
if (getBatchSize() != null)
sb.append("BatchSize: " + getBatchSize() + ",");
if (getStartingPosition() != null)
sb.append("StartingPosition: " + getStartingPosition());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateEventSourceMappingRequest == false)
return false;
CreateEventSourceMappingRequest other = (CreateEventSourceMappingRequest) obj;
if (other.getEventSourceArn() == null
^ this.getEventSourceArn() == null)
return false;
if (other.getEventSourceArn() != null
&& other.getEventSourceArn().equals(this.getEventSourceArn()) == false)
return false;
if (other.getFunctionName() == null ^ this.getFunctionName() == null)
return false;
if (other.getFunctionName() != null
&& other.getFunctionName().equals(this.getFunctionName()) == false)
return false;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null
&& other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getBatchSize() == null ^ this.getBatchSize() == null)
return false;
if (other.getBatchSize() != null
&& other.getBatchSize().equals(this.getBatchSize()) == false)
return false;
if (other.getStartingPosition() == null
^ this.getStartingPosition() == null)
return false;
if (other.getStartingPosition() != null
&& other.getStartingPosition().equals(
this.getStartingPosition()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getEventSourceArn() == null) ? 0 : getEventSourceArn()
.hashCode());
hashCode = prime
* hashCode
+ ((getFunctionName() == null) ? 0 : getFunctionName()
.hashCode());
hashCode = prime * hashCode
+ ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode
+ ((getBatchSize() == null) ? 0 : getBatchSize().hashCode());
hashCode = prime
* hashCode
+ ((getStartingPosition() == null) ? 0 : getStartingPosition()
.hashCode());
return hashCode;
}
@Override
public CreateEventSourceMappingRequest clone() {
return (CreateEventSourceMappingRequest) super.clone();
}
}