Interface VariableValue.Builder

All Superinterfaces:
Buildable, CopyableBuilder<VariableValue.Builder,VariableValue>, SdkBuilder<VariableValue.Builder,VariableValue>, SdkPojo
Enclosing class:
VariableValue
@Mutable @NotThreadSafe public static interface VariableValue.Builder extends SdkPojo, CopyableBuilder<VariableValue.Builder,VariableValue>

  • Method Details

    • propertyId

      VariableValue.Builder propertyId(String propertyId)

      The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

      Parameters:
      propertyId - The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hierarchyId

      VariableValue.Builder hierarchyId(String hierarchyId)

      The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

      You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

      Parameters:
      hierarchyId - The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

      You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

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

    • propertyPath

      VariableValue.Builder propertyPath(Collection<AssetModelPropertyPathSegment> propertyPath)

      The path of the property.

      Parameters:
      propertyPath - The path of the property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyPath

      VariableValue.Builder propertyPath(AssetModelPropertyPathSegment... propertyPath)

      The path of the property.

      Parameters:
      propertyPath - The path of the property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyPath

      VariableValue.Builder propertyPath(Consumer<AssetModelPropertyPathSegment.Builder>... propertyPath)

      The path of the property.

      This is a convenience method that creates an instance of the AssetModelPropertyPathSegment.Builder avoiding the need to create one manually via AssetModelPropertyPathSegment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to propertyPath(List<AssetModelPropertyPathSegment>).

      Parameters:
      propertyPath - a consumer that will call methods on AssetModelPropertyPathSegment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: