Optional
data: PartialMessage<UpdateRequest>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 = 6;
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 = 8;
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 = 9;
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 = 3;
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 = 7;
WireguardEndpoints is a list of WireGuard endpoints for the node.
from field: repeated string wireguardEndpoints = 4;
ZoneAwarenessID is the zone awareness ID of the node.
from field: string zoneAwarenessID = 5;
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
UpdateRequest contains most of the same fields as JoinRequest, but is used to update the state of a node in the cluster.
Generated
from message v1.UpdateRequest