Class google.protobuf.MessageOptions (2.1.1)

Represents a MessageOptions.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

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

Constructs a new MessageOptions.

Parameter

Name	Description
properties	`IMessageOptions` Properties to set

Properties

deprecated

public deprecated: boolean;

MessageOptions deprecated.

Property Value

Type	Description
boolean

mapEntry

public mapEntry: boolean;

MessageOptions mapEntry.

Property Value

Type	Description
boolean

messageSetWireFormat

public messageSetWireFormat: boolean;

MessageOptions messageSetWireFormat.

Property Value

Type	Description
boolean

noStandardDescriptorAccessor

public noStandardDescriptorAccessor: boolean;

MessageOptions noStandardDescriptorAccessor.

Property Value

Type	Description
boolean

uninterpretedOption

public uninterpretedOption: google.protobuf.IUninterpretedOption[];

MessageOptions uninterpretedOption.

Property Value

Type	Description
google.protobuf.IUninterpretedOption[]

Methods

create(properties)

public static create(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)

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

Decodes a MessageOptions message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
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

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
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 verify 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)

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

Encodes the specified MessageOptions message, length delimited. Does not implicitly verify 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)

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

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
MessageOptions	MessageOptions

toJSON()

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

Converts this MessageOptions to JSON.

Returns

Type	Description
{ [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

Name	Description
message	`MessageOptions` MessageOptions
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(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)	`null` if valid, otherwise the reason why it is not