Class UpdateAssetModelCompositeModelRequest

    • Method Detail

      • assetModelId

        public final String assetModelId()

        The ID of the asset model, in UUID format.

        Returns:
        The ID of the asset model, in UUID format.
      • assetModelCompositeModelId

        public final String assetModelCompositeModelId()

        The ID of a composite model on this asset model.

        Returns:
        The ID of a composite model on this asset model.
      • assetModelCompositeModelExternalId

        public final String assetModelCompositeModelExternalId()

        An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.

        Returns:
        An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
      • assetModelCompositeModelDescription

        public final String assetModelCompositeModelDescription()

        A description for the composite model.

        Returns:
        A description for the composite model.
      • assetModelCompositeModelName

        public final String assetModelCompositeModelName()

        A unique name for the composite model.

        Returns:
        A unique name for the composite model.
      • 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.
      • hasAssetModelCompositeModelProperties

        public final boolean hasAssetModelCompositeModelProperties()
        For responses, this returns true if the service returned a value for the AssetModelCompositeModelProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • assetModelCompositeModelProperties

        public final List<AssetModelProperty> assetModelCompositeModelProperties()

        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

        You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssetModelCompositeModelProperties() method.

        Returns:
        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

        You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

      • ifMatch

        public final String ifMatch()

        The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

        Returns:
        The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
      • ifNoneMatch

        public final String ifNoneMatch()

        Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

        Returns:
        Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
      • matchForVersionType

        public final AssetModelVersionType matchForVersionType()

        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.

        If the service returns an enum value that is not available in the current SDK version, matchForVersionType will return AssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchForVersionTypeAsString().

        Returns:
        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
        See Also:
        AssetModelVersionType
      • matchForVersionTypeAsString

        public final String matchForVersionTypeAsString()

        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.

        If the service returns an enum value that is not available in the current SDK version, matchForVersionType will return AssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchForVersionTypeAsString().

        Returns:
        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
        See Also:
        AssetModelVersionType
      • 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