eventstoredb.generated.event_store.cluster#

Package Contents#

Classes#

MemberInfoVNodeState

The base class for protobuf enumerations, all generated enumerations will inherit

GossipRequest

The base class for protobuf messages, all generated messages will inherit from

ViewChangeRequest

The base class for protobuf messages, all generated messages will inherit from

ViewChangeProofRequest

The base class for protobuf messages, all generated messages will inherit from

PrepareRequest

The base class for protobuf messages, all generated messages will inherit from

PrepareOkRequest

The base class for protobuf messages, all generated messages will inherit from

ProposalRequest

The base class for protobuf messages, all generated messages will inherit from

AcceptRequest

The base class for protobuf messages, all generated messages will inherit from

LeaderIsResigningRequest

The base class for protobuf messages, all generated messages will inherit from

LeaderIsResigningOkRequest

The base class for protobuf messages, all generated messages will inherit from

ClusterInfo

The base class for protobuf messages, all generated messages will inherit from

EndPoint

The base class for protobuf messages, all generated messages will inherit from

MemberInfo

The base class for protobuf messages, all generated messages will inherit from

ReplicaLogWrite

The base class for protobuf messages, all generated messages will inherit from

ReplicatedTo

The base class for protobuf messages, all generated messages will inherit from

Epoch

The base class for protobuf messages, all generated messages will inherit from

SubscribeReplica

The base class for protobuf messages, all generated messages will inherit from

ReplicaSubscriptionRetry

The base class for protobuf messages, all generated messages will inherit from

ReplicaSubscribed

The base class for protobuf messages, all generated messages will inherit from

ReplicaLogPositionAck

The base class for protobuf messages, all generated messages will inherit from

CreateChunk

The base class for protobuf messages, all generated messages will inherit from

RawChunkBulk

The base class for protobuf messages, all generated messages will inherit from

DataChunkBulk

The base class for protobuf messages, all generated messages will inherit from

FollowerAssignment

The base class for protobuf messages, all generated messages will inherit from

CloneAssignment

The base class for protobuf messages, all generated messages will inherit from

DropSubscription

The base class for protobuf messages, all generated messages will inherit from

GossipStub

Base class for async gRPC clients.

ElectionsStub

Base class for async gRPC clients.

GossipBase

Base class for async gRPC servers.

ElectionsBase

Base class for async gRPC servers.

class eventstoredb.generated.event_store.cluster.MemberInfoVNodeState[source]#

Bases: betterproto.Enum

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases enum.IntEnum.

Initializing = 0#
DiscoverLeader = 1#
Unknown = 2#
PreReplica = 3#
CatchingUp = 4#
Clone = 5#
Follower = 6#
PreLeader = 7#
Leader = 8#
Manager = 9#
ShuttingDown = 10#
Shutdown = 11#
ReadOnlyLeaderless = 12#
PreReadOnlyReplica = 13#
ReadOnlyReplica = 14#
ResigningLeader = 15#
class eventstoredb.generated.event_store.cluster.GossipRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

info: ClusterInfo#
server: EndPoint#
class eventstoredb.generated.event_store.cluster.ViewChangeRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
attempted_view: int#
class eventstoredb.generated.event_store.cluster.ViewChangeProofRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
installed_view: int#
class eventstoredb.generated.event_store.cluster.PrepareRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
view: int#
class eventstoredb.generated.event_store.cluster.PrepareOkRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

view: int#
server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
epoch_number: int#
epoch_position: int#
epoch_id: eventstoredb.generated.event_store.client.Uuid#
epoch_leader_instance_id: eventstoredb.generated.event_store.client.Uuid#
last_commit_position: int#
writer_checkpoint: int#
chaser_checkpoint: int#
node_priority: int#
cluster_info: ClusterInfo#
class eventstoredb.generated.event_store.cluster.ProposalRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
leader_id: eventstoredb.generated.event_store.client.Uuid#
leader_http: EndPoint#
view: int#
epoch_number: int#
epoch_position: int#
epoch_id: eventstoredb.generated.event_store.client.Uuid#
epoch_leader_instance_id: eventstoredb.generated.event_store.client.Uuid#
last_commit_position: int#
writer_checkpoint: int#
chaser_checkpoint: int#
node_priority: int#
class eventstoredb.generated.event_store.cluster.AcceptRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
leader_id: eventstoredb.generated.event_store.client.Uuid#
leader_http: EndPoint#
view: int#
class eventstoredb.generated.event_store.cluster.LeaderIsResigningRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: eventstoredb.generated.event_store.client.Uuid#
leader_http: EndPoint#
class eventstoredb.generated.event_store.cluster.LeaderIsResigningOkRequest[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: eventstoredb.generated.event_store.client.Uuid#
leader_http: EndPoint#
server_id: eventstoredb.generated.event_store.client.Uuid#
server_http: EndPoint#
class eventstoredb.generated.event_store.cluster.ClusterInfo[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

members: List[MemberInfo]#
class eventstoredb.generated.event_store.cluster.EndPoint[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

address: str#
port: int#
class eventstoredb.generated.event_store.cluster.MemberInfo[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

instance_id: eventstoredb.generated.event_store.client.Uuid#
time_stamp: int#
state: MemberInfoVNodeState#
is_alive: bool#
http_end_point: EndPoint#
internal_tcp: EndPoint#
external_tcp: EndPoint#
internal_tcp_uses_tls: bool#
external_tcp_uses_tls: bool#
last_commit_position: int#
writer_checkpoint: int#
chaser_checkpoint: int#
epoch_position: int#
epoch_number: int#
epoch_id: eventstoredb.generated.event_store.client.Uuid#
node_priority: int#
is_read_only_replica: bool#
advertise_host_to_client_as: str#
advertise_http_port_to_client_as: int#
advertise_tcp_port_to_client_as: int#
es_version: str#
class eventstoredb.generated.event_store.cluster.ReplicaLogWrite[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

log_position: int#
replica_id: bytes#
class eventstoredb.generated.event_store.cluster.ReplicatedTo[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

log_position: int#
class eventstoredb.generated.event_store.cluster.Epoch[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

epoch_position: int#
epoch_number: int#
epoch_id: bytes#
class eventstoredb.generated.event_store.cluster.SubscribeReplica[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

log_position: int#
chunk_id: bytes#
last_epochs: List[Epoch]#
ip: bytes#
port: int#
leader_id: bytes#
subscription_id: bytes#
is_promotable: bool#
version: int#
class eventstoredb.generated.event_store.cluster.ReplicaSubscriptionRetry[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
class eventstoredb.generated.event_store.cluster.ReplicaSubscribed[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
subscription_position: int#
class eventstoredb.generated.event_store.cluster.ReplicaLogPositionAck[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

subscription_id: bytes#
replication_log_position: int#
writer_log_position: int#
class eventstoredb.generated.event_store.cluster.CreateChunk[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
chunk_header_bytes: bytes#
file_size: int#
is_completed_chunk: bool#
class eventstoredb.generated.event_store.cluster.RawChunkBulk[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
chunk_start_number: int#
chunk_end_number: int#
raw_position: int#
raw_bytes: bytes#
complete_chunk: bool#
class eventstoredb.generated.event_store.cluster.DataChunkBulk[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
chunk_start_number: int#
chunk_end_number: int#
subscription_position: int#
data_bytes: bytes#
complete_chunk: bool#
class eventstoredb.generated.event_store.cluster.FollowerAssignment[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
class eventstoredb.generated.event_store.cluster.CloneAssignment[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
class eventstoredb.generated.event_store.cluster.DropSubscription[source]#

Bases: betterproto.Message

The base class for protobuf messages, all generated messages will inherit from this. This class registers the message fields which are used by the serializers and parsers to go between the Python, binary and JSON representations of the message.

bytes(x)

Calls __bytes__().

bool(x)

Calls __bool__().

leader_id: bytes#
subscription_id: bytes#
class eventstoredb.generated.event_store.cluster.GossipStub(channel, *, timeout=None, deadline=None, metadata=None)[source]#

Bases: betterproto.ServiceStub

Base class for async gRPC clients.

Parameters:
  • channel (grpclib.client.Channel) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[MetadataLike]) –

async update(gossip_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • gossip_request (GossipRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

ClusterInfo

async read(client_empty, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
Return type:

ClusterInfo

class eventstoredb.generated.event_store.cluster.ElectionsStub(channel, *, timeout=None, deadline=None, metadata=None)[source]#

Bases: betterproto.ServiceStub

Base class for async gRPC clients.

Parameters:
  • channel (grpclib.client.Channel) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[MetadataLike]) –

async view_change(view_change_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • view_change_request (ViewChangeRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async view_change_proof(view_change_proof_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • view_change_proof_request (ViewChangeProofRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async prepare(prepare_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • prepare_request (PrepareRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async prepare_ok(prepare_ok_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • prepare_ok_request (PrepareOkRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async proposal(proposal_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • proposal_request (ProposalRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async accept(accept_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • accept_request (AcceptRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async leader_is_resigning(leader_is_resigning_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • leader_is_resigning_request (LeaderIsResigningRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

async leader_is_resigning_ok(leader_is_resigning_ok_request, *, timeout=None, deadline=None, metadata=None)[source]#
Parameters:
  • leader_is_resigning_ok_request (LeaderIsResigningOkRequest) –

  • timeout (Optional[float]) –

  • deadline (Optional[grpclib.metadata.Deadline]) –

  • metadata (Optional[betterproto.grpc.grpclib_client.MetadataLike]) –

Return type:

eventstoredb.generated.event_store.client.Empty

class eventstoredb.generated.event_store.cluster.GossipBase[source]#

Bases: betterproto.grpc.grpclib_server.ServiceBase

Base class for async gRPC servers.

async update(gossip_request)[source]#
Parameters:

gossip_request (GossipRequest) –

Return type:

ClusterInfo

async read(client_empty)[source]#
Parameters:

client_empty (eventstoredb.generated.event_store.client.Empty) –

Return type:

ClusterInfo

__mapping__()[source]#
Return type:

Dict[str, grpclib.const.Handler]

class eventstoredb.generated.event_store.cluster.ElectionsBase[source]#

Bases: betterproto.grpc.grpclib_server.ServiceBase

Base class for async gRPC servers.

async view_change(view_change_request)[source]#
Parameters:

view_change_request (ViewChangeRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async view_change_proof(view_change_proof_request)[source]#
Parameters:

view_change_proof_request (ViewChangeProofRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async prepare(prepare_request)[source]#
Parameters:

prepare_request (PrepareRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async prepare_ok(prepare_ok_request)[source]#
Parameters:

prepare_ok_request (PrepareOkRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async proposal(proposal_request)[source]#
Parameters:

proposal_request (ProposalRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async accept(accept_request)[source]#
Parameters:

accept_request (AcceptRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async leader_is_resigning(leader_is_resigning_request)[source]#
Parameters:

leader_is_resigning_request (LeaderIsResigningRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

async leader_is_resigning_ok(leader_is_resigning_ok_request)[source]#
Parameters:

leader_is_resigning_ok_request (LeaderIsResigningOkRequest) –

Return type:

eventstoredb.generated.event_store.client.Empty

__mapping__()[source]#
Return type:

Dict[str, grpclib.const.Handler]