Package com.commercetools.api.models.subscription

Interface PayloadNotIncluded

public interface PayloadNotIncluded
PayloadNotIncluded
Example to create an instance using the builder pattern 

     PayloadNotIncluded payloadNotIncluded = PayloadNotIncluded.builder()
             .reason("{reason}")
             .payloadType("{payloadType}")
             .build()

  • Method Details

    • getReason

      @NotNull @NotNull String getReason()

      Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.

      Returns:
      reason

    • getPayloadType

      @NotNull @NotNull String getPayloadType()

      Value of the type field in the original payload.

      Returns:
      payloadType

    • setReason

      void setReason(String reason)

      Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.

      Parameters:
      reason - value to be set

    • setPayloadType

      void setPayloadType(String payloadType)

      Value of the type field in the original payload.

      Parameters:
      payloadType - value to be set

    • of

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

    • of

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

    • copyDeep

      PayloadNotIncluded copyDeep()

    • deepCopy

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

    • builder

      static PayloadNotIncludedBuilder builder()
      builder factory method for PayloadNotIncluded
      Returns:
      builder

    • builder

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

    • withPayloadNotIncluded

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