com.amazonaws.services.iotevents.model.AssetPropertyValue 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;
/**
*
* A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
*
*
* You must use expressions for all parameters in AssetPropertyValue. 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 quality
* parameter can be 'GOOD'.
*
*
* -
*
* For references, you must specify either variables or input values. For example, the value for the
* quality parameter can be $input.TemperatureInput.sensorData.quality.
*
*
*
*
* For more information, see Expressions in the
* AWS IoT Events Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AssetPropertyValue implements Serializable, Cloneable, StructuredPojo {
/**
*
* The value to send to an asset property.
*
*/
private AssetPropertyVariant value;
/**
*
* The timestamp associated with the asset property value. The default is the current event time.
*
*/
private AssetPropertyTimestamp timestamp;
/**
*
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*
*/
private String quality;
/**
*
* The value to send to an asset property.
*
*
* @param value
* The value to send to an asset property.
*/
public void setValue(AssetPropertyVariant value) {
this.value = value;
}
/**
*
* The value to send to an asset property.
*
*
* @return The value to send to an asset property.
*/
public AssetPropertyVariant getValue() {
return this.value;
}
/**
*
* The value to send to an asset property.
*
*
* @param value
* The value to send to an asset property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssetPropertyValue withValue(AssetPropertyVariant value) {
setValue(value);
return this;
}
/**
*
* The timestamp associated with the asset property value. The default is the current event time.
*
*
* @param timestamp
* The timestamp associated with the asset property value. The default is the current event time.
*/
public void setTimestamp(AssetPropertyTimestamp timestamp) {
this.timestamp = timestamp;
}
/**
*
* The timestamp associated with the asset property value. The default is the current event time.
*
*
* @return The timestamp associated with the asset property value. The default is the current event time.
*/
public AssetPropertyTimestamp getTimestamp() {
return this.timestamp;
}
/**
*
* The timestamp associated with the asset property value. The default is the current event time.
*
*
* @param timestamp
* The timestamp associated with the asset property value. The default is the current event time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssetPropertyValue withTimestamp(AssetPropertyTimestamp timestamp) {
setTimestamp(timestamp);
return this;
}
/**
*
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*
*
* @param quality
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*/
public void setQuality(String quality) {
this.quality = quality;
}
/**
*
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*
*
* @return The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*/
public String getQuality() {
return this.quality;
}
/**
*
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
*
*
* @param quality
* The quality of the asset property value. The value must be 'GOOD', 'BAD', or
* 'UNCERTAIN'.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssetPropertyValue withQuality(String quality) {
setQuality(quality);
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 (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getTimestamp() != null)
sb.append("Timestamp: ").append(getTimestamp()).append(",");
if (getQuality() != null)
sb.append("Quality: ").append(getQuality());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AssetPropertyValue == false)
return false;
AssetPropertyValue other = (AssetPropertyValue) obj;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getTimestamp() == null ^ this.getTimestamp() == null)
return false;
if (other.getTimestamp() != null && other.getTimestamp().equals(this.getTimestamp()) == false)
return false;
if (other.getQuality() == null ^ this.getQuality() == null)
return false;
if (other.getQuality() != null && other.getQuality().equals(this.getQuality()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getTimestamp() == null) ? 0 : getTimestamp().hashCode());
hashCode = prime * hashCode + ((getQuality() == null) ? 0 : getQuality().hashCode());
return hashCode;
}
@Override
public AssetPropertyValue clone() {
try {
return (AssetPropertyValue) 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.AssetPropertyValueMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}