Skip to main content

Class: MethodDescriptorProto

Describes a method of a service.

Properties​

clientStreaming​

clientStreaming: boolean

Identifies if client streams multiple client messages

inputType​

inputType: string

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

name​

name: string

MethodDescriptorProto name.

options?​

optional options?: $Properties | null

MethodDescriptorProto options.

outputType​

outputType: string

MethodDescriptorProto outputType.

serverStreaming​

serverStreaming: boolean

Identifies if server streams multiple server messages

Methods​

toJSON()​

toJSON(): object

Converts this MethodDescriptorProto to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): MethodDescriptorProto & $Shape

Creates a new MethodDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

MethodDescriptorProto & $Shape

MethodDescriptorProto instance

Call Signature​

static create(properties?): MethodDescriptorProto

Creates a new MethodDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

MethodDescriptorProto

MethodDescriptorProto instance

decode()​

static decode(reader, length?): MethodDescriptorProto & $Shape

Decodes a MethodDescriptorProto message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

MethodDescriptorProto & $Shape

MethodDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): MethodDescriptorProto & $Shape

Decodes a MethodDescriptorProto message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

MethodDescriptorProto & $Shape

MethodDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified MethodDescriptorProto message. Does not implicitly google.protobuf.MethodDescriptorProto.verify|verify messages.

Parameters​

message​

$Properties

MethodDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified MethodDescriptorProto message, length delimited. Does not implicitly google.protobuf.MethodDescriptorProto.verify|verify messages.

Parameters​

message​

$Properties

MethodDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): MethodDescriptorProto

Creates a MethodDescriptorProto message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

MethodDescriptorProto

MethodDescriptorProto

toObject()​

static toObject(message, options?): object

Creates a plain object from a MethodDescriptorProto message. Also converts values to other types if specified.

Parameters​

message​

MethodDescriptorProto

MethodDescriptorProto

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object