QueryRequest is sent by the application to the node to query the mesh for information.

Generated

from message v1.QueryRequest

Hierarchy

Constructors

Properties

command: QueryRequest_QueryCommand = QueryRequest_QueryCommand.GET

Command is the command of the query.

Generated

from field: v1.QueryRequest.QueryCommand command = 1;

item: Uint8Array = ...

Item is an item to put. This is only applicable for PUT queries. It should be a protobuf-JSON encoded object of the given query type.

Generated

from field: bytes item = 4;

query: string = ""

Query is the string of the query. This follows the format of a comma-separted label selector and is only applicable for certain queries. For get queries this will usually be an ID. For list queries this will usually be one or more filters. On put or delete queries, this should be an ID.

Generated

from field: string query = 3;

type: QueryRequest_QueryType = QueryRequest_QueryType.VALUE

Type is the type of resource for the query.

Generated

from field: v1.QueryRequest.QueryType type = 2;

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

Methods

  • Create a deep copy.

    Returns QueryRequest

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns QueryRequest

  • Parse a message from a JSON string.

    Parameters

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

    Returns QueryRequest

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

    Returns MessageType<QueryRequest>

  • 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