Class protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

Package

@google-cloud/network-management!

Constructors

(constructor)(properties)

constructor(properties?: google.protobuf.GeneratedCodeInfo.IAnnotation);

Constructs a new Annotation.

Parameter
TypeNameDescription
IAnnotationproperties

Properties to set

Properties

begin

public begin: number;

Annotation begin.

Property Value
TypeDescription
number

end

public end: number;

Annotation end.

Property Value
TypeDescription
number

path

public path: number[];

Annotation path.

Property Value
TypeDescription
number[]

sourceFile

public sourceFile: string;

Annotation sourceFile.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.protobuf.GeneratedCodeInfo.IAnnotation): google.protobuf.GeneratedCodeInfo.Annotation;

Creates a new Annotation instance using the specified properties.

Parameter
TypeNameDescription
IAnnotationproperties

Properties to set

Returns
TypeDescription
google.protobuf.GeneratedCodeInfo.Annotation

Annotation instance

decode(reader, length)

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

Decodes an Annotation message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.protobuf.GeneratedCodeInfo.Annotation

Annotation

decodeDelimited(reader)

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

Decodes an Annotation message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.protobuf.GeneratedCodeInfo.Annotation

Annotation

encode(message, writer)

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

Encodes the specified Annotation message. Does not implicitly messages.

Parameters
TypeNameDescription
IAnnotationmessage

Annotation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IAnnotationmessage

Annotation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.protobuf.GeneratedCodeInfo.Annotation

Annotation

toJSON()

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

Converts this Annotation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.protobuf.GeneratedCodeInfo.Annotationmessage

Annotation

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Annotation message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not