hequn8128 commented on a change in pull request #11670: [FLINK-16761][python]Return JobExecutionResult for Python ExecutionEnvironment and TableEnvironment URL: https://github.com/apache/flink/pull/11670#discussion_r405980452
########## File path: flink-python/pyflink/common/job_execution_result.py ########## @@ -0,0 +1,93 @@ +################################################################################ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +################################################################################ + +__all__ = ['JobExecutionResult'] + + +class JobExecutionResult(object): + """ + The result of a job execution. Gives access to the execution time of the job, + and to all accumulators created by this job. + """ + + def __init__(self, j_job_execution_result): + self._j_job_execution_result = j_job_execution_result + + def get_job_id(self): + """ + Returns the JobID assigned to the job by the Flink runtime. + + :return: JobID, or null if the job has been executed on a runtime without JobIDs or if the execution failed. + """ + return self._j_job_execution_result.getJobID() + + def is_job_execution_result(self): + """ + Checks if this JobSubmissionResult is also a JobExecutionResult. + + .. seealso:: :func:`get_job_execution_result` to retrieve the JobExecutionResult. + + :return: ``True`` if this is a JobExecutionResult, ``False`` otherwise. + """ + return self._j_job_execution_result.isJobExecutionResult() + + def get_job_execution_result(self): + """ + Returns the JobExecutionResult if available. + + :throws: Exception if this is not a JobExecutionResult. + :return: The JobExecutionResult. + """ + return self + + def get_net_runtime(self, desired_unit=None): + """ + Gets the net execution time of the job, i.e., the execution time in the parallel system, + without the pre-flight steps like the optimizer in a desired time unit. + + :param desired_unit: the unit of the NetRuntime, optional. + :return: The net execution time in the desired unit. + """ + if desired_unit is None: + return self._j_job_execution_result.getNetRuntime() + else: + return self._j_job_execution_result.getNetRuntime(desired_unit) + + def get_accumulator_result(self, accumulator_name): + """ + Gets the accumulator with the given name. Returns {@code null}, if no accumulator with + that name was produced. + + :param accumulator_name: The name of the accumulator. + :return: The value of the accumulator with the given name. + """ + return self._j_job_execution_result.getAccumulatorResult(accumulator_name) + + def get_all_accumulator_results(self): + """ + Gets all accumulators produced by the job. The map contains the accumulators as + mappings from the accumulator name to the accumulator value. + + :return: The dict which the keys are names of the accumulator and the values + are values of the accumulator produced by the job. + """ + j_result_map = self._j_job_execution_result.get_all_accumulator_results() Review comment: _j_job_execution_result.get_all_accumulator_results() => _j_job_execution_result.getAllAccumulatorResults(). It's better to add tests to verify all the methods in this class. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
