forked from googleapis/python-pubsub
/
base.py
75 lines (63 loc) · 2.68 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# Copyright 2019, Google LLC All rights reserved.
#
# Licensed 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.
from __future__ import absolute_import
import abc
class Sequencer(metaclass=abc.ABCMeta):
"""The base class for sequencers for Pub/Sub publishing. A sequencer
sequences messages to be published.
"""
@staticmethod
@abc.abstractmethod
def is_finished(self): # pragma: NO COVER
""" Whether the sequencer is finished and should be cleaned up.
Returns:
bool: Whether the sequencer is finished and should be cleaned up.
"""
raise NotImplementedError
@staticmethod
@abc.abstractmethod
def unpause(self, message): # pragma: NO COVER
""" Unpauses this sequencer.
Raises:
RuntimeError:
If called when the sequencer has not been paused.
"""
raise NotImplementedError
@staticmethod
@abc.abstractmethod
def publish(self, message, retry=None, timeout=None): # pragma: NO COVER
""" Publish message for this ordering key.
Args:
message (~.pubsub_v1.types.PubsubMessage):
The Pub/Sub message.
retry (Optional[google.api_core.retry.Retry]):
The retry settings to apply when publishing the message.
timeout (Union[ \
googole.api_core.timeout.ConstantTimeout, \
googole.api_core.timeout.ExponentialTimeout \
]):
The timeout to apply when publishing the message.
Returns:
A class instance that conforms to Python Standard library's
:class:`~concurrent.futures.Future` interface (but not an
instance of that class). The future might return immediately with a
`pubsub_v1.publisher.exceptions.PublishToPausedOrderingKeyException`
if the ordering key is paused. Otherwise, the future tracks the
lifetime of the message publish.
Raises:
RuntimeError:
If called after this sequencer has been stopped, either by
a call to stop() or after all batches have been published.
"""
raise NotImplementedError