FlinkRestClient

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def cancelJob(jobId: String)(implicit ec: ExecutionContext): Future[Unit]

   

   cancelJob cancels an in progress job.

   cancelJob cancels an in progress job.

   Note that even if the job ID does not exist or is not in a cancellable state, this still returns a success.

6. def cancelJobWithSavepoint(jobId: String, targetDirectory: Option[String] = None)(implicit ec: ExecutionContext): Future[CancelJobAccepted]

   

   cancelJob cancels an in progress job with a savepoint.

   cancelJob cancels an in progress job with a savepoint.

   If a target directory is supplied, it is used; otherwise, Flink defaults to the directory configured on the server.

   This method is asynchronous, on the Flink side; saving the state may take an extended period of time. The CancelJobAccepted.location can be fed into getCancellationStatus() to query the status of the cancellation.

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def close(): Unit

   

   close terminates the actor system and closes the underlying HTTP client.

   close terminates the actor system and closes the underlying HTTP client.

   This method must be called to properly clean up this client.

   Definition Classes

   FlinkRestClient → AutoCloseable

9. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def getCancellationStatus(location: String)(implicit ec: ExecutionContext): Future[CancellationStatusInfo]

    

    getCancellationStatus returns the status of a cancellation that is in progress (i.e.

    getCancellationStatus returns the status of a cancellation that is in progress (i.e. as the result of cancelJobWithSavepoint().

13. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

14. def getClusterOverview()(implicit ec: ExecutionContext): Future[FlinkClusterOverview]

    

    getClusterOverview returns the overview of the Flink cluster.

15. def getClusterTaskManagers()(implicit ec: ExecutionContext): Future[ClusterTaskManagers]

    

    getClusterTaskManagers gets a list of all task managers.

16. def getConfig()(implicit ec: ExecutionContext): Future[FlinkConfigInfo]

    

    getConfig returns the system level configuration level of the Flink server.

17. def getJobDetails(jobId: String)(implicit ec: ExecutionContext): Future[Option[Job]]

    

    getJobDetails returns detailed information about a single job.

    getJobDetails returns detailed information about a single job.

    If the job does not exist, None is returned in the future.

18. def getJobExceptions(jobId: String)(implicit ec: ExecutionContext): Future[Option[JobExceptions]]

    

    getJobExceptions returns all exceptions associated with the job.

    getJobExceptions returns all exceptions associated with the job.

    If the job does not exist, None is returned in the future.

19. def getJobManagerConfig()(implicit ec: ExecutionContext): Future[Seq[FlinkConfig]]

    

    getJobManagerConfig returns the job manager configurations of the Flink server.

20. def getJobOverview()(implicit ec: ExecutionContext): Future[JobOverview]

    

    getJobOverview provides a list of all running and finished jobs with a medium level of detail.

21. def getJobPlan(jobId: String)(implicit ec: ExecutionContext): Future[Option[JobPlan]]

    

    getJobPlan returns the job plan JSON for a given job.

    getJobPlan returns the job plan JSON for a given job.

    If the job does not exist, None is returned in the future.

22. def getJobsList()(implicit ec: ExecutionContext): Future[JobsList]

    

    getJobsList gets a list of all jobs, separated by the state of each job.

23. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

24. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

25. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

26. final def notify(): Unit

    

    Definition Classes

    AnyRef

27. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

28. def runProgram(jarId: String, programArguments: Option[Seq[String]] = None, mainClass: Option[String] = None, parallelism: Option[Int] = None, savepointPath: Option[String] = None, allowNonRestoredState: Option[Boolean] = None)(implicit ec: ExecutionContext): Future[RunProgramResult]

    

    runProgram starts a job on the Flink server.

    runProgram starts a job on the Flink server.

    IMPORTANT - The jarId is *not* the same as what appears in the Flink web UI -- there are hidden GUID values prepended to the JAR name. If you use the uploadJar method, the correct value will be returned in UploadJarResult.filename.

29. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

30. def toString(): String

    

    Definition Classes

    AnyRef → Any

31. def uploadJar(file: File)(implicit ec: ExecutionContext): Future[UploadJarResult]

    

    uploadJar uploads a JAR to the Flink server.

32. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )