com.amazonaws.services.lambda.model.CreateEventSourceMappingRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateEventSourceMappingRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the event source.
*
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*
*/
private String eventSourceArn;
/**
*
* The name of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
* characters in length.
*
*/
private String functionName;
/**
*
* Disables the event source mapping to pause polling and invocation.
*
*/
private Boolean enabled;
/**
*
* The maximum number of items to retrieve in a single batch.
*
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*
*/
private Integer batchSize;
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*/
private String startingPosition;
/**
*
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*
*/
private java.util.Date startingPositionTimestamp;
/**
*
* The Amazon Resource Name (ARN) of the event source.
*
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*
*
* @param eventSourceArn
* The Amazon Resource Name (ARN) of the event source.
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*/
public void setEventSourceArn(String eventSourceArn) {
this.eventSourceArn = eventSourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the event source.
*
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*
*
* @return The Amazon Resource Name (ARN) of the event source.
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*/
public String getEventSourceArn() {
return this.eventSourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the event source.
*
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
*
*
* @param eventSourceArn
* The Amazon Resource Name (ARN) of the event source.
*
* -
*
* Amazon Kinesis - The ARN of the data stream or a stream consumer.
*
*
* -
*
* Amazon DynamoDB Streams - The ARN of the stream.
*
*
* -
*
* Amazon Simple Queue Service - The ARN of the queue.
*
*
* @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 name of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
* characters in length.
*
*
* @param functionName
* The name of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to
* 64 characters in length.
*/
public void setFunctionName(String functionName) {
this.functionName = functionName;
}
/**
*
* The name of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
* characters in length.
*
*
* @return The name of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
* .
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited
* to 64 characters in length.
*/
public String getFunctionName() {
return this.functionName;
}
/**
*
* The name of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
* characters in length.
*
*
* @param functionName
* The name of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name - MyFunction.
*
*
* -
*
* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
*
*
* -
*
* Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
*
*
* -
*
* Partial ARN - 123456789012:function:MyFunction.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it's limited to
* 64 characters 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;
}
/**
*
* Disables the event source mapping to pause polling and invocation.
*
*
* @param enabled
* Disables the event source mapping to pause polling and invocation.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* Disables the event source mapping to pause polling and invocation.
*
*
* @return Disables the event source mapping to pause polling and invocation.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* Disables the event source mapping to pause polling and invocation.
*
*
* @param enabled
* Disables the event source mapping to pause polling and invocation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSourceMappingRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* Disables the event source mapping to pause polling and invocation.
*
*
* @return Disables the event source mapping to pause polling and invocation.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* The maximum number of items to retrieve in a single batch.
*
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*
*
* @param batchSize
* The maximum number of items to retrieve in a single batch.
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*/
public void setBatchSize(Integer batchSize) {
this.batchSize = batchSize;
}
/**
*
* The maximum number of items to retrieve in a single batch.
*
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*
*
* @return The maximum number of items to retrieve in a single batch.
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*/
public Integer getBatchSize() {
return this.batchSize;
}
/**
*
* The maximum number of items to retrieve in a single batch.
*
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
*
*
* @param batchSize
* The maximum number of items to retrieve in a single batch.
*
* -
*
* Amazon Kinesis - Default 100. Max 10,000.
*
*
* -
*
* Amazon DynamoDB Streams - Default 100. Max 1,000.
*
*
* -
*
* Amazon Simple Queue Service - Default 10. Max 10.
*
*
* @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 a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*
* @param startingPosition
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
* @see EventSourcePosition
*/
public void setStartingPosition(String startingPosition) {
this.startingPosition = startingPosition;
}
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*
* @return The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
* @see EventSourcePosition
*/
public String getStartingPosition() {
return this.startingPosition;
}
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*
* @param startingPosition
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
* @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 a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*
* @param startingPosition
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
* @see EventSourcePosition
*/
public void setStartingPosition(EventSourcePosition startingPosition) {
withStartingPosition(startingPosition);
}
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
* sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*
*
* @param startingPosition
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventSourcePosition
*/
public CreateEventSourceMappingRequest withStartingPosition(EventSourcePosition startingPosition) {
this.startingPosition = startingPosition.toString();
return this;
}
/**
*
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*
*
* @param startingPositionTimestamp
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*/
public void setStartingPositionTimestamp(java.util.Date startingPositionTimestamp) {
this.startingPositionTimestamp = startingPositionTimestamp;
}
/**
*
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*
*
* @return With StartingPosition set to AT_TIMESTAMP, the time from which to start
* reading.
*/
public java.util.Date getStartingPositionTimestamp() {
return this.startingPositionTimestamp;
}
/**
*
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*
*
* @param startingPositionTimestamp
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSourceMappingRequest withStartingPositionTimestamp(java.util.Date startingPositionTimestamp) {
setStartingPositionTimestamp(startingPositionTimestamp);
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 (getEventSourceArn() != null)
sb.append("EventSourceArn: ").append(getEventSourceArn()).append(",");
if (getFunctionName() != null)
sb.append("FunctionName: ").append(getFunctionName()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getBatchSize() != null)
sb.append("BatchSize: ").append(getBatchSize()).append(",");
if (getStartingPosition() != null)
sb.append("StartingPosition: ").append(getStartingPosition()).append(",");
if (getStartingPositionTimestamp() != null)
sb.append("StartingPositionTimestamp: ").append(getStartingPositionTimestamp());
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;
if (other.getStartingPositionTimestamp() == null ^ this.getStartingPositionTimestamp() == null)
return false;
if (other.getStartingPositionTimestamp() != null && other.getStartingPositionTimestamp().equals(this.getStartingPositionTimestamp()) == 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());
hashCode = prime * hashCode + ((getStartingPositionTimestamp() == null) ? 0 : getStartingPositionTimestamp().hashCode());
return hashCode;
}
@Override
public CreateEventSourceMappingRequest clone() {
return (CreateEventSourceMappingRequest) super.clone();
}
}