001
002package com.commercetools.api.models.error;
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 *  <p>Returned when a value is not defined for a required field.</p>
018 *
019 * <hr>
020 * Example to create an instance using the builder pattern
021 * <div class=code-example>
022 * <pre><code class='java'>
023 *     RequiredFieldError requiredFieldError = RequiredFieldError.builder()
024 *             .message("{message}")
025 *             .field("{field}")
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 = RequiredFieldErrorImpl.class)
032public interface RequiredFieldError extends ErrorObject {
033
034    /**
035     * discriminator value for RequiredFieldError
036     */
037    String REQUIRED_FIELD = "RequiredField";
038
039    /**
040     *
041     * @return code
042     */
043    @NotNull
044    @JsonProperty("code")
045    public String getCode();
046
047    /**
048     *  <p><code>"A value is required for field $field."</code></p>
049     * @return message
050     */
051    @NotNull
052    @JsonProperty("message")
053    public String getMessage();
054
055    /**
056     *  <p>Name of the field missing the value.</p>
057     * @return field
058     */
059    @NotNull
060    @JsonProperty("field")
061    public String getField();
062
063    /**
064     *  <p><code>"A value is required for field $field."</code></p>
065     * @param message value to be set
066     */
067
068    public void setMessage(final String message);
069
070    /**
071     *  <p>Name of the field missing the value.</p>
072     * @param field value to be set
073     */
074
075    public void setField(final String field);
076
077    /**
078     * factory method
079     * @return instance of RequiredFieldError
080     */
081    public static RequiredFieldError of() {
082        return new RequiredFieldErrorImpl();
083    }
084
085    /**
086     * factory method to create a shallow copy RequiredFieldError
087     * @param template instance to be copied
088     * @return copy instance
089     */
090    public static RequiredFieldError of(final RequiredFieldError template) {
091        RequiredFieldErrorImpl instance = new RequiredFieldErrorImpl();
092        instance.setMessage(template.getMessage());
093        Optional.ofNullable(template.values()).ifPresent(t -> t.forEach(instance::setValue));
094        instance.setField(template.getField());
095        return instance;
096    }
097
098    /**
099     * factory method to create a deep copy of RequiredFieldError
100     * @param template instance to be copied
101     * @return copy instance
102     */
103    @Nullable
104    public static RequiredFieldError deepCopy(@Nullable final RequiredFieldError template) {
105        if (template == null) {
106            return null;
107        }
108        RequiredFieldErrorImpl instance = new RequiredFieldErrorImpl();
109        instance.setMessage(template.getMessage());
110        Optional.ofNullable(template.values()).ifPresent(t -> t.forEach(instance::setValue));
111        instance.setField(template.getField());
112        return instance;
113    }
114
115    /**
116     * builder factory method for RequiredFieldError
117     * @return builder
118     */
119    public static RequiredFieldErrorBuilder builder() {
120        return RequiredFieldErrorBuilder.of();
121    }
122
123    /**
124     * create builder for RequiredFieldError instance
125     * @param template instance with prefilled values for the builder
126     * @return builder
127     */
128    public static RequiredFieldErrorBuilder builder(final RequiredFieldError template) {
129        return RequiredFieldErrorBuilder.of(template);
130    }
131
132    /**
133     * accessor map function
134     * @param <T> mapped type
135     * @param helper function to map the object
136     * @return mapped value
137     */
138    default <T> T withRequiredFieldError(Function<RequiredFieldError, T> helper) {
139        return helper.apply(this);
140    }
141
142    /**
143     * gives a TypeReference for usage with Jackson DataBind
144     * @return TypeReference
145     */
146    public static com.fasterxml.jackson.core.type.TypeReference<RequiredFieldError> typeReference() {
147        return new com.fasterxml.jackson.core.type.TypeReference<RequiredFieldError>() {
148            @Override
149            public String toString() {
150                return "TypeReference<RequiredFieldError>";
151            }
152        };
153    }
154}