Class google.protobuf.SourceCodeInfo.Location (4.1.3)

Represents a Location.

Package

@google-cloud/speech!

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 protobuf 
 . 
 SourceCodeInfo 
 . 
 ILocation 
 ); 
 

Constructs a new Location.

Parameter
Name Description
properties ILocation

Properties to set

Properties

leadingComments

  public 
  
 leadingComments 
 : 
  
 string 
 ; 
 

Location leadingComments.

Property Value
Type Description
string

leadingDetachedComments

  public 
  
 leadingDetachedComments 
 : 
  
 string 
 []; 
 

Location leadingDetachedComments.

Property Value
Type Description
string[]

path

  public 
  
 path 
 : 
  
 number 
 []; 
 

Location path.

Property Value
Type Description
number[]

span

  public 
  
 span 
 : 
  
 number 
 []; 
 

Location span.

Property Value
Type Description
number[]

trailingComments

  public 
  
 trailingComments 
 : 
  
 string 
 ; 
 

Location trailingComments.

Property Value
Type Description
string

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 protobuf 
 . 
 SourceCodeInfo 
 . 
 ILocation 
 ) 
 : 
  
 google 
 . 
 protobuf 
 . 
 SourceCodeInfo 
 . 
 Location 
 ; 
 

Creates a new Location instance using the specified properties.

Parameter
Name Description
properties ILocation

Properties to set

Returns
Type Description
Location

Location instance

decode(reader, length)

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

Decodes a Location message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf. Reader | Uint8Array )

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Location

Location

decodeDelimited(reader)

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

Decodes a Location message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf. Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type Description
Location

Location

encode(message, writer)

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

Encodes the specified Location message. Does not implicitly messages.

Parameters
Name Description
message ILocation

Location message or plain object to encode

writer $protobuf. Writer

Writer to encode to

Returns
Type Description
$protobuf. Writer

Writer

encodeDelimited(message, writer)

  public 
  
 static 
  
 encodeDelimited 
 ( 
 message 
 : 
  
 google 
 . 
 protobuf 
 . 
 SourceCodeInfo 
 . 
 ILocation 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name Description
message ILocation

Location message or plain object to encode

writer $protobuf. Writer

Writer to encode to

Returns
Type Description
$protobuf. Writer

Writer

fromObject(object)

  public 
  
 static 
  
 fromObject 
 ( 
 object 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }) 
 : 
  
 google 
 . 
 protobuf 
 . 
 SourceCodeInfo 
 . 
 Location 
 ; 
 

Creates a Location 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
Location

Location

toJSON()

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

Converts this Location to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Location

Location

options $protobuf. IConversionOptions

Conversion options

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

Plain object

verify(message)

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

Verifies a Location message.

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

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: