Package software.amazon.awssdk.services.iotsitewise.model

Interface UpdateAssetPropertyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateAssetPropertyRequest
public static interface UpdateAssetPropertyRequest.Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<UpdateAssetPropertyRequest.Builder,UpdateAssetPropertyRequest>

  • Method Details

    • assetId

      UpdateAssetPropertyRequest.Builder assetId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • propertyId

      UpdateAssetPropertyRequest.Builder propertyId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • propertyAlias

      UpdateAssetPropertyRequest.Builder propertyAlias(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • propertyNotificationState

      UpdateAssetPropertyRequest.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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propertyNotificationState

      UpdateAssetPropertyRequest.Builder propertyNotificationState(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      UpdateAssetPropertyRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • propertyUnit

      UpdateAssetPropertyRequest.Builder propertyUnit(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateAssetPropertyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAssetPropertyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.