Package com.commercetools.ml.models.common

Interface TaskToken

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 Details

    • getTaskId

      @NotNull @NotNull String getTaskId()

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

      Returns:
      taskId

    • getUriPath

      @NotNull @NotNull String getUriPath()

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

      Returns:
      uriPath

    • setTaskId

      void setTaskId(String taskId)

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

      Parameters:
      taskId - value to be set

    • setUriPath

      void setUriPath(String uriPath)

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

      Parameters:
      uriPath - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TaskTokenBuilder builder()
      builder factory method for TaskToken
      Returns:
      builder

    • builder

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

    • withTaskToken

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