Skip to main content

Class: ServiceDescriptorProto

google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

Implements

Constructors

constructor

new ServiceDescriptorProto(properties?): ServiceDescriptorProto

Constructs a new ServiceDescriptorProto.

Parameters

NameTypeDescription
properties?IServiceDescriptorProtoProperties to set

Returns

ServiceDescriptorProto

Properties

method

method: IMethodDescriptorProto[]

ServiceDescriptorProto method.

Implementation of

IServiceDescriptorProto.method


name

name: string

ServiceDescriptorProto name.

Implementation of

IServiceDescriptorProto.name


options

Optional options: null | IServiceOptions

ServiceDescriptorProto options.

Implementation of

IServiceDescriptorProto.options

Methods

toJSON

toJSON(): Object

Converts this ServiceDescriptorProto to JSON.

Returns

Object

JSON object


create

create(properties?): ServiceDescriptorProto

Creates a new ServiceDescriptorProto instance using the specified properties.

Parameters

NameTypeDescription
properties?IServiceDescriptorProtoProperties to set

Returns

ServiceDescriptorProto

ServiceDescriptorProto instance


decode

decode(reader, length?): ServiceDescriptorProto

Decodes a ServiceDescriptorProto message from the specified reader or buffer.

Parameters

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

Returns

ServiceDescriptorProto

ServiceDescriptorProto

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ServiceDescriptorProto

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ServiceDescriptorProto

ServiceDescriptorProto

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 ServiceDescriptorProto message. Does not implicitly google.protobuf.ServiceDescriptorProto.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ServiceDescriptorProto

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ServiceDescriptorProto

ServiceDescriptorProto


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ServiceDescriptorProto

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 ServiceDescriptorProto message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageServiceDescriptorProtoServiceDescriptorProto
options?IConversionOptionsConversion options

Returns

Object

Plain object