Class protos.google.protobuf.MessageOptions (2.3.1)

Represents a MessageOptions.

Package

@google-cloud/iap

Constructors

(constructor)(properties)

constructor(properties?: google.protobuf.IMessageOptions);

Constructs a new MessageOptions.

Parameter
NameDescription
properties IMessageOptions

Properties to set

Properties

deprecated

public deprecated: boolean;

MessageOptions deprecated.

deprecatedLegacyJsonFieldConflicts

public deprecatedLegacyJsonFieldConflicts: boolean;

MessageOptions deprecatedLegacyJsonFieldConflicts.

mapEntry

public mapEntry: boolean;

MessageOptions mapEntry.

messageSetWireFormat

public messageSetWireFormat: boolean;

MessageOptions messageSetWireFormat.

noStandardDescriptorAccessor

public noStandardDescriptorAccessor: boolean;

MessageOptions noStandardDescriptorAccessor.

uninterpretedOption

public uninterpretedOption: google.protobuf.IUninterpretedOption[];

MessageOptions uninterpretedOption.

Methods

create(properties)

public static create(properties?: google.protobuf.IMessageOptions): google.protobuf.MessageOptions;

Creates a new MessageOptions instance using the specified properties.

Parameter
NameDescription
properties IMessageOptions

Properties to set

Returns
TypeDescription
google.protobuf.MessageOptions

MessageOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.MessageOptions;

Decodes a MessageOptions message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.protobuf.MessageOptions

MessageOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.MessageOptions;

Decodes a MessageOptions message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.protobuf.MessageOptions

MessageOptions

encode(message, writer)

public static encode(message: google.protobuf.IMessageOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MessageOptions message. Does not implicitly messages.

Parameters
NameDescription
message IMessageOptions

MessageOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.protobuf.IMessageOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMessageOptions

MessageOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.protobuf.MessageOptions;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.protobuf.MessageOptions

MessageOptions

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for MessageOptions

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this MessageOptions to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(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
NameDescription
message google.protobuf.MessageOptions

MessageOptions

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MessageOptions message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not