All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.iot.model.DynamoDBAction Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWS Iot Service module holds the client classes that are used for communicating with AWS IoT Service

There is a newer version: 1.12.782
Show newest version
/*
 * Copyright 2011-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.iot.model;

import java.io.Serializable;

/**
 * 

* Describes an action to write to a DynamoDB table. *

*

* The tableName, hashKeyField, and rangeKeyField values must match the values * used when you created the table. *

*

* The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These * templates provide data at runtime. The syntax is as follows: ${sql-expression}. *

*

* You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, * calculations, and functions. For example, the following field uses the third level of the topic: *

*

* "hashKeyValue": "${topic(3)}" *

*

* The following field uses the timestamp: *

*

* "rangeKeyValue": "${timestamp()}" *

*/ public class DynamoDBAction implements Serializable, Cloneable { /** *

* The name of the DynamoDB table. *

*/ private String tableName; /** *

* The ARN of the IAM role that grants access to the DynamoDB table. *

*/ private String roleArn; /** *

* The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. *

*/ private String operation; /** *

* The hash key name. *

*/ private String hashKeyField; /** *

* The hash key value. *

*/ private String hashKeyValue; /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

*/ private String hashKeyType; /** *

* The range key name. *

*/ private String rangeKeyField; /** *

* The range key value. *

*/ private String rangeKeyValue; /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

*/ private String rangeKeyType; /** *

* The action payload. This name can be customized. *

*/ private String payloadField; /** *

* 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 DynamoDBAction withTableName(String tableName) { setTableName(tableName); return this; } /** *

* The ARN of the IAM role that grants access to the DynamoDB table. *

* * @param roleArn * The ARN of the IAM role that grants access to the DynamoDB table. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The ARN of the IAM role that grants access to the DynamoDB table. *

* * @return The ARN of the IAM role that grants access to the DynamoDB table. */ public String getRoleArn() { return this.roleArn; } /** *

* The ARN of the IAM role that grants access to the DynamoDB table. *

* * @param roleArn * The ARN of the IAM role that grants access to the DynamoDB table. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** *

* The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. *

* * @param operation * The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. */ public void setOperation(String operation) { this.operation = operation; } /** *

* The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. *

* * @return The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. */ public String getOperation() { return this.operation; } /** *

* The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. *

* * @param operation * The type of operation to be performed. This follows the substitution template, so it can be * ${operation}, but the substitution must result in one of the following: INSERT, * UPDATE, or DELETE. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withOperation(String operation) { setOperation(operation); return this; } /** *

* The hash key name. *

* * @param hashKeyField * The hash key name. */ public void setHashKeyField(String hashKeyField) { this.hashKeyField = hashKeyField; } /** *

* The hash key name. *

* * @return The hash key name. */ public String getHashKeyField() { return this.hashKeyField; } /** *

* The hash key name. *

* * @param hashKeyField * The hash key name. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withHashKeyField(String hashKeyField) { setHashKeyField(hashKeyField); return this; } /** *

* The hash key value. *

* * @param hashKeyValue * The hash key value. */ public void setHashKeyValue(String hashKeyValue) { this.hashKeyValue = hashKeyValue; } /** *

* The hash key value. *

* * @return The hash key value. */ public String getHashKeyValue() { return this.hashKeyValue; } /** *

* The hash key value. *

* * @param hashKeyValue * The hash key value. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withHashKeyValue(String hashKeyValue) { setHashKeyValue(hashKeyValue); return this; } /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

* * @param hashKeyType * The hash key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public void setHashKeyType(String hashKeyType) { this.hashKeyType = hashKeyType; } /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

* * @return The hash key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public String getHashKeyType() { return this.hashKeyType; } /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

* * @param hashKeyType * The hash key type. Valid values are "STRING" or "NUMBER" * @return Returns a reference to this object so that method calls can be chained together. * @see DynamoKeyType */ public DynamoDBAction withHashKeyType(String hashKeyType) { setHashKeyType(hashKeyType); return this; } /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

* * @param hashKeyType * The hash key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public void setHashKeyType(DynamoKeyType hashKeyType) { this.hashKeyType = hashKeyType.toString(); } /** *

* The hash key type. Valid values are "STRING" or "NUMBER" *

* * @param hashKeyType * The hash key type. Valid values are "STRING" or "NUMBER" * @return Returns a reference to this object so that method calls can be chained together. * @see DynamoKeyType */ public DynamoDBAction withHashKeyType(DynamoKeyType hashKeyType) { setHashKeyType(hashKeyType); return this; } /** *

* The range key name. *

* * @param rangeKeyField * The range key name. */ public void setRangeKeyField(String rangeKeyField) { this.rangeKeyField = rangeKeyField; } /** *

* The range key name. *

* * @return The range key name. */ public String getRangeKeyField() { return this.rangeKeyField; } /** *

* The range key name. *

* * @param rangeKeyField * The range key name. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withRangeKeyField(String rangeKeyField) { setRangeKeyField(rangeKeyField); return this; } /** *

* The range key value. *

* * @param rangeKeyValue * The range key value. */ public void setRangeKeyValue(String rangeKeyValue) { this.rangeKeyValue = rangeKeyValue; } /** *

* The range key value. *

* * @return The range key value. */ public String getRangeKeyValue() { return this.rangeKeyValue; } /** *

* The range key value. *

* * @param rangeKeyValue * The range key value. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withRangeKeyValue(String rangeKeyValue) { setRangeKeyValue(rangeKeyValue); return this; } /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

* * @param rangeKeyType * The range key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public void setRangeKeyType(String rangeKeyType) { this.rangeKeyType = rangeKeyType; } /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

* * @return The range key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public String getRangeKeyType() { return this.rangeKeyType; } /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

* * @param rangeKeyType * The range key type. Valid values are "STRING" or "NUMBER" * @return Returns a reference to this object so that method calls can be chained together. * @see DynamoKeyType */ public DynamoDBAction withRangeKeyType(String rangeKeyType) { setRangeKeyType(rangeKeyType); return this; } /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

* * @param rangeKeyType * The range key type. Valid values are "STRING" or "NUMBER" * @see DynamoKeyType */ public void setRangeKeyType(DynamoKeyType rangeKeyType) { this.rangeKeyType = rangeKeyType.toString(); } /** *

* The range key type. Valid values are "STRING" or "NUMBER" *

* * @param rangeKeyType * The range key type. Valid values are "STRING" or "NUMBER" * @return Returns a reference to this object so that method calls can be chained together. * @see DynamoKeyType */ public DynamoDBAction withRangeKeyType(DynamoKeyType rangeKeyType) { setRangeKeyType(rangeKeyType); return this; } /** *

* The action payload. This name can be customized. *

* * @param payloadField * The action payload. This name can be customized. */ public void setPayloadField(String payloadField) { this.payloadField = payloadField; } /** *

* The action payload. This name can be customized. *

* * @return The action payload. This name can be customized. */ public String getPayloadField() { return this.payloadField; } /** *

* The action payload. This name can be customized. *

* * @param payloadField * The action payload. This name can be customized. * @return Returns a reference to this object so that method calls can be chained together. */ public DynamoDBAction withPayloadField(String payloadField) { setPayloadField(payloadField); 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 (getTableName() != null) sb.append("TableName: " + getTableName() + ","); if (getRoleArn() != null) sb.append("RoleArn: " + getRoleArn() + ","); if (getOperation() != null) sb.append("Operation: " + getOperation() + ","); if (getHashKeyField() != null) sb.append("HashKeyField: " + getHashKeyField() + ","); if (getHashKeyValue() != null) sb.append("HashKeyValue: " + getHashKeyValue() + ","); if (getHashKeyType() != null) sb.append("HashKeyType: " + getHashKeyType() + ","); if (getRangeKeyField() != null) sb.append("RangeKeyField: " + getRangeKeyField() + ","); if (getRangeKeyValue() != null) sb.append("RangeKeyValue: " + getRangeKeyValue() + ","); if (getRangeKeyType() != null) sb.append("RangeKeyType: " + getRangeKeyType() + ","); if (getPayloadField() != null) sb.append("PayloadField: " + getPayloadField()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DynamoDBAction == false) return false; DynamoDBAction other = (DynamoDBAction) obj; if (other.getTableName() == null ^ this.getTableName() == null) return false; if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getOperation() == null ^ this.getOperation() == null) return false; if (other.getOperation() != null && other.getOperation().equals(this.getOperation()) == false) return false; if (other.getHashKeyField() == null ^ this.getHashKeyField() == null) return false; if (other.getHashKeyField() != null && other.getHashKeyField().equals(this.getHashKeyField()) == false) return false; if (other.getHashKeyValue() == null ^ this.getHashKeyValue() == null) return false; if (other.getHashKeyValue() != null && other.getHashKeyValue().equals(this.getHashKeyValue()) == false) return false; if (other.getHashKeyType() == null ^ this.getHashKeyType() == null) return false; if (other.getHashKeyType() != null && other.getHashKeyType().equals(this.getHashKeyType()) == false) return false; if (other.getRangeKeyField() == null ^ this.getRangeKeyField() == null) return false; if (other.getRangeKeyField() != null && other.getRangeKeyField().equals(this.getRangeKeyField()) == false) return false; if (other.getRangeKeyValue() == null ^ this.getRangeKeyValue() == null) return false; if (other.getRangeKeyValue() != null && other.getRangeKeyValue().equals(this.getRangeKeyValue()) == false) return false; if (other.getRangeKeyType() == null ^ this.getRangeKeyType() == null) return false; if (other.getRangeKeyType() != null && other.getRangeKeyType().equals(this.getRangeKeyType()) == false) return false; if (other.getPayloadField() == null ^ this.getPayloadField() == null) return false; if (other.getPayloadField() != null && other.getPayloadField().equals(this.getPayloadField()) == 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 + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getOperation() == null) ? 0 : getOperation().hashCode()); hashCode = prime * hashCode + ((getHashKeyField() == null) ? 0 : getHashKeyField().hashCode()); hashCode = prime * hashCode + ((getHashKeyValue() == null) ? 0 : getHashKeyValue().hashCode()); hashCode = prime * hashCode + ((getHashKeyType() == null) ? 0 : getHashKeyType().hashCode()); hashCode = prime * hashCode + ((getRangeKeyField() == null) ? 0 : getRangeKeyField().hashCode()); hashCode = prime * hashCode + ((getRangeKeyValue() == null) ? 0 : getRangeKeyValue().hashCode()); hashCode = prime * hashCode + ((getRangeKeyType() == null) ? 0 : getRangeKeyType().hashCode()); hashCode = prime * hashCode + ((getPayloadField() == null) ? 0 : getPayloadField().hashCode()); return hashCode; } @Override public DynamoDBAction clone() { try { return (DynamoDBAction) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy