software.amazon.awssdk.services.iotevents.model.DynamoDBv2Action Maven / Gradle / Ivy
Show all versions of iotevents Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.iotevents.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DynamoDBv2Action implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("tableName").getter(getter(DynamoDBv2Action::tableName)).setter(setter(Builder::tableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tableName").build()).build();
private static final SdkField PAYLOAD_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("payload").getter(getter(DynamoDBv2Action::payload)).setter(setter(Builder::payload))
.constructor(Payload::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("payload").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TABLE_NAME_FIELD,
PAYLOAD_FIELD));
private static final long serialVersionUID = 1L;
private final String tableName;
private final Payload payload;
private DynamoDBv2Action(BuilderImpl builder) {
this.tableName = builder.tableName;
this.payload = builder.payload;
}
/**
*
* The name of the DynamoDB table.
*
*
* @return The name of the DynamoDB table.
*/
public final String tableName() {
return tableName;
}
/**
* Returns the value of the Payload property for this object.
*
* @return The value of the Payload property for this object.
*/
public final Payload payload() {
return payload;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(tableName());
hashCode = 31 * hashCode + Objects.hashCode(payload());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DynamoDBv2Action)) {
return false;
}
DynamoDBv2Action other = (DynamoDBv2Action) obj;
return Objects.equals(tableName(), other.tableName()) && Objects.equals(payload(), other.payload());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DynamoDBv2Action").add("TableName", tableName()).add("Payload", payload()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "tableName":
return Optional.ofNullable(clazz.cast(tableName()));
case "payload":
return Optional.ofNullable(clazz.cast(payload()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DynamoDBv2Action) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder tableName(String tableName);
/**
* Sets the value of the Payload property for this object.
*
* @param payload
* The new value for the Payload property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder payload(Payload payload);
/**
* Sets the value of the Payload property for this object.
*
* This is a convenience method that creates an instance of the {@link Payload.Builder} avoiding the need to
* create one manually via {@link Payload#builder()}.
*
*
* When the {@link Consumer} completes, {@link Payload.Builder#build()} is called immediately and its result is
* passed to {@link #payload(Payload)}.
*
* @param payload
* a consumer that will call methods on {@link Payload.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #payload(Payload)
*/
default Builder payload(Consumer payload) {
return payload(Payload.builder().applyMutation(payload).build());
}
}
static final class BuilderImpl implements Builder {
private String tableName;
private Payload payload;
private BuilderImpl() {
}
private BuilderImpl(DynamoDBv2Action model) {
tableName(model.tableName);
payload(model.payload);
}
public final String getTableName() {
return tableName;
}
public final void setTableName(String tableName) {
this.tableName = tableName;
}
@Override
public final Builder tableName(String tableName) {
this.tableName = tableName;
return this;
}
public final Payload.Builder getPayload() {
return payload != null ? payload.toBuilder() : null;
}
public final void setPayload(Payload.BuilderImpl payload) {
this.payload = payload != null ? payload.build() : null;
}
@Override
public final Builder payload(Payload payload) {
this.payload = payload;
return this;
}
@Override
public DynamoDBv2Action build() {
return new DynamoDBv2Action(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}