Package com.commercetools.api.models.variant

Interface VariantBulkUpdateResponse

public interface VariantBulkUpdateResponse

The response body for a bulk update of Variants. Contains the individual result for each Variant in the request.

Example to create an instance using the builder pattern 

     VariantBulkUpdateResponse variantBulkUpdateResponse = VariantBulkUpdateResponse.builder()
             .successCount(0.3)
             .failureCount(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getSuccessCount

      @NotNull @NotNull Integer getSuccessCount()

      Number of Variants that were successfully updated.

      Returns:
      successCount

    • getFailureCount

      @NotNull @NotNull Integer getFailureCount()

      Number of Variants that failed to update.

      Returns:
      failureCount

    • getResults

      @NotNull @Valid @NotNull @Valid List<VariantBulkUpdateResult> getResults()

      Results for each Variant in the request, in the same order as the items in the request body.

      Returns:
      results

    • setSuccessCount

      void setSuccessCount(Integer successCount)

      Number of Variants that were successfully updated.

      Parameters:
      successCount - value to be set

    • setFailureCount

      void setFailureCount(Integer failureCount)

      Number of Variants that failed to update.

      Parameters:
      failureCount - value to be set

    • setResults

      void setResults(VariantBulkUpdateResult... results)

      Results for each Variant in the request, in the same order as the items in the request body.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<VariantBulkUpdateResult> results)

      Results for each Variant in the request, in the same order as the items in the request body.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • copyDeep

      VariantBulkUpdateResponse copyDeep()

    • deepCopy

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

    • builder

      static VariantBulkUpdateResponseBuilder builder()
      builder factory method for VariantBulkUpdateResponse
      Returns:
      builder

    • builder

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

    • withVariantBulkUpdateResponse

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