com.amazonaws.services.iotevents.model.IotSiteWiseAction 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;
/**
*
* Sends information about the detector model instance and the event that triggered the action to a specified asset
* property in AWS IoT SiteWise.
*
*
* You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals,
* operators, functions, references, and substitutions templates.
*
*
* Examples
*
*
* -
*
* For literal values, the expressions must contain single quotes. For example, the value for the
* propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.
*
*
* -
*
* For references, you must specify either variables or input values. For example, the value for the
* assetId parameter can be $input.TurbineInput.assetId1.
*
*
* -
*
* 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 propertyAlias parameter uses a substitution template.
*
*
* 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
*
*
*
*
* You must specify either propertyAlias or both assetId and propertyId to
* identify the target asset property in AWS IoT SiteWise.
*
*
* 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 IotSiteWiseAction implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of
* failure. The default is a new unique identifier.
*
*/
private String entryId;
/**
*
* The ID of the asset that has the specified property.
*
*/
private String assetId;
/**
*
* The ID of the asset property.
*
*/
private String propertyId;
/**
*
* The alias of the asset property.
*
*/
private String propertyAlias;
/**
*
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
*
*/
private AssetPropertyValue propertyValue;
/**
*
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of
* failure. The default is a new unique identifier.
*
*
* @param entryId
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in
* case of failure. The default is a new unique identifier.
*/
public void setEntryId(String entryId) {
this.entryId = entryId;
}
/**
*
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of
* failure. The default is a new unique identifier.
*
*
* @return A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in
* case of failure. The default is a new unique identifier.
*/
public String getEntryId() {
return this.entryId;
}
/**
*
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of
* failure. The default is a new unique identifier.
*
*
* @param entryId
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in
* case of failure. The default is a new unique identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IotSiteWiseAction withEntryId(String entryId) {
setEntryId(entryId);
return this;
}
/**
*
* The ID of the asset that has the specified property.
*
*
* @param assetId
* The ID of the asset that has the specified property.
*/
public void setAssetId(String assetId) {
this.assetId = assetId;
}
/**
*
* The ID of the asset that has the specified property.
*
*
* @return The ID of the asset that has the specified property.
*/
public String getAssetId() {
return this.assetId;
}
/**
*
* The ID of the asset that has the specified property.
*
*
* @param assetId
* The ID of the asset that has the specified property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IotSiteWiseAction withAssetId(String assetId) {
setAssetId(assetId);
return this;
}
/**
*
* The ID of the asset property.
*
*
* @param propertyId
* The ID of the asset property.
*/
public void setPropertyId(String propertyId) {
this.propertyId = propertyId;
}
/**
*
* The ID of the asset property.
*
*
* @return The ID of the asset property.
*/
public String getPropertyId() {
return this.propertyId;
}
/**
*
* The ID of the asset property.
*
*
* @param propertyId
* The ID of the asset property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IotSiteWiseAction withPropertyId(String propertyId) {
setPropertyId(propertyId);
return this;
}
/**
*
* The alias of the asset property.
*
*
* @param propertyAlias
* The alias of the asset property.
*/
public void setPropertyAlias(String propertyAlias) {
this.propertyAlias = propertyAlias;
}
/**
*
* The alias of the asset property.
*
*
* @return The alias of the asset property.
*/
public String getPropertyAlias() {
return this.propertyAlias;
}
/**
*
* The alias of the asset property.
*
*
* @param propertyAlias
* The alias of the asset property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IotSiteWiseAction withPropertyAlias(String propertyAlias) {
setPropertyAlias(propertyAlias);
return this;
}
/**
*
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
*
*
* @param propertyValue
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV)
* information.
*/
public void setPropertyValue(AssetPropertyValue propertyValue) {
this.propertyValue = propertyValue;
}
/**
*
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
*
*
* @return The value to send to the asset property. This value contains timestamp, quality, and value (TQV)
* information.
*/
public AssetPropertyValue getPropertyValue() {
return this.propertyValue;
}
/**
*
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
*
*
* @param propertyValue
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV)
* information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IotSiteWiseAction withPropertyValue(AssetPropertyValue propertyValue) {
setPropertyValue(propertyValue);
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 (getEntryId() != null)
sb.append("EntryId: ").append(getEntryId()).append(",");
if (getAssetId() != null)
sb.append("AssetId: ").append(getAssetId()).append(",");
if (getPropertyId() != null)
sb.append("PropertyId: ").append(getPropertyId()).append(",");
if (getPropertyAlias() != null)
sb.append("PropertyAlias: ").append(getPropertyAlias()).append(",");
if (getPropertyValue() != null)
sb.append("PropertyValue: ").append(getPropertyValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IotSiteWiseAction == false)
return false;
IotSiteWiseAction other = (IotSiteWiseAction) obj;
if (other.getEntryId() == null ^ this.getEntryId() == null)
return false;
if (other.getEntryId() != null && other.getEntryId().equals(this.getEntryId()) == false)
return false;
if (other.getAssetId() == null ^ this.getAssetId() == null)
return false;
if (other.getAssetId() != null && other.getAssetId().equals(this.getAssetId()) == false)
return false;
if (other.getPropertyId() == null ^ this.getPropertyId() == null)
return false;
if (other.getPropertyId() != null && other.getPropertyId().equals(this.getPropertyId()) == false)
return false;
if (other.getPropertyAlias() == null ^ this.getPropertyAlias() == null)
return false;
if (other.getPropertyAlias() != null && other.getPropertyAlias().equals(this.getPropertyAlias()) == false)
return false;
if (other.getPropertyValue() == null ^ this.getPropertyValue() == null)
return false;
if (other.getPropertyValue() != null && other.getPropertyValue().equals(this.getPropertyValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEntryId() == null) ? 0 : getEntryId().hashCode());
hashCode = prime * hashCode + ((getAssetId() == null) ? 0 : getAssetId().hashCode());
hashCode = prime * hashCode + ((getPropertyId() == null) ? 0 : getPropertyId().hashCode());
hashCode = prime * hashCode + ((getPropertyAlias() == null) ? 0 : getPropertyAlias().hashCode());
hashCode = prime * hashCode + ((getPropertyValue() == null) ? 0 : getPropertyValue().hashCode());
return hashCode;
}
@Override
public IotSiteWiseAction clone() {
try {
return (IotSiteWiseAction) 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.IotSiteWiseActionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}