Status represents the status of a node.

Generated

from message v1.Status

Hierarchy

Constructors

Properties

buildDate: string = ""

BuildDate is the build date of the node.

Generated

from field: string buildDate = 5;

clusterStatus: ClusterStatus = ClusterStatus.CLUSTER_STATUS_UNKNOWN

ClusterStatus is the status of the node in the cluster.

Generated

from field: v1.ClusterStatus clusterStatus = 9;

currentLeader: string = ""

CurrentLeader is the current leader of the cluster.

Generated

from field: string currentLeader = 10;

description: string = ""

Description is an optional description provided by the node.

Generated

from field: string description = 2;

features: FeaturePort[] = []

Features is the list of features currently enabled.

Generated

from field: repeated v1.FeaturePort features = 8;

gitCommit: string = ""

GitCommit is the git commit of the node.

Generated

from field: string gitCommit = 4;

id: string = ""

ID is the ID of the node.

Generated

from field: string id = 1;

interfaceMetrics?: InterfaceMetrics

InterfaceMetrics are the metrics for the node's interfaces.

Generated

from field: v1.InterfaceMetrics interfaceMetrics = 11;

startedAt?: Timestamp

StartedAt is the time the node started.

Generated

from field: google.protobuf.Timestamp startedAt = 7;

uptime: string = ""

Uptime is the uptime of the node.

Generated

from field: string uptime = 6;

version: string = ""

Version is the version of the node.

Generated

from field: string version = 3;

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

Methods

  • Create a deep copy.

    Returns Status

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns Status

  • Parse a message from a JSON string.

    Parameters

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

    Returns Status

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

    Returns MessageType<Status>

  • 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

  • Parameters

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

    Returns Status

  • Parameters

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

    Returns Status

  • Parameters

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

    Returns Status

Generated using TypeDoc