Class protos.google.protobuf.DescriptorProto (0.1.0)

Represents a DescriptorProto.

Package

@google-cloud/servicehealth

Constructors

(constructor)(properties)

constructor(properties?: google.protobuf.IDescriptorProto);

Constructs a new DescriptorProto.

Parameter
Name Description
properties IDescriptorProto

Properties to set

Properties

enumType

public enumType: google.protobuf.IEnumDescriptorProto[];

DescriptorProto enumType.

extension

public extension: google.protobuf.IFieldDescriptorProto[];

DescriptorProto extension.

extensionRange

public extensionRange: google.protobuf.DescriptorProto.IExtensionRange[];

DescriptorProto extensionRange.

field

public field: google.protobuf.IFieldDescriptorProto[];

DescriptorProto field.

name

public name: string;

DescriptorProto name.

nestedType

public nestedType: google.protobuf.IDescriptorProto[];

DescriptorProto nestedType.

oneofDecl

public oneofDecl: google.protobuf.IOneofDescriptorProto[];

DescriptorProto oneofDecl.

options

public options?: (google.protobuf.IMessageOptions|null);

DescriptorProto options.

reservedName

public reservedName: string[];

DescriptorProto reservedName.

reservedRange

public reservedRange: google.protobuf.DescriptorProto.IReservedRange[];

DescriptorProto reservedRange.

Methods

create(properties)

public static create(properties?: google.protobuf.IDescriptorProto): google.protobuf.DescriptorProto;

Creates a new DescriptorProto instance using the specified properties.

Parameter
Name Description
properties IDescriptorProto

Properties to set

Returns
Type Description
DescriptorProto

DescriptorProto instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.DescriptorProto;

Decodes a DescriptorProto message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
DescriptorProto

DescriptorProto

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.DescriptorProto;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DescriptorProto

DescriptorProto

encode(message, writer)

public static encode(message: google.protobuf.IDescriptorProto, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DescriptorProto message. Does not implicitly messages.

Parameters
Name Description
message IDescriptorProto

DescriptorProto message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.protobuf.IDescriptorProto, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DescriptorProto message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IDescriptorProto

DescriptorProto message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.protobuf.DescriptorProto;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
DescriptorProto

DescriptorProto

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DescriptorProto

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this DescriptorProto to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.protobuf.DescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message DescriptorProto

DescriptorProto

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a DescriptorProto message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not