Class: FeatureSet
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
Implements
Constructors
constructor
• new FeatureSet(properties?): FeatureSet
Constructs a new FeatureSet.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFeatureSet | Properties to set |
Returns
Properties
enumType
• enumType: EnumType
FeatureSet enumType.
Implementation of
fieldPresence
• fieldPresence: FieldPresence
FeatureSet fieldPresence.
Implementation of
jsonFormat
• jsonFormat: JsonFormat
FeatureSet jsonFormat.
Implementation of
messageEncoding
• messageEncoding: MessageEncoding
FeatureSet messageEncoding.
Implementation of
repeatedFieldEncoding
• repeatedFieldEncoding: RepeatedFieldEncoding
FeatureSet repeatedFieldEncoding.
Implementation of
IFeatureSet.repeatedFieldEncoding
utf8Validation
• utf8Validation: Utf8Validation
FeatureSet utf8Validation.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this FeatureSet to JSON.
Returns
Object
JSON object
create
▸ create(properties?): FeatureSet
Creates a new FeatureSet instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFeatureSet | Properties to set |
Returns
FeatureSet instance
decode
▸ decode(reader, length?): FeatureSet
Decodes a FeatureSet message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
FeatureSet
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): FeatureSet
Decodes a FeatureSet message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
FeatureSet
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified FeatureSet message. Does not implicitly google.protobuf.FeatureSet.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFeatureSet | FeatureSet message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified FeatureSet message, length delimited. Does not implicitly google.protobuf.FeatureSet.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFeatureSet | FeatureSet message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): FeatureSet
Creates a FeatureSet message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
FeatureSet
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for FeatureSet
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a FeatureSet message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | FeatureSet | FeatureSet |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object