flinkwrapper

Type Members

1. case class CancelJobAccepted(requestId: Long, location: String) extends Product with Serializable

   

2. case class CancellationStatusInfo(status: CancellationStatus, requestId: Long, savepointPath: Option[String], failureCause: Option[String]) extends Product with Serializable

   

3. case class FlinkClusterOverview(taskManagers: Int, totalSlots: Int, availableSlots: Int, runningJobs: Int, finishedJobs: Int, cancelledJobs: Int, failedJobs: Int) extends Product with Serializable

   

4. case class FlinkConfigInfo(refreshInterval: Int, timezoneOffset: Duration, timezoneName: String, flinkVersion: String, flinkRevision: String) extends Product with Serializable

   

5. trait FlinkResponseHandler extends AnyRef

   

6. class FlinkRestClient extends AutoCloseable

   

   FlinkRestClient is the primary contact point for the Flink REST server.

   FlinkRestClient is the primary contact point for the Flink REST server.

   While this class can be invoked manually with a custom client configuration, it's recommended to use one of the factory methods on the FlinkRestClient object to create a client instance.

7. case class FlinkRestClientConfig(url: String, maybeActorSystem: Option[ActorSystem] = None, responseHandler: FlinkResponseHandler = FlinkResponseHandler) extends Product with Serializable

   

8. trait FlinkWrapperException extends RuntimeException

   

   FlinkWrapperException is the base class for all exceptions returned in failed futures by the wrapper.

   FlinkWrapperException is the base class for all exceptions returned in failed futures by the wrapper. If you don't care about different error handling for invalid JSON vs timeouts (etc), just handle this.

9. trait FlinkWrapperInvalidJsonException extends RuntimeException with FlinkWrapperException

   

   FlinkWrapperInvalidJsonException occurs when a valid HTTP status code is returned, but there's a problem parsing the response body into an object.

10. case class FlinkWrapperUnexpectedStatusCodeException(code: Int, responseBody: String) extends RuntimeException with FlinkWrapperException with Product with Serializable

    

    FlinkWrapperUnexpectedStatusCodeException occurs when an HTTP response has an unexpected (i.e.

    FlinkWrapperUnexpectedStatusCodeException occurs when an HTTP response has an unexpected (i.e. non-200, 204, etc) status code.

11. case class Job(id: String, name: String, isStoppable: Boolean, state: JobStatus, startTime: LocalDateTime, endTime: LocalDateTime, duration: Duration, now: LocalDateTime, stateTimestamps: StateTimes, vertices: Seq[JobVertex], statusCounts: VertexTaskCounts, plan: JobPlan) extends Product with Serializable

    

12. case class JobExceptions(rootException: Option[String], allExceptions: Seq[TaskException], truncated: Boolean) extends Product with Serializable

    

13. case class JobOverview(running: Seq[JobSummary], finished: Seq[JobSummary]) extends Product with Serializable

    

    JobOverview contains a summary of all jobs, grouped by status.

14. case class JobPlan(jobId: String, name: String, nodes: Seq[JobPlanNode]) extends Product with Serializable

    

15. case class JobPlanNode(id: String, parallelism: Int, operator: String, operatorStrategy: String, description: String, inputs: Option[Seq[NodeInput]], optimizerProperties: OptimizerProperties) extends Product with Serializable

    

16. case class JobSummary(id: String, name: String, state: JobStatus, startTime: LocalDateTime, endTime: LocalDateTime, duration: Duration, lastModification: LocalDateTime, taskCounts: TaskCounts) extends Product with Serializable

    

17. case class JobVertex(id: String, name: String, parallelism: Int, status: ExecutionStatus, startTime: Option[LocalDateTime], endTime: Option[LocalDateTime], duration: Option[Duration], taskCounts: VertexTaskCounts, metrics: VertexMetrics) extends Product with Serializable

    

18. case class JobsList(running: Seq[String], finished: Seq[String], cancelled: Seq[String], failed: Seq[String]) extends Product with Serializable

    

    JobsList is the result of a call to GET /jobs.

    JobsList is the result of a call to GET /jobs. It contains IDs of the jobs grouped by their statuses.

19. case class NodeInput(num: Long, id: String, shipStrategy: Option[String], localStrategy: Option[String], caching: Option[String], exchange: String) extends Product with Serializable

    

20. case class OptimizerProperties(globalProperties: Option[Map[String, String]], localProperties: Option[Map[String, String]], estimates: Option[Map[String, String]], costs: Option[Map[String, String]], compilerHints: Option[Map[String, String]]) extends Product with Serializable

    

21. case class RunProgramResult(jobId: String) extends Product with Serializable

    

22. case class StateTimes(createdTime: Option[LocalDateTime], runningTime: Option[LocalDateTime], failingTime: Option[LocalDateTime], failedTime: Option[LocalDateTime], cancellingTime: Option[LocalDateTime], canceledTime: Option[LocalDateTime], finishedTime: Option[LocalDateTime], restartingTime: Option[LocalDateTime], suspendedTime: Option[LocalDateTime], reconcilingTime: Option[LocalDateTime]) extends Product with Serializable

    

23. case class TaskCounts(total: Int, pending: Int, running: Int, finished: Int, canceling: Int, canceled: Int, failed: Int) extends Product with Serializable

    

24. case class TaskException(exception: String, task: String, location: String) extends Product with Serializable

    

25. case class UploadJarResult(status: String, filename: String) extends Product with Serializable

    

26. case class VertexMetrics(readBytes: Long, writeBytes: Long, readRecords: Long, writeRecords: Long) extends Product with Serializable

    

27. case class VertexTaskCounts(created: Long, scheduled: Long, deploying: Long, running: Long, finished: Long, canceling: Long, canceled: Long, failed: Long, reconciling: Long) extends Product with Serializable