Interface AssetModelProperty.Builder

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

  • Method Details

    • id

      AssetModelProperty.Builder id(String id)

      The ID of the asset model property.

      • If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

      • If you are calling UpdateAssetModel to modify an existing property: 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:
      id - The ID of the asset model property.

      • If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

      • If you are calling UpdateAssetModel to modify an existing property: 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.

    • externalId

      AssetModelProperty.Builder externalId(String externalId)

      The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

      Parameters:
      externalId - The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. 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.

    • name

      AssetModelProperty.Builder name(String name)

      The name of the asset model property.

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

    • dataType

      AssetModelProperty.Builder dataType(String dataType)

      The data type of the asset model property.

      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

      Parameters:
      dataType - The data type of the asset model property.

      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

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

    • dataType

      AssetModelProperty.Builder dataType(PropertyDataType dataType)

      The data type of the asset model property.

      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

      Parameters:
      dataType - The data type of the asset model property.

      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

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

    • dataTypeSpec

      AssetModelProperty.Builder dataTypeSpec(String dataTypeSpec)

      The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

      Parameters:
      dataTypeSpec - The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unit

      AssetModelProperty.Builder unit(String unit)

      The unit of the asset model property, such as Newtons or RPM.

      Parameters:
      unit - The unit of the asset model property, such as Newtons or RPM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      AssetModelProperty.Builder type(PropertyType type)

      The property type (see PropertyType).

      Parameters:
      type - The property type (see PropertyType).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      default AssetModelProperty.Builder type(Consumer<PropertyType.Builder> type)

      The property type (see PropertyType).

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to type(PropertyType).

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

    • path

      AssetModelProperty.Builder path(Collection<AssetModelPropertyPathSegment> path)

      The structured path to the property from the root of the asset model.

      Parameters:
      path - The structured path to the property from the root of the asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      AssetModelProperty.Builder path(AssetModelPropertyPathSegment... path)

      The structured path to the property from the root of the asset model.

      Parameters:
      path - The structured path to the property from the root of the asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      AssetModelProperty.Builder path(Consumer<AssetModelPropertyPathSegment.Builder>... path)

      The structured path to the property from the root of the asset model.

      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 path(List<AssetModelPropertyPathSegment>).

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