Annotation

google.protobuf.GeneratedCodeInfo. Annotation

Represents an Annotation.

Constructor

new Annotation(propertiesopt)

Constructs a new Annotation.

Parameters:
Name Type Attributes Description
properties google.protobuf.GeneratedCodeInfo.IAnnotation <optional>

Properties to set
Implements:
  • IAnnotation

Members

Semantic

Semantic enum.

Properties:
Name Type Description
NONE number

NONE value
SET number

SET value
ALIAS number

ALIAS value

begin

Annotation begin.

end

Annotation end.

path

Annotation path.

semantic

Annotation semantic.

sourceFile

Annotation sourceFile.

Methods

(static) create(propertiesopt) → {google.protobuf.GeneratedCodeInfo.Annotation}

Creates a new Annotation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.protobuf.GeneratedCodeInfo.IAnnotation <optional>

Properties to set
Returns:
Type Description
google.protobuf.GeneratedCodeInfo.Annotation

Annotation instance

(static) decode(reader, lengthopt) → {google.protobuf.GeneratedCodeInfo.Annotation}

Decodes an Annotation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.protobuf.GeneratedCodeInfo.Annotation

Annotation
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.protobuf.GeneratedCodeInfo.Annotation}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.protobuf.GeneratedCodeInfo.Annotation

Annotation
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Annotation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.GeneratedCodeInfo.IAnnotation

Annotation message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.protobuf.GeneratedCodeInfo.IAnnotation

Annotation message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.protobuf.GeneratedCodeInfo.Annotation}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.protobuf.GeneratedCodeInfo.Annotation

Annotation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Annotation

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.protobuf.GeneratedCodeInfo.Annotation

Annotation
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Annotation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Annotation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object