Class protos.google.spanner.v1.Type (5.15.2)

Stay organized with collections Save and categorize content based on your preferences.

Represents a Type.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.v1.IType);

Constructs a new Type.

Parameter
NameDescription
properties IType

Properties to set

Properties

arrayElementType

public arrayElementType?: (google.spanner.v1.IType|null);

Type arrayElementType.

code

public code: (google.spanner.v1.TypeCode|keyof typeof google.spanner.v1.TypeCode);

Type code.

structType

public structType?: (google.spanner.v1.IStructType|null);

Type structType.

Methods

create(properties)

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

Creates a new Type instance using the specified properties.

Parameter
NameDescription
properties IType

Properties to set

Returns
TypeDescription
google.spanner.v1.Type

Type instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.v1.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.spanner.v1.Type

Type

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.v1.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.spanner.v1.Type

Type

encode(message, writer)

public static encode(message: google.spanner.v1.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.spanner.v1.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.spanner.v1.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.spanner.v1.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.spanner.v1.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.spanner.v1.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