java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
    - - software.amazon.awssdk.services.iotsitewise.model.UpdateAssetPropertyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateAssetPropertyRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateAssetPropertyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`assetId()`	The ID of the asset to be updated.
`static UpdateAssetPropertyRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`propertyAlias()`	The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`).
`String`	`propertyId()`	The ID of the asset property to be updated.
`PropertyNotificationState`	`propertyNotificationState()`	The MQTT notification state (enabled or disabled) for this asset property.
`String`	`propertyNotificationStateAsString()`	The MQTT notification state (enabled or disabled) for this asset property.
`String`	`propertyUnit()`	The unit of measure (such as Newtons or RPM) of the asset property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateAssetPropertyRequest.Builder>`	`serializableBuilderClass()`
`UpdateAssetPropertyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - assetId
```
public final String 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.
    
    Returns:
    
    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.
  - propertyId
```
public final String 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.
    
    Returns:
    
    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.
  - propertyAlias
```
public final String 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.
    
    Returns:
    
    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.
  - propertyNotificationState
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, propertyNotificationState will return PropertyNotificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propertyNotificationStateAsString().
    
    Returns:
    
    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 Also:
    
    PropertyNotificationState
  - propertyNotificationStateAsString
```
public final String propertyNotificationStateAsString()
```
    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, propertyNotificationState will return PropertyNotificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propertyNotificationStateAsString().
    
    Returns:
    
    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 Also:
    
    PropertyNotificationState
  - clientToken
```
public final String 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.
    
    Returns:
    
    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.
  - propertyUnit
```
public final String 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.
    
    Returns:
    
    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.
  - toBuilder
```
public UpdateAssetPropertyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>
    
    Specified by:
    
    toBuilder in class IoTSiteWiseRequest
  - builder
```
public static UpdateAssetPropertyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateAssetPropertyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateAssetPropertyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

assetId

propertyId

propertyAlias

propertyNotificationState

propertyNotificationStateAsString

clientToken

propertyUnit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields