Class protos.google.protobuf.MessageOptions (4.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Represents a MessageOptions.
Package
@google-cloud/access-context-managerConstructors
(constructor)(properties)
constructor(properties?:google.protobuf.IMessageOptions);Constructs a new MessageOptions.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMessageOptions
Properties to set |
Properties
deprecated
publicdeprecated:boolean;MessageOptions deprecated.
deprecatedLegacyJsonFieldConflicts
publicdeprecatedLegacyJsonFieldConflicts:boolean;MessageOptions deprecatedLegacyJsonFieldConflicts.
features
publicfeatures?:(google.protobuf.IFeatureSet|null);MessageOptions features.
mapEntry
publicmapEntry:boolean;MessageOptions mapEntry.
messageSetWireFormat
publicmessageSetWireFormat:boolean;MessageOptions messageSetWireFormat.
noStandardDescriptorAccessor
publicnoStandardDescriptorAccessor:boolean;MessageOptions noStandardDescriptorAccessor.
uninterpretedOption
publicuninterpretedOption:google.protobuf.IUninterpretedOption[];MessageOptions uninterpretedOption.
Methods
create(properties)
publicstaticcreate(properties?:google.protobuf.IMessageOptions):google.protobuf.MessageOptions;Creates a new MessageOptions instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMessageOptions
Properties to set |
| Returns | |
|---|---|
| Type | Description |
MessageOptions |
MessageOptions instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.protobuf.MessageOptions;Decodes a MessageOptions 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 |
MessageOptions |
MessageOptions |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.MessageOptions;Decodes a MessageOptions message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
MessageOptions |
MessageOptions |
encode(message, writer)
publicstaticencode(message:google.protobuf.IMessageOptions,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified MessageOptions message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMessageOptions
MessageOptions 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.IMessageOptions,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified MessageOptions message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMessageOptions
MessageOptions 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.MessageOptions;Creates a MessageOptions 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 |
MessageOptions |
MessageOptions |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for MessageOptions
| 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 MessageOptions to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
publicstatictoObject(message:google.protobuf.MessageOptions,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a MessageOptions message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
MessageOptions
MessageOptions |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a MessageOptions message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|