/* * Copyright 2018-2023 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.iotsitewise.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateAssetPropertyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The ID of the asset to be updated. *

*/ private String assetId; /** *

* The ID of the asset property to be updated. *

*/ private String propertyId; /** *

* The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial * data streams to asset properties in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the alias is removed from the property. *

*/ private String propertyAlias; /** *

* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting * with other services in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the notification state is set to DISABLED. *

*/ private String propertyNotificationState; /** *

* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse * this client token if a new idempotent request is required. *

*/ private String clientToken; /** *

* The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. *

*/ private String propertyUnit; /** *

* The ID of the asset to be updated. *

* * @param assetId * The ID of the asset to be updated. */ public void setAssetId(String assetId) { this.assetId = assetId; } /** *

* The ID of the asset to be updated. *

* * @return The ID of the asset to be updated. */ public String getAssetId() { return this.assetId; } /** *

* The ID of the asset to be updated. *

* * @param assetId * The ID of the asset to be updated. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssetPropertyRequest withAssetId(String assetId) { setAssetId(assetId); return this; } /** *

* The ID of the asset property to be updated. *

* * @param propertyId * The ID of the asset property to be updated. */ public void setPropertyId(String propertyId) { this.propertyId = propertyId; } /** *

* The ID of the asset property to be updated. *

* * @return The ID of the asset property to be updated. */ public String getPropertyId() { return this.propertyId; } /** *

* The ID of the asset property to be updated. *

* * @param propertyId * The ID of the asset property to be updated. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssetPropertyRequest withPropertyId(String propertyId) { setPropertyId(propertyId); return this; } /** *

* The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial * data streams to asset properties in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the alias is removed from the property. *

* * @param propertyAlias * The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping * industrial data streams to asset properties in the IoT SiteWise User Guide.

*

* If you omit this parameter, the alias is removed from the property. */ public void setPropertyAlias(String propertyAlias) { this.propertyAlias = propertyAlias; } /** *

* The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial * data streams to asset properties in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the alias is removed from the property. *

* * @return The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping * industrial data streams to asset properties in the IoT SiteWise User Guide.

*

* If you omit this parameter, the alias is removed from the property. */ public String getPropertyAlias() { return this.propertyAlias; } /** *

* The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial * data streams to asset properties in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the alias is removed from the property. *

* * @param propertyAlias * The alias that identifies the property, such as an OPC-UA server data stream path (for example, * /company/windfarm/3/turbine/7/temperature). For more information, see Mapping * industrial data streams to asset properties in the IoT SiteWise User Guide.

*

* If you omit this parameter, the alias is removed from the property. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssetPropertyRequest withPropertyAlias(String propertyAlias) { setPropertyAlias(propertyAlias); return this; } /** *

* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting * with other services in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the notification state is set to DISABLED. *

* * @param propertyNotificationState * The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see * * Interacting with other services in the IoT SiteWise User Guide.

*

* If you omit this parameter, the notification state is set to DISABLED. * @see PropertyNotificationState */ public void setPropertyNotificationState(String propertyNotificationState) { this.propertyNotificationState = propertyNotificationState; } /** *

* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting * with other services in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the notification state is set to DISABLED. *

* * @return The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see * * Interacting with other services in the IoT SiteWise User Guide.

*

* If you omit this parameter, the notification state is set to DISABLED. * @see PropertyNotificationState */ public String getPropertyNotificationState() { return this.propertyNotificationState; } /** *

* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting * with other services in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the notification state is set to DISABLED. *

* * @param propertyNotificationState * The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see * * Interacting with other services in the IoT SiteWise User Guide.

*

* If you omit this parameter, the notification state is set to DISABLED. * @return Returns a reference to this object so that method calls can be chained together. * @see PropertyNotificationState */ public UpdateAssetPropertyRequest withPropertyNotificationState(String propertyNotificationState) { setPropertyNotificationState(propertyNotificationState); return this; } /** *

* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting * with other services in the IoT SiteWise User Guide. *

*

* If you omit this parameter, the notification state is set to DISABLED. *

* * @param propertyNotificationState * The MQTT notification state (enabled or disabled) for this asset property. When the notification state is * enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see * * Interacting with other services in the IoT SiteWise User Guide.

*

* If you omit this parameter, the notification state is set to DISABLED. * @return Returns a reference to this object so that method calls can be chained together. * @see PropertyNotificationState */ public UpdateAssetPropertyRequest withPropertyNotificationState(PropertyNotificationState propertyNotificationState) { this.propertyNotificationState = propertyNotificationState.toString(); return this; } /** *

* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse * this client token if a new idempotent request is required. *

* * @param clientToken * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't * reuse this client token if a new idempotent request is required. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse * this client token if a new idempotent request is required. *

* * @return A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't * reuse this client token if a new idempotent request is required. */ public String getClientToken() { return this.clientToken; } /** *

* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse * this client token if a new idempotent request is required. *

* * @param clientToken * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't * reuse this client token if a new idempotent request is required. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssetPropertyRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** *

* The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. *

* * @param propertyUnit * The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. */ public void setPropertyUnit(String propertyUnit) { this.propertyUnit = propertyUnit; } /** *

* The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. *

* * @return The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. */ public String getPropertyUnit() { return this.propertyUnit; } /** *

* The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. *

* * @param propertyUnit * The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this * parameter, the service uses the value of the assetModelProperty in the asset model. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssetPropertyRequest withPropertyUnit(String propertyUnit) { setPropertyUnit(propertyUnit); 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 (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 (getPropertyNotificationState() != null) sb.append("PropertyNotificationState: ").append(getPropertyNotificationState()).append(","); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()).append(","); if (getPropertyUnit() != null) sb.append("PropertyUnit: ").append(getPropertyUnit()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateAssetPropertyRequest == false) return false; UpdateAssetPropertyRequest other = (UpdateAssetPropertyRequest) obj; 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.getPropertyNotificationState() == null ^ this.getPropertyNotificationState() == null) return false; if (other.getPropertyNotificationState() != null && other.getPropertyNotificationState().equals(this.getPropertyNotificationState()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; if (other.getPropertyUnit() == null ^ this.getPropertyUnit() == null) return false; if (other.getPropertyUnit() != null && other.getPropertyUnit().equals(this.getPropertyUnit()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; 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 + ((getPropertyNotificationState() == null) ? 0 : getPropertyNotificationState().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); hashCode = prime * hashCode + ((getPropertyUnit() == null) ? 0 : getPropertyUnit().hashCode()); return hashCode; } @Override public UpdateAssetPropertyRequest clone() { return (UpdateAssetPropertyRequest) super.clone(); } }