Class JobStatusQueryResponse


  • public class JobStatusQueryResponse
    extends ControllerResponse
    Response for querying job status.
    • Constructor Detail

      • JobStatusQueryResponse

        public JobStatusQueryResponse()
    • Method Detail

      • getVersion

        public int getVersion()
      • setVersion

        public void setVersion​(int version)
      • getStatus

        public java.lang.String getStatus()
      • setStatus

        public void setStatus​(java.lang.String status)
      • getOptionalStatusDetails

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

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

        public void setStatusDetails​(java.lang.String statusDetails)
      • getStatusUpdateTimestamp

        public java.lang.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​(java.lang.Long statusUpdateTimestamp)
      • getExtraInfo

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.String> extraInfo)
      • getOptionalExtraDetails

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.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 java.util.Map<java.lang.String,​java.lang.String> getExtraDetails()
        Deprecated.
        Only used for JSON serialization purposes. Use getOptionalExtraDetails() instead.
      • setExtraDetails

        public void setExtraDetails​(java.util.Map<java.lang.String,​java.lang.String> extraDetails)
      • getExtraInfoUpdateTimestamp

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Long> extraInfoUpdateTimestamp)
      • setUncompletedPartitions

        public void setUncompletedPartitions​(java.util.List<UncompletedPartition> uncompletedPartitions)