Class protos.google.protobuf.EnumOptions (3.1.2)

Represents an EnumOptions.

Package

@google-cloud/tasks

Constructors

(constructor)(properties)

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

Constructs a new EnumOptions.

Parameter
Name
Description
properties
IEnumOptions

Properties to set

Properties

allowAlias

  public 
  
 allowAlias 
 : 
  
 boolean 
 ; 
 

EnumOptions allowAlias.

deprecated

  public 
  
 deprecated 
 : 
  
 boolean 
 ; 
 

EnumOptions deprecated.

uninterpretedOption

  public 
  
 uninterpretedOption 
 : 
  
 google 
 . 
 protobuf 
 . 
 IUninterpretedOption 
 []; 
 

EnumOptions uninterpretedOption.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 protobuf 
 . 
 IEnumOptions 
 ) 
 : 
  
 google 
 . 
 protobuf 
 . 
 EnumOptions 
 ; 
 

Creates a new EnumOptions instance using the specified properties.

Parameter
Name
Description
properties
IEnumOptions

Properties to set

Returns
Type
Description
google.protobuf.EnumOptions

EnumOptions instance

decode(reader, length)

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

Decodes an EnumOptions 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
google.protobuf.EnumOptions

EnumOptions

decodeDelimited(reader)

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

Decodes an EnumOptions 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
google.protobuf.EnumOptions

EnumOptions

encode(message, writer)

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

Encodes the specified EnumOptions message. Does not implicitly messages.

Parameters
Name
Description
message
IEnumOptions

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

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

Parameters
Name
Description
message
IEnumOptions

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

Creates an EnumOptions 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
google.protobuf.EnumOptions

EnumOptions

getTypeUrl(typeUrlPrefix)

  public 
  
 static 
  
 getTypeUrl 
 ( 
 typeUrlPrefix 
 ?: 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Gets the default type url for EnumOptions

Parameter
Name
Description
typeUrlPrefix
string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type
Description
string

The default type url

toJSON()

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

Converts this EnumOptions to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
google.protobuf.EnumOptions

EnumOptions

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 an EnumOptions 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: