flink-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v1/1.15-SNAPSHOT
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import flink_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flink_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import flink_client
from pprint import pprint
from flink_client.api import default_api
from flink_client.model.asynchronous_operation_result import AsynchronousOperationResult
from flink_client.model.checkpoint_config_info import CheckpointConfigInfo
from flink_client.model.checkpoint_statistics import CheckpointStatistics
from flink_client.model.checkpointing_statistics import CheckpointingStatistics
from flink_client.model.cluster_configuration_info_entry import ClusterConfigurationInfoEntry
from flink_client.model.cluster_data_set_list_response_body import ClusterDataSetListResponseBody
from flink_client.model.cluster_overview_with_version import ClusterOverviewWithVersion
from flink_client.model.dashboard_configuration import DashboardConfiguration
from flink_client.model.jar_list_info import JarListInfo
from flink_client.model.jar_plan_request_body import JarPlanRequestBody
from flink_client.model.jar_run_request_body import JarRunRequestBody
from flink_client.model.jar_run_response_body import JarRunResponseBody
from flink_client.model.jar_upload_response_body import JarUploadResponseBody
from flink_client.model.job_accumulators_info import JobAccumulatorsInfo
from flink_client.model.job_config_info import JobConfigInfo
from flink_client.model.job_details_info import JobDetailsInfo
from flink_client.model.job_exceptions_info_with_history import JobExceptionsInfoWithHistory
from flink_client.model.job_execution_result_response_body import JobExecutionResultResponseBody
from flink_client.model.job_ids_with_status_overview import JobIdsWithStatusOverview
from flink_client.model.job_plan_info import JobPlanInfo
from flink_client.model.job_submit_request_body import JobSubmitRequestBody
from flink_client.model.job_submit_response_body import JobSubmitResponseBody
from flink_client.model.job_vertex_accumulators_info import JobVertexAccumulatorsInfo
from flink_client.model.job_vertex_back_pressure_info import JobVertexBackPressureInfo
from flink_client.model.job_vertex_details_info import JobVertexDetailsInfo
from flink_client.model.job_vertex_flame_graph import JobVertexFlameGraph
from flink_client.model.job_vertex_task_managers_info import JobVertexTaskManagersInfo
from flink_client.model.log_list_info import LogListInfo
from flink_client.model.metric_collection_response_body import MetricCollectionResponseBody
from flink_client.model.multiple_jobs_details import MultipleJobsDetails
from flink_client.model.savepoint_disposal_request import SavepointDisposalRequest
from flink_client.model.savepoint_trigger_request_body import SavepointTriggerRequestBody
from flink_client.model.stop_with_savepoint_request_body import StopWithSavepointRequestBody
from flink_client.model.subtask_execution_attempt_accumulators_info import SubtaskExecutionAttemptAccumulatorsInfo
from flink_client.model.subtask_execution_attempt_details_info import SubtaskExecutionAttemptDetailsInfo
from flink_client.model.subtasks_all_accumulators_info import SubtasksAllAccumulatorsInfo
from flink_client.model.subtasks_times_info import SubtasksTimesInfo
from flink_client.model.task_checkpoint_statistics_with_subtask_details import TaskCheckpointStatisticsWithSubtaskDetails
from flink_client.model.task_manager_details_info import TaskManagerDetailsInfo
from flink_client.model.task_managers_info import TaskManagersInfo
from flink_client.model.thread_dump_info import ThreadDumpInfo
from flink_client.model.trigger_response import TriggerResponse
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flink_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with flink_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)

    try:
        api_instance.cluster_delete()
    except flink_client.ApiException as e:
        print("Exception when calling DefaultApi->cluster_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	cluster_delete	DELETE /cluster
DefaultApi	config_get	GET /config
DefaultApi	datasets_datasetid_delete	DELETE /datasets/{datasetid}
DefaultApi	datasets_delete_triggerid_get	GET /datasets/delete/{triggerid}
DefaultApi	datasets_get	GET /datasets
DefaultApi	jars_get	GET /jars
DefaultApi	jars_jarid_delete	DELETE /jars/{jarid}
DefaultApi	jars_jarid_plan_get	GET /jars/{jarid}/plan
DefaultApi	jars_jarid_plan_post	POST /jars/{jarid}/plan
DefaultApi	jars_jarid_run_post	POST /jars/{jarid}/run
DefaultApi	jars_upload_post	POST /jars/upload
DefaultApi	jobmanager_config_get	GET /jobmanager/config
DefaultApi	jobmanager_logs_get	GET /jobmanager/logs
DefaultApi	jobmanager_metrics_get	GET /jobmanager/metrics
DefaultApi	jobmanager_thread_dump_get	GET /jobmanager/thread-dump
DefaultApi	jobs_get	GET /jobs
DefaultApi	jobs_jobid_accumulators_get	GET /jobs/{jobid}/accumulators
DefaultApi	jobs_jobid_checkpoints_config_get	GET /jobs/{jobid}/checkpoints/config
DefaultApi	jobs_jobid_checkpoints_details_checkpointid_get	GET /jobs/{jobid}/checkpoints/details/{checkpointid}
DefaultApi	jobs_jobid_checkpoints_details_checkpointid_subtasks_vertexid_get	GET /jobs/{jobid}/checkpoints/details/{checkpointid}/subtasks/{vertexid}
DefaultApi	jobs_jobid_checkpoints_get	GET /jobs/{jobid}/checkpoints
DefaultApi	jobs_jobid_config_get	GET /jobs/{jobid}/config
DefaultApi	jobs_jobid_exceptions_get	GET /jobs/{jobid}/exceptions
DefaultApi	jobs_jobid_execution_result_get	GET /jobs/{jobid}/execution-result
DefaultApi	jobs_jobid_get	GET /jobs/{jobid}
DefaultApi	jobs_jobid_metrics_get	GET /jobs/{jobid}/metrics
DefaultApi	jobs_jobid_patch	PATCH /jobs/{jobid}
DefaultApi	jobs_jobid_plan_get	GET /jobs/{jobid}/plan
DefaultApi	jobs_jobid_rescaling_patch	PATCH /jobs/{jobid}/rescaling
DefaultApi	jobs_jobid_rescaling_triggerid_get	GET /jobs/{jobid}/rescaling/{triggerid}
DefaultApi	jobs_jobid_savepoints_post	POST /jobs/{jobid}/savepoints
DefaultApi	jobs_jobid_savepoints_triggerid_get	GET /jobs/{jobid}/savepoints/{triggerid}
DefaultApi	jobs_jobid_stop_post	POST /jobs/{jobid}/stop
DefaultApi	jobs_jobid_vertices_vertexid_accumulators_get	GET /jobs/{jobid}/vertices/{vertexid}/accumulators
DefaultApi	jobs_jobid_vertices_vertexid_backpressure_get	GET /jobs/{jobid}/vertices/{vertexid}/backpressure
DefaultApi	jobs_jobid_vertices_vertexid_flamegraph_get	GET /jobs/{jobid}/vertices/{vertexid}/flamegraph
DefaultApi	jobs_jobid_vertices_vertexid_get	GET /jobs/{jobid}/vertices/{vertexid}
DefaultApi	jobs_jobid_vertices_vertexid_metrics_get	GET /jobs/{jobid}/vertices/{vertexid}/metrics
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_accumulators_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/accumulators
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_metrics_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/metrics
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_subtaskindex_attempts_attempt_accumulators_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt}/accumulators
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_subtaskindex_attempts_attempt_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt}
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_subtaskindex_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}
DefaultApi	jobs_jobid_vertices_vertexid_subtasks_subtaskindex_metrics_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/metrics
DefaultApi	jobs_jobid_vertices_vertexid_subtasktimes_get	GET /jobs/{jobid}/vertices/{vertexid}/subtasktimes
DefaultApi	jobs_jobid_vertices_vertexid_taskmanagers_get	GET /jobs/{jobid}/vertices/{vertexid}/taskmanagers
DefaultApi	jobs_jobid_vertices_vertexid_watermarks_get	GET /jobs/{jobid}/vertices/{vertexid}/watermarks
DefaultApi	jobs_metrics_get	GET /jobs/metrics
DefaultApi	jobs_overview_get	GET /jobs/overview
DefaultApi	jobs_post	POST /jobs
DefaultApi	overview_get	GET /overview
DefaultApi	savepoint_disposal_post	POST /savepoint-disposal
DefaultApi	savepoint_disposal_triggerid_get	GET /savepoint-disposal/{triggerid}
DefaultApi	taskmanagers_get	GET /taskmanagers
DefaultApi	taskmanagers_metrics_get	GET /taskmanagers/metrics
DefaultApi	taskmanagers_taskmanagerid_get	GET /taskmanagers/{taskmanagerid}
DefaultApi	taskmanagers_taskmanagerid_logs_get	GET /taskmanagers/{taskmanagerid}/logs
DefaultApi	taskmanagers_taskmanagerid_metrics_get	GET /taskmanagers/{taskmanagerid}/metrics
DefaultApi	taskmanagers_taskmanagerid_thread_dump_get	GET /taskmanagers/{taskmanagerid}/thread-dump

Documentation For Models

• AsynchronousOperationInfo
• AsynchronousOperationResult
• AsynchronousOperationResultOperation
• CheckpointAlignment
• CheckpointConfigInfo
• CheckpointDuration
• CheckpointStatistics
• CheckpointingStatistics
• ClusterConfigurationInfo
• ClusterConfigurationInfoEntry
• ClusterDataSetEntry
• ClusterDataSetListResponseBody
• ClusterOverviewWithVersion
• CompletedCheckpointStatistics
• CompletedCheckpointStatisticsAllOf
• CompletedSubtaskCheckpointStatistics
• CompletedSubtaskCheckpointStatisticsAllOf
• Counts
• DashboardConfiguration
• DistributedCacheFile
• ExceptionInfo
• ExecutionConfigInfo
• ExecutionExceptionInfo
• ExternalizedCheckpointInfo
• FailedCheckpointStatistics
• FailedCheckpointStatisticsAllOf
• Features
• GarbageCollectorInfo
• HardwareDescription
• IOMetricsInfo
• IntermediateDataSetID
• JarEntryInfo
• JarFileInfo
• JarListInfo
• JarPlanRequestBody
• JarRunRequestBody
• JarRunResponseBody
• JarUploadResponseBody
• JarsUploadPostRequest
• JobAccumulatorsInfo
• JobConfigInfo
• JobDetails
• JobDetailsInfo
• JobExceptionHistory
• JobExceptionsInfoWithHistory
• JobExecutionResultResponseBody
• JobID
• JobIdWithStatus
• JobIdsWithStatusOverview
• JobPlanInfo
• JobResult
• JobSubmitRequestBody
• JobSubmitResponseBody
• JobVertexAccumulatorsInfo
• JobVertexBackPressureInfo
• JobVertexDetailsInfo
• JobVertexFlameGraph
• JobVertexID
• JobVertexTaskManagersInfo
• JobsGetRequest
• LatestCheckpoints
• LogInfo
• LogListInfo
• Metric
• MetricCollectionResponseBody
• MultipleJobsDetails
• Node
• PendingCheckpointStatistics
• PendingSubtaskCheckpointStatistics
• QueueStatus
• ResourceID
• ResourceProfileInfo
• RestoredCheckpointStatistics
• RootExceptionInfo
• SavepointDisposalRequest
• SavepointInfo
• SavepointTriggerRequestBody
• SerializedThrowable
• SerializedValueOptionalFailureObject
• SlotInfo
• StatsSummaryDto
• StopWithSavepointRequestBody
• SubtaskAccumulatorsInfo
• SubtaskBackPressureInfo
• SubtaskCheckpointStatistics
• SubtaskExecutionAttemptAccumulatorsInfo
• SubtaskExecutionAttemptDetailsInfo
• SubtaskTimeInfo
• SubtasksAllAccumulatorsInfo
• SubtasksTimesInfo
• Summary
• TaskCheckpointStatistics
• TaskCheckpointStatisticsWithSubtaskDetails
• TaskExecutorMemoryConfiguration
• TaskManagerDetailsInfo
• TaskManagerInfo
• TaskManagerMetricsInfo
• TaskManagersInfo
• ThreadDumpInfo
• ThreadInfo
• TriggerId
• TriggerResponse
• UserAccumulator
• UserTaskAccumulator

Documentation For Authorization

All endpoints do not require authorization.

Author

user@flink.apache.org

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in flink_client.apis and flink_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from flink_client.api.default_api import DefaultApi
• from flink_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import flink_client
from flink_client.apis import *
from flink_client.models import *