Package com.linkedin.venice.controllerapi

Class JobStatusQueryResponse

java.lang.Object
com.linkedin.venice.controllerapi.ControllerResponse
com.linkedin.venice.controllerapi.JobStatusQueryResponse
public class JobStatusQueryResponse extends ControllerResponse
Response for querying job status.

  • Constructor Details

    • JobStatusQueryResponse

      public JobStatusQueryResponse()

  • Method Details

    • getVersion

      public int getVersion()

    • setVersion

      public void setVersion(int version)

    • getStatus

      public String getStatus()

    • setStatus

      public void setStatus(String status)

    • getOptionalStatusDetails

      public Optional<String> getOptionalStatusDetails()
      N.B.: Older versions of the controller did not support these details, so the optional can be empty.

    • getStatusDetails

      @Deprecated public String getStatusDetails()
      Deprecated.
      Only used for JSON serialization purposes. Use getOptionalExtraDetails() instead.

    • setStatusDetails

      public void setStatusDetails(String statusDetails)

    • getStatusUpdateTimestamp

      public Long getStatusUpdateTimestamp()
      N.B.: Older versions of the controller did not support this timestamp, so this can be null.
      Returns:
      the UNIX Epoch timestamp when the value of getStatus() was last updated (for child controllers), null for parent controllers and for older versions of child controllers.

    • setStatusUpdateTimestamp

      public void setStatusUpdateTimestamp(Long statusUpdateTimestamp)

    • getExtraInfo

      public Map<String,String> getExtraInfo()
      N.B.: The values in this map conform to ExecutionStatus values.
      Returns:
      A map of region name -> status, which can be returned by a parent controller.

    • setExtraInfo

      public void setExtraInfo(Map<String,String> extraInfo)

    • getOptionalExtraDetails

      public Optional<Map<String,String>> getOptionalExtraDetails()
      N.B.: Older versions of the controller did not support these details, so the optional can be empty.
      Returns:
      A map of region name -> status details, which can be returned by a parent controller.

    • getExtraDetails

      @Deprecated public Map<String,String> getExtraDetails()
      Deprecated.
      Only used for JSON serialization purposes. Use getOptionalExtraDetails() instead.

    • setExtraDetails

      public void setExtraDetails(Map<String,String> extraDetails)

    • getExtraInfoUpdateTimestamp

      public Map<String,Long> getExtraInfoUpdateTimestamp()
      N.B.: Older versions of the controller did not support these timestamps, so this map can be null.
      Returns:
      a map of region name -> UNIX Epoch timestamp indicating when the value corresponding to the same key in getExtraInfo() was last updated, or null if not available.

    • setExtraInfoUpdateTimestamp

      public void setExtraInfoUpdateTimestamp(Map<String,Long> extraInfoUpdateTimestamp)

    • setUncompletedPartitions

      public void setUncompletedPartitions(List<UncompletedPartition> uncompletedPartitions)

    • getUncompletedPartitions

      public List<UncompletedPartition> getUncompletedPartitions()

    • toString

      public String toString()
      Overrides:
      toString in class ControllerResponse