Optional data: PartialMessage<JoinRequest>AsObserver is whether the node should be added as an observer. They will receive updates to the storage, but not be able to vote in elections.
from field: bool asObserver = 10;
AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.
from field: bool asVoter = 9;
AssignIPv4 is whether an IPv4 address should be assigned to the node.
from field: bool assignIPv4 = 7;
DirectPeers is a map of extra peers that should be connected to directly over relays. The provided edge attribute is the callers preference of how the relay should be created. The request will be denied if the node is not allowed to put data channels or edges. The default joining behavior creates direct links between the caller and the joiner. If the caller has a primary endpoint, the joiner will link the caller to all other nodes with a primary endpoint. If the caller has a zone awareness ID, the joiner will link the caller to all other nodes with the same zone awareness ID that also have a primary endpoint.
from field: map<string, v1.ConnectProtocol> directPeers = 12;
Features is a list of features supported by the node that should be advertised to peers and the port they are available on.
from field: repeated v1.FeaturePort features = 13;
ID is the ID of the node.
from field: string id = 1;
Multiaddrs are libp2p multiaddresses this node is listening on.
from field: repeated string multiaddrs = 14;
PreferStorageIPv6 is whether IPv6 should be preferred over IPv4 for storage communication. This is only used if assign_ipv4 is true.
from field: bool preferStorageIPv6 = 8;
PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.
from field: string primaryEndpoint = 4;
PublicKey is the public key of the node to broadcast to peers.
from field: string publicKey = 2;
Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.
from field: repeated string routes = 11;
WireguardEndpoints is a list of WireGuard endpoints for the node.
from field: repeated string wireguardEndpoints = 5;
ZoneAwarenessID is the zone awareness ID of the node.
from field: string zoneAwarenessID = 6;
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCreate a deep copy.
Compare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional options: Partial<JsonReadOptions>Parse a message from a JSON string.
Optional options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Protected toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Static equalsStatic fromOptional options: Partial<BinaryReadOptions>Static fromOptional options: Partial<JsonReadOptions>Static fromOptional options: Partial<JsonReadOptions>Generated using TypeDoc
JoinRequest is a request to join the cluster.
Generated
from message v1.JoinRequest