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

Hierarchy

Constructors

Properties

asVoter: boolean = false

AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

Generated

from field: bool asVoter = 6;

features: FeaturePort[] = []

Features is a list of features supported by the node that should be advertised to peers and the port they are available on.

Generated

from field: repeated v1.FeaturePort features = 8;

id: string = ""

ID is the ID of the node.

Generated

from field: string id = 1;

multiaddrs: string[] = []

Multiaddrs are libp2p multiaddresses this node is listening on.

Generated

from field: repeated string multiaddrs = 9;

primaryEndpoint: string = ""

PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

Generated

from field: string primaryEndpoint = 3;

publicKey: string = ""

PublicKey is the public key of the node to broadcast to peers.

Generated

from field: string publicKey = 2;

routes: string[] = []

Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

Generated

from field: repeated string routes = 7;

wireguardEndpoints: string[] = []

WireguardEndpoints is a list of WireGuard endpoints for the node.

Generated

from field: repeated string wireguardEndpoints = 4;

zoneAwarenessID: string = ""

ZoneAwarenessID is the zone awareness ID of the node.

Generated

from field: string zoneAwarenessID = 5;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "v1.UpdateRequest" = "v1.UpdateRequest"

Methods

  • Create a deep copy.

    Returns UpdateRequest

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • 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.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns UpdateRequest

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns UpdateRequest

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns UpdateRequest

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<UpdateRequest>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override 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.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Generated using TypeDoc