Interface DescMethod

Describes an RPC declaration in a protobuf source file.

interface DescMethod {
    deprecated: boolean;
    idempotency?: MethodIdempotency;
    input: DescMessage;
    kind: "rpc";
    methodKind: MethodKind;
    name: string;
    output: DescMessage;
    parent: DescService;
    proto: MethodDescriptorProto;
    getComments(): DescComments;
    getFeatures(): MergedFeatureSet;
    toString(): string;
}

Properties

deprecated idempotency? input kind methodKind name output parent proto

Methods

getComments getFeatures toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

Optional Readonly idempotency

idempotency?: MethodIdempotency

The idempotency level declared in the protobuf source, if any.

Readonly input

input: DescMessage

The message type for requests.

Readonly kind

kind: "rpc"

Readonly methodKind

methodKind: MethodKind

One of the four available method types.

Readonly name

name: string

The name of the RPC, as specified in the protobuf source.

Readonly output

output: DescMessage

The message type for responses.

Readonly parent

parent: DescService

The parent service.

Readonly proto

proto: MethodDescriptorProto

The compiler-generated descriptor.

Methods

getComments

  • getComments(): DescComments

  • Get comments on the element in the protobuf source.

    Returns DescComments

getFeatures

  • getFeatures(): MergedFeatureSet

  • Get the edition features for this protobuf element.

    Returns MergedFeatureSet

toString

  • toString(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page

deprecatedidempotencyinputkindmethodKindnameoutputparentprotogetCommentsgetFeaturestoString