Package com.commercetools.api.models.common

Interface AssetSource

All Superinterfaces:
WithKey
public interface AssetSource extends WithKey

Representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.

Example to create an instance using the builder pattern 

     AssetSource assetSource = AssetSource.builder()
             .uri("{uri}")
             .build()

  • Method Details

    • getUri

      @NotNull @NotNull String getUri()

      URI of the AssetSource.

      Returns:
      uri

    • getKey

      String getKey()

      User-defined identifier of the AssetSource. Must be unique per Asset.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getDimensions

      @Valid @Valid AssetDimensions getDimensions()

      Width and height of the AssetSource.

      Returns:
      dimensions

    • getContentType

      String getContentType()

      Indicates the type of content, for example application/pdf.

      Returns:
      contentType

    • setUri

      void setUri(String uri)

      URI of the AssetSource.

      Parameters:
      uri - value to be set

    • setKey

      void setKey(String key)

      User-defined identifier of the AssetSource. Must be unique per Asset.

      Parameters:
      key - value to be set

    • setDimensions

      void setDimensions(AssetDimensions dimensions)

      Width and height of the AssetSource.

      Parameters:
      dimensions - value to be set

    • setContentType

      void setContentType(String contentType)

      Indicates the type of content, for example application/pdf.

      Parameters:
      contentType - value to be set

    • of

      static AssetSource of()
      factory method
      Returns:
      instance of AssetSource

    • of

      static AssetSource of(AssetSource template)
      factory method to create a shallow copy AssetSource
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static AssetSource deepCopy(@Nullable AssetSource template)
      factory method to create a deep copy of AssetSource
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static AssetSourceBuilder builder()
      builder factory method for AssetSource
      Returns:
      builder

    • builder

      static AssetSourceBuilder builder(AssetSource template)
      create builder for AssetSource instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withAssetSource

      default <T> T withAssetSource(Function<AssetSource,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<AssetSource> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference