Method represents a method of an API interface.

Generated

from message google.protobuf.Method

Hierarchy

Constructors

  • Parameters

    Returns Method

Properties

name: string

The simple name of this method.

Generated

from field: string name = 1;

options: Option[]

Any metadata attached to the method.

Generated

from field: repeated google.protobuf.Option options = 6;

requestStreaming: boolean

If true, the request is streamed.

Generated

from field: bool request_streaming = 3;

requestTypeUrl: string

A URL of the input message type.

Generated

from field: string request_type_url = 2;

responseStreaming: boolean

If true, the response is streamed.

Generated

from field: bool response_streaming = 5;

responseTypeUrl: string

The URL of the output message type.

Generated

from field: string response_type_url = 4;

syntax: Syntax

The source syntax of this method.

Generated

from field: google.protobuf.Syntax syntax = 7;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.Method" = "google.protobuf.Method"

Methods

  • Create a deep copy.

    Returns Method

  • 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

    Returns Method

  • Parse a message from a JSON value.

    Parameters

    Returns Method

  • Parse a message from a JSON string.

    Parameters

    Returns Method

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

    Returns MessageType<Method>

  • Serialize the message to binary data.

    Parameters

    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

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

  • Parameters

    Returns boolean

  • Parameters

    Returns Method

  • Parameters

    Returns Method

  • Parameters

    Returns Method

Generated using TypeDoc