com.commercetools.ml.models.common

Interface TaskToken

All Known Implementing Classes:

TaskTokenImpl

public interface TaskToken

Represents a URL path to poll to get the results of an Asynchronous Request.

Example to create an instance using the builder pattern

     TaskToken taskToken = TaskToken.builder()
             .taskId("{taskId}")
             .uriPath("{uriPath}")
             .build()
 

Method Summary

Modifier and Type	Method and Description
static TaskTokenBuilder	builder()
static TaskTokenBuilder	builder(TaskToken template)
@NotNull String	getTaskId() The ID for the task.
@NotNull String	getUriPath() The URI path to poll for the status of the task.
static TaskToken	of()
static TaskToken	of(TaskToken template)
void	setTaskId(String taskId)
void	setUriPath(String uriPath)
static com.fasterxml.jackson.core.type.TypeReference<TaskToken>	typeReference()
default <T> T	withTaskToken(Function<TaskToken,T> helper)

Method Detail

getTaskId

@NotNull
@NotNull String getTaskId()

The ID for the task. Used to find the status of the task.

getUriPath

@NotNull
@NotNull String getUriPath()

The URI path to poll for the status of the task.

setTaskId

void setTaskId(String taskId)

setUriPath

void setUriPath(String uriPath)

of

static TaskToken of()

of

static TaskToken of(TaskToken template)

builder

static TaskTokenBuilder builder()

builder

static TaskTokenBuilder builder(TaskToken template)

withTaskToken

default <T> T withTaskToken(Function<TaskToken,T> helper)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<TaskToken> typeReference()