.. flink-rest-client documentation master file, created by
   sphinx-quickstart on Wed Jul  7 18:07:12 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Flink REST Client's documentation!
=============================================

The Flink REST Client provides an easy-to-use python API for Flink REST API.
The client implements all available REST API endpoints that are documented on the `official Flink site<https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/ops/rest_api/>`_.
Using this client, you can easily query your Flink cluster status, or you can upload and run arbitrary Flink jobs wrapped in a Java archive file.


.. toctree::
   :maxdepth: 2
   :caption: Table of contents

   installation
   endpoint_mapping
   usage_examples
   api_doc