Class protos.google.spanner.v1.Type

Represents a Type.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new Type.

Parameter
Type Name Description
IType
properties

Properties to set

Properties

arrayElementType

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

Type arrayElementType.

Property Value
Type Description
( google.spanner.v1.IType |null)

code

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

Type code.

Property Value
Type Description
( google.spanner.v1.TypeCode |keyof typeof google.spanner.v1.TypeCode )

structType

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

Type structType.

Property Value
Type Description
( google.spanner.v1.IStructType |null)

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
Type Name Description
IType
properties

Properties to set

Returns
Type Description
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
Type Name Description
($protobuf. Reader | Uint8Array )
reader

Reader or buffer to decode from

number
length

Message length if known beforehand

Returns
Type Description
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
Type Name Description
($protobuf. Reader | Uint8Array )
reader

Reader or buffer to decode from

Returns
Type Description
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
Type Name Description
IType
message

Type message or plain object to encode

$protobuf. Writer
writer

Writer to encode to

Returns
Type Description
$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
Type Name Description
IType
message

Type message or plain object to encode

$protobuf. Writer
writer

Writer to encode to

Returns
Type Description
$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
Type Name Description
{ [k: string]: any }
object

Plain object

Returns
Type Description
google.spanner.v1.Type

Type

toJSON()

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

Converts this Type to JSON.

Returns
Type Description
{ [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
Type Name Description
google.spanner.v1.Type
message

Type

$protobuf. IConversionOptions
options

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Type message.

Parameter
Type Name Description
{ [k: string]: any }
message

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not

Design a Mobile Site
View Site in Mobile | Classic
Share by: