Source code for pyspark.streaming.listener

#
# 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__ = ["StreamingListener"]


[docs]class StreamingListener(object):

    def __init__(self):
        pass

[docs]    def onReceiverStarted(self, receiverStarted):
        """
        Called when a receiver has been started
        """
        pass

[docs]    def onReceiverError(self, receiverError):
        """
        Called when a receiver has reported an error
        """
        pass

[docs]    def onReceiverStopped(self, receiverStopped):
        """
        Called when a receiver has been stopped
        """
        pass

[docs]    def onBatchSubmitted(self, batchSubmitted):
        """
        Called when a batch of jobs has been submitted for processing.
        """
        pass

[docs]    def onBatchStarted(self, batchStarted):
        """
        Called when processing of a batch of jobs has started.
        """
        pass

[docs]    def onBatchCompleted(self, batchCompleted):
        """
        Called when processing of a batch of jobs has completed.
        """
        pass

[docs]    def onOutputOperationStarted(self, outputOperationStarted):
        """
        Called when processing of a job of a batch has started.
        """
        pass

[docs]    def onOutputOperationCompleted(self, outputOperationCompleted):
        """
        Called when processing of a job of a batch has completed
        """
        pass

[docs]    class Java:
        implements = ["org.apache.spark.streaming.api.java.PythonStreamingListener"]