com.amazonaws.services.iotevents.model.DynamoDBv2Action Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iotevents 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.iotevents.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the
* information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of
* the DynamoDB table receives one attribute-value pair in the payload that you specify.
*
*
* You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals,
* operators, functions, references, and substitution templates.
*
*
* Examples
*
*
* -
*
* For literal values, the expressions must contain single quotes. For example, the value for the tableName
* parameter can be 'GreenhouseTemperatureTable'.
*
*
* -
*
* For references, you must specify either variables or input values. For example, the value for the
* tableName parameter can be $variable.ddbtableName.
*
*
* -
*
* For a substitution template, you must use ${}, and the template must be in single quotes. A substitution
* template can also contain a combination of literals, operators, functions, references, and substitution templates.
*
*
* In the following example, the value for the contentExpression parameter in Payload uses a
* substitution template.
*
*
* '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'
*
*
* -
*
* For a string concatenation, you must use +. A string concatenation can also contain a combination of
* literals, operators, functions, references, and substitution templates.
*
*
* In the following example, the value for the tableName parameter uses a string concatenation.
*
*
* 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
*
*
*
*
* For more information, see Expressions in the
* AWS IoT Events Developer Guide.
*
*
* The value for the type parameter in Payload must be JSON.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DynamoDBv2Action implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the DynamoDB table.
*
*/
private String tableName;
private Payload payload;
/**
*
* The name of the DynamoDB table.
*
*
* @param tableName
* The name of the DynamoDB table.
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
*
* The name of the DynamoDB table.
*
*
* @return The name of the DynamoDB table.
*/
public String getTableName() {
return this.tableName;
}
/**
*
* The name of the DynamoDB table.
*
*
* @param tableName
* The name of the DynamoDB table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DynamoDBv2Action withTableName(String tableName) {
setTableName(tableName);
return this;
}
/**
* @param payload
*/
public void setPayload(Payload payload) {
this.payload = payload;
}
/**
* @return
*/
public Payload getPayload() {
return this.payload;
}
/**
* @param payload
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DynamoDBv2Action withPayload(Payload payload) {
setPayload(payload);
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 (getTableName() != null)
sb.append("TableName: ").append(getTableName()).append(",");
if (getPayload() != null)
sb.append("Payload: ").append(getPayload());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DynamoDBv2Action == false)
return false;
DynamoDBv2Action other = (DynamoDBv2Action) obj;
if (other.getTableName() == null ^ this.getTableName() == null)
return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false)
return false;
if (other.getPayload() == null ^ this.getPayload() == null)
return false;
if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode());
return hashCode;
}
@Override
public DynamoDBv2Action clone() {
try {
return (DynamoDBv2Action) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.iotevents.model.transform.DynamoDBv2ActionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}