Package com.commercetools.api.models.variant

Interface VariantSetAssetCustomTypeAction

All Superinterfaces:
VariantUpdateAction
public interface VariantSetAssetCustomTypeAction extends VariantUpdateAction

Sets or removes the Custom Type on an existing Asset of a Variant. The Asset to update must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     VariantSetAssetCustomTypeAction variantSetAssetCustomTypeAction = VariantSetAssetCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_ASSET_CUSTOM_TYPE

      static final String SET_ASSET_CUSTOM_TYPE
      discriminator value for VariantSetAssetCustomTypeAction
      See Also:

  • Method Details

    • getStaged

      Boolean getStaged()

      If true, only the staged Asset is updated. If false, both the current and staged Asset is updated.

      Returns:
      staged

    • getAssetId

      String getAssetId()

      The id of the Asset to update.

      Returns:
      assetId

    • getAssetKey

      String getAssetKey()

      The key of the Asset to update.

      Returns:
      assetKey

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

      Defines the Type that extends the Asset with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Asset.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Sets the Custom Fields fields for the Asset.

      Returns:
      fields

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged Asset is updated. If false, both the current and staged Asset is updated.

      Parameters:
      staged - value to be set

    • setAssetId

      void setAssetId(String assetId)

      The id of the Asset to update.

      Parameters:
      assetId - value to be set

    • setAssetKey

      void setAssetKey(String assetKey)

      The key of the Asset to update.

      Parameters:
      assetKey - value to be set

    • setType

      void setType(TypeResourceIdentifier type)

      Defines the Type that extends the Asset with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Asset.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Sets the Custom Fields fields for the Asset.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantSetAssetCustomTypeAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantSetAssetCustomTypeActionBuilder builder()
      builder factory method for VariantSetAssetCustomTypeAction
      Returns:
      builder

    • builder

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

    • withVariantSetAssetCustomTypeAction

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

    • typeReference

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