MessageOptions

google.protobuf. MessageOptions

Represents a MessageOptions.

Constructor

new MessageOptions(propertiesopt)

Constructs a new MessageOptions.

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

Properties to set
Implements:
  • IMessageOptions

Members

deprecated

MessageOptions deprecated.

mapEntry

MessageOptions mapEntry.

messageSetWireFormat

MessageOptions messageSetWireFormat.

noStandardDescriptorAccessor

MessageOptions noStandardDescriptorAccessor.

uninterpretedOption

MessageOptions uninterpretedOption.

Methods

(static) create(propertiesopt) → {google.protobuf.MessageOptions}

Creates a new MessageOptions instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.protobuf.MessageOptions

MessageOptions instance

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

Decodes a MessageOptions 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.MessageOptions

MessageOptions
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.MessageOptions}

Decodes a MessageOptions 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.MessageOptions

MessageOptions
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 MessageOptions message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IMessageOptions

MessageOptions 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 MessageOptions message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IMessageOptions

MessageOptions 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.MessageOptions}

Creates a MessageOptions 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.MessageOptions

MessageOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for MessageOptions

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 a MessageOptions message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.protobuf.MessageOptions

MessageOptions
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies a MessageOptions 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 MessageOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object