com.amazonaws.services.iotevents.model.Payload 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;
/**
*
* Information needed to configure the payload.
*
*
* By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all
* attribute-value pairs that have the information about the detector model instance and the event triggered the action.
* To configure the action payload, you can use contentExpression.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Payload implements Serializable, Cloneable, StructuredPojo {
/**
*
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that
* contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
*
*/
private String contentExpression;
/**
*
* The value of the payload type can be either STRING or JSON.
*
*/
private String type;
/**
*
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that
* contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
*
*
* @param contentExpression
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings
* that contain ${} as the content. The recommended maximum size of a content expression is 1
* KB.
*/
public void setContentExpression(String contentExpression) {
this.contentExpression = contentExpression;
}
/**
*
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that
* contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
*
*
* @return The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings
* that contain ${} as the content. The recommended maximum size of a content expression is 1
* KB.
*/
public String getContentExpression() {
return this.contentExpression;
}
/**
*
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that
* contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
*
*
* @param contentExpression
* The content of the payload. You can use a string expression that includes quoted strings (
* '<string>'), variables ($variable.<variable-name>), input values (
* $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings
* that contain ${} as the content. The recommended maximum size of a content expression is 1
* KB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Payload withContentExpression(String contentExpression) {
setContentExpression(contentExpression);
return this;
}
/**
*
* The value of the payload type can be either STRING or JSON.
*
*
* @param type
* The value of the payload type can be either STRING or JSON.
* @see PayloadType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The value of the payload type can be either STRING or JSON.
*
*
* @return The value of the payload type can be either STRING or JSON.
* @see PayloadType
*/
public String getType() {
return this.type;
}
/**
*
* The value of the payload type can be either STRING or JSON.
*
*
* @param type
* The value of the payload type can be either STRING or JSON.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PayloadType
*/
public Payload withType(String type) {
setType(type);
return this;
}
/**
*
* The value of the payload type can be either STRING or JSON.
*
*
* @param type
* The value of the payload type can be either STRING or JSON.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PayloadType
*/
public Payload withType(PayloadType type) {
this.type = type.toString();
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 (getContentExpression() != null)
sb.append("ContentExpression: ").append(getContentExpression()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Payload == false)
return false;
Payload other = (Payload) obj;
if (other.getContentExpression() == null ^ this.getContentExpression() == null)
return false;
if (other.getContentExpression() != null && other.getContentExpression().equals(this.getContentExpression()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContentExpression() == null) ? 0 : getContentExpression().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public Payload clone() {
try {
return (Payload) 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.PayloadMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}