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

Class UpdateAssetModelRequest

    • Method Detail

      • assetModelId

        public final String assetModelId()

        The ID of the asset model to update. 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 model to update. 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.

      • assetModelExternalId

        public final String assetModelExternalId()

        An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

        Returns:
        An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

      • assetModelName

        public final String assetModelName()

        A unique name for the asset model.

        Returns:
        A unique name for the asset model.

      • assetModelDescription

        public final String assetModelDescription()

        A description for the asset model.

        Returns:
        A description for the asset model.

      • hasAssetModelProperties

        public final boolean hasAssetModelProperties()
        For responses, this returns true if the service returned a value for the AssetModelProperties 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.

      • assetModelProperties

        public final List<AssetModelProperty> assetModelProperties()

        The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset 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 hasAssetModelProperties() method.

        Returns:
        The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

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

      • hasAssetModelHierarchies

        public final boolean hasAssetModelHierarchies()
        For responses, this returns true if the service returned a value for the AssetModelHierarchies 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.

      • assetModelHierarchies

        public final List<AssetModelHierarchy> assetModelHierarchies()

        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset 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 hasAssetModelHierarchies() method.

        Returns:
        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

      • hasAssetModelCompositeModels

        public final boolean hasAssetModelCompositeModels()
        For responses, this returns true if the service returned a value for the AssetModelCompositeModels 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.

      • assetModelCompositeModels

        public final List<AssetModelCompositeModel> assetModelCompositeModels()

        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) 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 hasAssetModelCompositeModels() method.

        Returns:
        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

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

      • 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