Class protos.google.protobuf.Type

Represents a Type.

Package

@google-cloud/service-usage

Constructors

(constructor)(properties)

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

Constructs a new Type.

Parameter
NameDescription
properties IType

Properties to set

Properties

fields

public fields: google.protobuf.IField[];

Type fields.

name

public name: string;

Type name.

oneofs

public oneofs: string[];

Type oneofs.

options

public options: google.protobuf.IOption[];

Type options.

sourceContext

public sourceContext?: (google.protobuf.ISourceContext|null);

Type sourceContext.

syntax

public syntax: (google.protobuf.Syntax|keyof typeof google.protobuf.Syntax);

Type syntax.

Methods

create(properties)

public static create(properties?: google.protobuf.IType): google.protobuf.Type;

Creates a new Type instance using the specified properties.

Parameter
NameDescription
properties IType

Properties to set

Returns
TypeDescription
google.protobuf.Type

Type instance

decode(reader, length)

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

Decodes a Type 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.Type

Type

decodeDelimited(reader)

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

Decodes a Type 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.Type

Type

encode(message, writer)

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

Encodes the specified Type message. Does not implicitly messages.

Parameters
NameDescription
message IType

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

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

Parameters
NameDescription
message IType

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

Creates a Type 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.Type

Type

toJSON()

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

Converts this Type to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.protobuf.Type

Type

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