Skip to main content

Class: MethodDescriptorProto

google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

Implements

Constructors

constructor

new MethodDescriptorProto(properties?): MethodDescriptorProto

Constructs a new MethodDescriptorProto.

Parameters

NameTypeDescription
properties?IMethodDescriptorProtoProperties to set

Returns

MethodDescriptorProto

Properties

clientStreaming

clientStreaming: boolean

MethodDescriptorProto clientStreaming.

Implementation of

IMethodDescriptorProto.clientStreaming


inputType

inputType: string

MethodDescriptorProto inputType.

Implementation of

IMethodDescriptorProto.inputType


name

name: string

MethodDescriptorProto name.

Implementation of

IMethodDescriptorProto.name


options

Optional options: null | IMethodOptions

MethodDescriptorProto options.

Implementation of

IMethodDescriptorProto.options


outputType

outputType: string

MethodDescriptorProto outputType.

Implementation of

IMethodDescriptorProto.outputType


serverStreaming

serverStreaming: boolean

MethodDescriptorProto serverStreaming.

Implementation of

IMethodDescriptorProto.serverStreaming

Methods

toJSON

toJSON(): Object

Converts this MethodDescriptorProto to JSON.

Returns

Object

JSON object


create

create(properties?): MethodDescriptorProto

Creates a new MethodDescriptorProto instance using the specified properties.

Parameters

NameTypeDescription
properties?IMethodDescriptorProtoProperties to set

Returns

MethodDescriptorProto

MethodDescriptorProto instance


decode

decode(reader, length?): MethodDescriptorProto

Decodes a MethodDescriptorProto message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

MethodDescriptorProto

MethodDescriptorProto

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): MethodDescriptorProto

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

MethodDescriptorProto

MethodDescriptorProto

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIMethodDescriptorProtoMethodDescriptorProto message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIMethodDescriptorProtoMethodDescriptorProto message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): MethodDescriptorProto

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

MethodDescriptorProto

MethodDescriptorProto


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for MethodDescriptorProto

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageMethodDescriptorProtoMethodDescriptorProto
options?IConversionOptionsConversion options

Returns

Object

Plain object