Package com.commercetools.api.models.variant

Interface VariantBulkUpdateResult

All Known Subinterfaces:
VariantBulkUpdateFailResult, VariantBulkUpdateSuccessResult
public interface VariantBulkUpdateResult

Represents the result of a single Variant update within a bulk update request. Use status to determine whether the update succeeded or failed.

Example to create a subtype instance using the builder pattern 

     VariantBulkUpdateResult variantBulkUpdateResult = VariantBulkUpdateResult.failBuilder()
             plusErrors(errorsBuilder -> errorsBuilder)
             .build()

  • Method Details

    • getId

      String getId()

      Unique identifier of the Variant from the request. Present when the Variant was identified by id.

      Returns:
      id

    • getKey

      String getKey()

      User-defined unique identifier of the Variant from the request. Present when the Variant was identified by key.

      Returns:
      key

    • getStatus

      @NotNull @NotNull String getStatus()

      Indicates whether the update succeeded or failed.

      Returns:
      status

    • setId

      void setId(String id)

      Unique identifier of the Variant from the request. Present when the Variant was identified by id.

      Parameters:
      id - value to be set

    • setKey

      void setKey(String key)

      User-defined unique identifier of the Variant from the request. Present when the Variant was identified by key.

      Parameters:
      key - value to be set

    • copyDeep

      VariantBulkUpdateResult copyDeep()

    • deepCopy

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

    • failBuilder

      static VariantBulkUpdateFailResultBuilder failBuilder()
      builder for fail subtype
      Returns:
      builder

    • successBuilder

      static VariantBulkUpdateSuccessResultBuilder successBuilder()
      builder for success subtype
      Returns:
      builder

    • withVariantBulkUpdateResult

      default <T> T withVariantBulkUpdateResult(Function<VariantBulkUpdateResult,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<VariantBulkUpdateResult> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference