StorageStatus is the response object for the StorageStatus RPC.

Generated

from message v1.StorageStatus

Hierarchy

Constructors

Properties

clusterStatus: ClusterStatus = ClusterStatus.CLUSTER_STATUS_UNKNOWN

ClusterStatus is the status of the storage. The definitions applied to each status are implementation specific.

Generated

from field: v1.ClusterStatus clusterStatus = 2;

isWritable: boolean = false

IsWritable is true if the storage can currently be written to.

Generated

from field: bool isWritable = 1;

message: string = ""

Message is an implementation specific message that can be used to provide additional information about the storage status.

Generated

from field: string message = 4;

peers: StoragePeer[] = []

Peers is the list of servers that are currently recognized as peers by the storage plugin. This should include the current server.

Generated

from field: repeated v1.StoragePeer peers = 3;

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

Methods

  • Create a deep copy.

    Returns StorageStatus

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns StorageStatus

  • Parse a message from a JSON string.

    Parameters

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

    Returns StorageStatus

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

    Returns MessageType<StorageStatus>

  • 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