Class protos.google.protobuf.EnumValue

Represents an EnumValue.

Package

@google-cloud/service-usage

Constructors

(constructor)(properties)

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

Constructs a new EnumValue.

Parameter
NameDescription
properties IEnumValue

Properties to set

Properties

name

public name: string;

EnumValue name.

number

public number: number;

EnumValue number.

options

public options: google.protobuf.IOption[];

EnumValue options.

Methods

create(properties)

public static create(properties?: google.protobuf.IEnumValue): google.protobuf.EnumValue;

Creates a new EnumValue instance using the specified properties.

Parameter
NameDescription
properties IEnumValue

Properties to set

Returns
TypeDescription
google.protobuf.EnumValue

EnumValue instance

decode(reader, length)

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

Decodes an EnumValue 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.EnumValue

EnumValue

decodeDelimited(reader)

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

Decodes an EnumValue 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.EnumValue

EnumValue

encode(message, writer)

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

Encodes the specified EnumValue message. Does not implicitly messages.

Parameters
NameDescription
message IEnumValue

EnumValue 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.IEnumValue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IEnumValue

EnumValue 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.EnumValue;

Creates an EnumValue 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.EnumValue

EnumValue

toJSON()

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

Converts this EnumValue to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.protobuf.EnumValue, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.protobuf.EnumValue

EnumValue

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an EnumValue 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