001
002package com.commercetools.ml.models.common;
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>Represents a URL path to poll to get the results of an Asynchronous Request.</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 *     TaskToken taskToken = TaskToken.builder()
024 *             .taskId("{taskId}")
025 *             .uriPath("{uriPath}")
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 = TaskTokenImpl.class)
032public interface TaskToken {
033
034    /**
035     *  <p>The ID for the task. Used to find the status of the task.</p>
036     * @return taskId
037     */
038    @NotNull
039    @JsonProperty("taskId")
040    public String getTaskId();
041
042    /**
043     *  <p>The URI path to poll for the status of the task.</p>
044     * @return uriPath
045     */
046    @NotNull
047    @JsonProperty("uriPath")
048    public String getUriPath();
049
050    /**
051     *  <p>The ID for the task. Used to find the status of the task.</p>
052     * @param taskId value to be set
053     */
054
055    public void setTaskId(final String taskId);
056
057    /**
058     *  <p>The URI path to poll for the status of the task.</p>
059     * @param uriPath value to be set
060     */
061
062    public void setUriPath(final String uriPath);
063
064    /**
065     * factory method
066     * @return instance of TaskToken
067     */
068    public static TaskToken of() {
069        return new TaskTokenImpl();
070    }
071
072    /**
073     * factory method to create a shallow copy TaskToken
074     * @param template instance to be copied
075     * @return copy instance
076     */
077    public static TaskToken of(final TaskToken template) {
078        TaskTokenImpl instance = new TaskTokenImpl();
079        instance.setTaskId(template.getTaskId());
080        instance.setUriPath(template.getUriPath());
081        return instance;
082    }
083
084    /**
085     * factory method to create a deep copy of TaskToken
086     * @param template instance to be copied
087     * @return copy instance
088     */
089    @Nullable
090    public static TaskToken deepCopy(@Nullable final TaskToken template) {
091        if (template == null) {
092            return null;
093        }
094        TaskTokenImpl instance = new TaskTokenImpl();
095        instance.setTaskId(template.getTaskId());
096        instance.setUriPath(template.getUriPath());
097        return instance;
098    }
099
100    /**
101     * builder factory method for TaskToken
102     * @return builder
103     */
104    public static TaskTokenBuilder builder() {
105        return TaskTokenBuilder.of();
106    }
107
108    /**
109     * create builder for TaskToken instance
110     * @param template instance with prefilled values for the builder
111     * @return builder
112     */
113    public static TaskTokenBuilder builder(final TaskToken template) {
114        return TaskTokenBuilder.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 withTaskToken(Function<TaskToken, 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<TaskToken> typeReference() {
132        return new com.fasterxml.jackson.core.type.TypeReference<TaskToken>() {
133            @Override
134            public String toString() {
135                return "TypeReference<TaskToken>";
136            }
137        };
138    }
139}