software.amazon.awssdk.services.iotsitewise.model.UpdateAssetPropertyRequest Maven / Gradle / Ivy
Show all versions of iotsitewise Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.iotsitewise.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateAssetPropertyRequest extends IoTSiteWiseRequest implements
ToCopyableBuilder {
private static final SdkField ASSET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("assetId").getter(getter(UpdateAssetPropertyRequest::assetId)).setter(setter(Builder::assetId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("assetId").build()).build();
private static final SdkField PROPERTY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("propertyId").getter(getter(UpdateAssetPropertyRequest::propertyId)).setter(setter(Builder::propertyId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("propertyId").build()).build();
private static final SdkField PROPERTY_ALIAS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("propertyAlias").getter(getter(UpdateAssetPropertyRequest::propertyAlias))
.setter(setter(Builder::propertyAlias))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("propertyAlias").build()).build();
private static final SdkField PROPERTY_NOTIFICATION_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("propertyNotificationState")
.getter(getter(UpdateAssetPropertyRequest::propertyNotificationStateAsString))
.setter(setter(Builder::propertyNotificationState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("propertyNotificationState").build())
.build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(UpdateAssetPropertyRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField PROPERTY_UNIT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("propertyUnit").getter(getter(UpdateAssetPropertyRequest::propertyUnit))
.setter(setter(Builder::propertyUnit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("propertyUnit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ASSET_ID_FIELD,
PROPERTY_ID_FIELD, PROPERTY_ALIAS_FIELD, PROPERTY_NOTIFICATION_STATE_FIELD, CLIENT_TOKEN_FIELD, PROPERTY_UNIT_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("assetId", ASSET_ID_FIELD);
put("propertyId", PROPERTY_ID_FIELD);
put("propertyAlias", PROPERTY_ALIAS_FIELD);
put("propertyNotificationState", PROPERTY_NOTIFICATION_STATE_FIELD);
put("clientToken", CLIENT_TOKEN_FIELD);
put("propertyUnit", PROPERTY_UNIT_FIELD);
}
});
private final String assetId;
private final String propertyId;
private final String propertyAlias;
private final String propertyNotificationState;
private final String clientToken;
private final String propertyUnit;
private UpdateAssetPropertyRequest(BuilderImpl builder) {
super(builder);
this.assetId = builder.assetId;
this.propertyId = builder.propertyId;
this.propertyAlias = builder.propertyAlias;
this.propertyNotificationState = builder.propertyNotificationState;
this.clientToken = builder.clientToken;
this.propertyUnit = builder.propertyUnit;
}
/**
*
* The ID of the asset to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*
*
* @return The ID of the asset to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*/
public final String assetId() {
return assetId;
}
/**
*
* The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*
*
* @return The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*/
public final String propertyId() {
return 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.
*
*
* @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 final String propertyAlias() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #propertyNotificationState} will return {@link PropertyNotificationState#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #propertyNotificationStateAsString}.
*
*
* @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 final PropertyNotificationState propertyNotificationState() {
return PropertyNotificationState.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #propertyNotificationState} will return {@link PropertyNotificationState#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #propertyNotificationStateAsString}.
*
*
* @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 final String propertyNotificationStateAsString() {
return 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.
*
*
* @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 final String clientToken() {
return 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.
*
*
* @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 final String propertyUnit() {
return propertyUnit;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(assetId());
hashCode = 31 * hashCode + Objects.hashCode(propertyId());
hashCode = 31 * hashCode + Objects.hashCode(propertyAlias());
hashCode = 31 * hashCode + Objects.hashCode(propertyNotificationStateAsString());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(propertyUnit());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateAssetPropertyRequest)) {
return false;
}
UpdateAssetPropertyRequest other = (UpdateAssetPropertyRequest) obj;
return Objects.equals(assetId(), other.assetId()) && Objects.equals(propertyId(), other.propertyId())
&& Objects.equals(propertyAlias(), other.propertyAlias())
&& Objects.equals(propertyNotificationStateAsString(), other.propertyNotificationStateAsString())
&& Objects.equals(clientToken(), other.clientToken()) && Objects.equals(propertyUnit(), other.propertyUnit());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("UpdateAssetPropertyRequest").add("AssetId", assetId()).add("PropertyId", propertyId())
.add("PropertyAlias", propertyAlias()).add("PropertyNotificationState", propertyNotificationStateAsString())
.add("ClientToken", clientToken()).add("PropertyUnit", propertyUnit()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "assetId":
return Optional.ofNullable(clazz.cast(assetId()));
case "propertyId":
return Optional.ofNullable(clazz.cast(propertyId()));
case "propertyAlias":
return Optional.ofNullable(clazz.cast(propertyAlias()));
case "propertyNotificationState":
return Optional.ofNullable(clazz.cast(propertyNotificationStateAsString()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "propertyUnit":
return Optional.ofNullable(clazz.cast(propertyUnit()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateAssetPropertyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the asset to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*
*
* @param assetId
* The ID of the asset to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder assetId(String assetId);
/**
*
* The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
*
*
* @param propertyId
* The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else
* externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder propertyId(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.
*
*
* @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.
*/
Builder propertyAlias(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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see PropertyNotificationState
*/
Builder propertyNotificationState(String 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.
* @see PropertyNotificationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see PropertyNotificationState
*/
Builder propertyNotificationState(PropertyNotificationState 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.
*
*
* @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.
*/
Builder clientToken(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.
*
*
* @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.
*/
Builder propertyUnit(String propertyUnit);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IoTSiteWiseRequest.BuilderImpl implements Builder {
private String assetId;
private String propertyId;
private String propertyAlias;
private String propertyNotificationState;
private String clientToken;
private String propertyUnit;
private BuilderImpl() {
}
private BuilderImpl(UpdateAssetPropertyRequest model) {
super(model);
assetId(model.assetId);
propertyId(model.propertyId);
propertyAlias(model.propertyAlias);
propertyNotificationState(model.propertyNotificationState);
clientToken(model.clientToken);
propertyUnit(model.propertyUnit);
}
public final String getAssetId() {
return assetId;
}
public final void setAssetId(String assetId) {
this.assetId = assetId;
}
@Override
public final Builder assetId(String assetId) {
this.assetId = assetId;
return this;
}
public final String getPropertyId() {
return propertyId;
}
public final void setPropertyId(String propertyId) {
this.propertyId = propertyId;
}
@Override
public final Builder propertyId(String propertyId) {
this.propertyId = propertyId;
return this;
}
public final String getPropertyAlias() {
return propertyAlias;
}
public final void setPropertyAlias(String propertyAlias) {
this.propertyAlias = propertyAlias;
}
@Override
public final Builder propertyAlias(String propertyAlias) {
this.propertyAlias = propertyAlias;
return this;
}
public final String getPropertyNotificationState() {
return propertyNotificationState;
}
public final void setPropertyNotificationState(String propertyNotificationState) {
this.propertyNotificationState = propertyNotificationState;
}
@Override
public final Builder propertyNotificationState(String propertyNotificationState) {
this.propertyNotificationState = propertyNotificationState;
return this;
}
@Override
public final Builder propertyNotificationState(PropertyNotificationState propertyNotificationState) {
this.propertyNotificationState(propertyNotificationState == null ? null : propertyNotificationState.toString());
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getPropertyUnit() {
return propertyUnit;
}
public final void setPropertyUnit(String propertyUnit) {
this.propertyUnit = propertyUnit;
}
@Override
public final Builder propertyUnit(String propertyUnit) {
this.propertyUnit = propertyUnit;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateAssetPropertyRequest build() {
return new UpdateAssetPropertyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}