Class protos.google.spanner.v1.Type (7.5.0)
Represents a Type.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?:google.spanner.v1.IType);Constructs a new Type.
| Parameter | |
|---|---|
| Name | Description |
properties | ITypeProperties to set |
Properties
arrayElementType
publicarrayElementType?:(google.spanner.v1.IType|null);Type arrayElementType.
code
publiccode:(google.spanner.v1.TypeCode|keyoftypeofgoogle.spanner.v1.TypeCode);Type code.
protoTypeFqn
publicprotoTypeFqn:string;Type protoTypeFqn.
structType
publicstructType?:(google.spanner.v1.IStructType|null);Type structType.
typeAnnotation
publictypeAnnotation:(google.spanner.v1.TypeAnnotationCode|keyoftypeofgoogle.spanner.v1.TypeAnnotationCode);Type typeAnnotation.
Methods
create(properties)
publicstaticcreate(properties?:google.spanner.v1.IType):google.spanner.v1.Type;Creates a new Type instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | ITypeProperties to set |
| Returns | |
|---|---|
| Type | Description |
Type | Type instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.spanner.v1.Type;Decodes a Type message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Type | Type |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.spanner.v1.Type;Decodes a Type message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Type | Type |
encode(message, writer)
publicstaticencode(message:google.spanner.v1.IType,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Type message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | ITypeType message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.spanner.v1.IType,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Type message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | ITypeType message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(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 | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
Type | Type |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Type
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Type to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(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 | |
|---|---|
| Name | Description |
message | TypeType |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Type message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.