001 002package com.commercetools.api.models.subscription; 003 004import java.time.*; 005import java.util.*; 006import java.util.function.Function; 007 008import javax.annotation.Nullable; 009import javax.validation.constraints.NotNull; 010 011import com.fasterxml.jackson.annotation.*; 012import com.fasterxml.jackson.databind.annotation.*; 013 014import io.vrap.rmf.base.client.utils.Generated; 015 016/** 017 * PayloadNotIncluded 018 * 019 * <hr> 020 * Example to create an instance using the builder pattern 021 * <div class=code-example> 022 * <pre><code class='java'> 023 * PayloadNotIncluded payloadNotIncluded = PayloadNotIncluded.builder() 024 * .reason("{reason}") 025 * .payloadType("{payloadType}") 026 * .build() 027 * </code></pre> 028 * </div> 029 */ 030@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen") 031@JsonDeserialize(as = PayloadNotIncludedImpl.class) 032public interface PayloadNotIncluded { 033 034 /** 035 * <p>Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.</p> 036 * @return reason 037 */ 038 @NotNull 039 @JsonProperty("reason") 040 public String getReason(); 041 042 /** 043 * <p>Value of the <code>type</code> field in the original payload.</p> 044 * @return payloadType 045 */ 046 @NotNull 047 @JsonProperty("payloadType") 048 public String getPayloadType(); 049 050 /** 051 * <p>Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.</p> 052 * @param reason value to be set 053 */ 054 055 public void setReason(final String reason); 056 057 /** 058 * <p>Value of the <code>type</code> field in the original payload.</p> 059 * @param payloadType value to be set 060 */ 061 062 public void setPayloadType(final String payloadType); 063 064 /** 065 * factory method 066 * @return instance of PayloadNotIncluded 067 */ 068 public static PayloadNotIncluded of() { 069 return new PayloadNotIncludedImpl(); 070 } 071 072 /** 073 * factory method to create a shallow copy PayloadNotIncluded 074 * @param template instance to be copied 075 * @return copy instance 076 */ 077 public static PayloadNotIncluded of(final PayloadNotIncluded template) { 078 PayloadNotIncludedImpl instance = new PayloadNotIncludedImpl(); 079 instance.setReason(template.getReason()); 080 instance.setPayloadType(template.getPayloadType()); 081 return instance; 082 } 083 084 /** 085 * factory method to create a deep copy of PayloadNotIncluded 086 * @param template instance to be copied 087 * @return copy instance 088 */ 089 @Nullable 090 public static PayloadNotIncluded deepCopy(@Nullable final PayloadNotIncluded template) { 091 if (template == null) { 092 return null; 093 } 094 PayloadNotIncludedImpl instance = new PayloadNotIncludedImpl(); 095 instance.setReason(template.getReason()); 096 instance.setPayloadType(template.getPayloadType()); 097 return instance; 098 } 099 100 /** 101 * builder factory method for PayloadNotIncluded 102 * @return builder 103 */ 104 public static PayloadNotIncludedBuilder builder() { 105 return PayloadNotIncludedBuilder.of(); 106 } 107 108 /** 109 * create builder for PayloadNotIncluded instance 110 * @param template instance with prefilled values for the builder 111 * @return builder 112 */ 113 public static PayloadNotIncludedBuilder builder(final PayloadNotIncluded template) { 114 return PayloadNotIncludedBuilder.of(template); 115 } 116 117 /** 118 * accessor map function 119 * @param <T> mapped type 120 * @param helper function to map the object 121 * @return mapped value 122 */ 123 default <T> T withPayloadNotIncluded(Function<PayloadNotIncluded, T> helper) { 124 return helper.apply(this); 125 } 126 127 /** 128 * gives a TypeReference for usage with Jackson DataBind 129 * @return TypeReference 130 */ 131 public static com.fasterxml.jackson.core.type.TypeReference<PayloadNotIncluded> typeReference() { 132 return new com.fasterxml.jackson.core.type.TypeReference<PayloadNotIncluded>() { 133 @Override 134 public String toString() { 135 return "TypeReference<PayloadNotIncluded>"; 136 } 137 }; 138 } 139}