Interface DescService

Describes a service declaration in a protobuf source file.

interface DescService {
    deprecated: boolean;
    file: DescFile;
    kind: "service";
    methods: DescMethod[];
    name: string;
    proto: ServiceDescriptorProto;
    typeName: string;
    getComments(): DescComments;
    getFeatures(): MergedFeatureSet;
    toString(): string;
}

Properties

deprecated file kind methods name proto typeName

Methods

getComments getFeatures toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

Readonly file

file: DescFile

The file this service was declared in.

Readonly kind

kind: "service"

Readonly methods

methods: DescMethod[]

The RPCs this service declares.

Readonly name

name: string

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

Readonly proto

proto: ServiceDescriptorProto

The compiler-generated descriptor.

Readonly typeName

typeName: string

The fully qualified name of the service. (We omit the leading dot.)

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

deprecatedfilekindmethodsnameprototypeNamegetCommentsgetFeaturestoString