Class protos.google.protobuf.GeneratedCodeInfo.Annotation (1.16.0)

Represents an Annotation.

Package

Constructors

(constructor)(properties)

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

Constructs a new Annotation.

Parameter
Name	Description
`properties`	`IAnnotation` Properties to set

Properties

begin

publicbegin:number;

Annotation begin.

end

publicend:number;

Annotation end.

path

publicpath:number[];

Annotation path.

semantic

publicsemantic:(google.protobuf.GeneratedCodeInfo.Annotation.Semantic|keyoftypeofgoogle.protobuf.GeneratedCodeInfo.Annotation.Semantic);

Annotation semantic.

sourceFile

publicsourceFile:string;

Annotation sourceFile.

Methods

create(properties)

publicstaticcreate(properties?:google.protobuf.GeneratedCodeInfo.IAnnotation):google.protobuf.GeneratedCodeInfo.Annotation;

Creates a new Annotation instance using the specified properties.

Parameter
Name	Description
`properties`	`IAnnotation` Properties to set

Returns
Type	Description
`Annotation`	Annotation instance

decode(reader, length)

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

Decodes an Annotation 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
`Annotation`	Annotation

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.GeneratedCodeInfo.Annotation;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Annotation`	Annotation

encode(message, writer)

publicstaticencode(message:google.protobuf.GeneratedCodeInfo.IAnnotation,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified Annotation message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IAnnotation` Annotation message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.protobuf.GeneratedCodeInfo.IAnnotation,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
Name	Description
`message`	`IAnnotation` Annotation message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

publicstaticfromObject(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
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`Annotation`	Annotation

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for Annotation

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

publictoJSON():{[k:string]:any};

Converts this Annotation to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

publicstatictoObject(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
Name	Description
`message`	`Annotation` Annotation
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies an Annotation 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

Class protos.google.protobuf.GeneratedCodeInfo.Annotation (1.16.0) Stay organized with collections Save and categorize content based on your preferences.