Interface TaskOptions

All Superinterfaces:
HasMeta

@Immutable public interface TaskOptions extends HasMeta
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    default void
     
    @Nullable String
    id()
    Caller-supplied task ID to correlate with an external task runner, or null to auto-generate.
    @Nullable Duration
    How long after this task reaches a terminal state its result stays retrievable, or null to use the server default.
    @Nullable Map<String,Object>
    Returns the optional metadata map for protocol extensions.
    @Nullable Duration
    Suggested tasks/get polling interval to advertise, or null to use the server default.
    @Nullable Duration
    ttl()
     
  • Method Details

    • id

      @Nullable String id()
      Caller-supplied task ID to correlate with an external task runner, or null to auto-generate.
    • ttl

      @Nullable Duration ttl()
    • keepAlive

      @Nullable Duration keepAlive()
      How long after this task reaches a terminal state its result stays retrievable, or null to use the server default.
    • pollInterval

      @Nullable Duration pollInterval()
      Suggested tasks/get polling interval to advertise, or null to use the server default.
    • meta

      @Nullable Map<String,Object> meta()
      Description copied from interface: HasMeta
      Returns the optional metadata map for protocol extensions.
      Specified by:
      meta in interface HasMeta
      Returns:
      the metadata map, or null if none
    • check

      @Check default void check()
    • builder

      static TaskOptions.Builder builder()