FieldOptions

google.protobuf. FieldOptions

Represents a FieldOptions.

Constructor

new FieldOptions(propertiesopt)

Constructs a new FieldOptions.

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

Properties to set

Implements:
  • IFieldOptions

Members

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

packed

FieldOptions packed.

packed

FieldOptions packed.

packed

FieldOptions packed.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

weak

FieldOptions weak.

weak

FieldOptions weak.

weak

FieldOptions weak.

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

Methods

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

google.protobuf. FieldOptions

Represents a FieldOptions.

Constructor

new FieldOptions(propertiesopt)

Constructs a new FieldOptions.

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

Properties to set

Implements:
  • IFieldOptions

Members

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

packed

FieldOptions packed.

packed

FieldOptions packed.

packed

FieldOptions packed.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

weak

FieldOptions weak.

weak

FieldOptions weak.

weak

FieldOptions weak.

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

Methods

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

google.protobuf. FieldOptions

Represents a FieldOptions.

Constructor

new FieldOptions(propertiesopt)

Constructs a new FieldOptions.

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

Properties to set

Implements:
  • IFieldOptions

Members

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

ctype

FieldOptions ctype.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

deprecated

FieldOptions deprecated.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

jstype

FieldOptions jstype.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

lazy

FieldOptions lazy.

packed

FieldOptions packed.

packed

FieldOptions packed.

packed

FieldOptions packed.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

uninterpretedOption

FieldOptions uninterpretedOption.

weak

FieldOptions weak.

weak

FieldOptions weak.

weak

FieldOptions weak.

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

CType

CType enum.

Properties:
Name Type Description
STRING string

STRING value

CORD string

CORD value

STRING_PIECE string

STRING_PIECE value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL string

JS_NORMAL value

JS_STRING string

JS_STRING value

JS_NUMBER string

JS_NUMBER value

Methods

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

FieldOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldOptions

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

FieldOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object