Core
Hazelcast Core objects and constants.
- class Address(host: str, port: int)[source]
Bases:
objectRepresents an address of a member in the cluster.
- host
Host of the address.
- port
Port of the address.
- class ProtocolType[source]
Bases:
objectTypes of server sockets.
A member typically responds to several types of protocols for member-to-member, client-member protocol, WAN communication etc. The default configuration uses a single server socket to listen for all kinds of protocol types configured, while Advanced Network Config of the server allows configuration of multiple server sockets.
- MEMBER = 0
Type of member server sockets.
- CLIENT = 1
Type of client server sockets.
- WAN = 2
Type of WAN server sockets.
- REST = 3
Type of REST server sockets.
- MEMCACHE = 4
Type of Memcached server sockets.
- class EndpointQualifier(protocol_type: int, identifier: str | None)[source]
Bases:
objectUniquely identifies groups of network connections sharing a common
ProtocolTypeand the same network settings, when Hazelcast server is configured with Advanced Network Configuration enabled.In some cases, just the
ProtocolTypeis enough (e.g. since there can be only a single member server socket).When just the
ProtocolTypeis not enough (for example when configuring outgoing WAN connections to 2 different target clusters), anidentifieris used to uniquely identify the network configuration.- property protocol_type: int
Protocol type of the endpoint.
- property identifier: str | None
Unique identifier for same-protocol-type endpoints.
- class DistributedObjectEventType[source]
Bases:
objectType of the distributed object event.
- CREATED = 'CREATED'
DistributedObject is created.
- DESTROYED = 'DESTROYED'
DistributedObject is destroyed.
- class DistributedObjectEvent(name: str, service_name: str, event_type: str, source: UUID)[source]
Bases:
objectDistributed Object Event
- name
Name of the distributed object.
- service_name
Service name of the distributed object.
- event_type
Event type. Either
CREATEDorDESTROYED.
- source
UUID of the member that fired the event.
- class SimpleEntryView(key: KeyType, value: ValueType, cost: int, creation_time: int, expiration_time: int, hits: int, last_access_time: int, last_stored_time: int, last_update_time: int, version: int, ttl: int, max_idle: int)[source]
Bases:
Generic[KeyType,ValueType]EntryView represents a readonly view of a map entry.
- key
The key of the entry.
- value
The value of the entry.
- cost
The cost in bytes of the entry.
- creation_time
The creation time of the entry.
- expiration_time
The expiration time of the entry.
- hits
Number of hits of the entry.
- last_access_time
The last access time for the entry.
- last_stored_time
The last store time for the value.
- last_update_time
The last time the value was updated.
- version
The version of the entry.
- ttl
The last set time to live milliseconds.
- max_idle
The last set max idle time in milliseconds.
- class HazelcastJsonValue(value: Any)[source]
Bases:
objectHazelcastJsonValue is a wrapper for JSON formatted strings.
It is preferred to store HazelcastJsonValue instead of Strings for JSON formatted strings. Users can run predicates and use indexes on the attributes of the underlying JSON strings.
HazelcastJsonValue is queried using Hazelcast’s querying language.
In terms of querying, numbers in JSON strings are treated as either Long or Double in the Java side. str, bool and None are treated as String, boolean and null respectively.
HazelcastJsonValue keeps given string as it is. Strings are not checked for being valid. Ill-formatted JSON strings may cause false positive or false negative results in queries.
HazelcastJsonValue can also be constructed from JSON serializable objects. In that case, objects are converted to JSON strings and stored as such. If an error occurs during the conversion, it is raised directly.
None values are not allowed.