Class protos.google.api.ClientLibrarySettings (3.3.1)

Represents a ClientLibrarySettings.

Package

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 api 
 . 
 IClientLibrarySettings 
 );

Constructs a new ClientLibrarySettings.

Parameter

Name	Description
`properties`	`IClientLibrarySettings` Properties to set

Properties

cppSettings

  public 
  
 cppSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 ICppSettings 
 | 
 null 
 );

ClientLibrarySettings cppSettings.

dotnetSettings

  public 
  
 dotnetSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IDotnetSettings 
 | 
 null 
 );

ClientLibrarySettings dotnetSettings.

goSettings

  public 
  
 goSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IGoSettings 
 | 
 null 
 );

ClientLibrarySettings goSettings.

javaSettings

  public 
  
 javaSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IJavaSettings 
 | 
 null 
 );

ClientLibrarySettings javaSettings.

launchStage

  public 
  
 launchStage 
 : 
  
 ( 
 google 
 . 
 api 
 . 
 LaunchStage 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 api 
 . 
 LaunchStage 
 );

ClientLibrarySettings launchStage.

nodeSettings

  public 
  
 nodeSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 INodeSettings 
 | 
 null 
 );

ClientLibrarySettings nodeSettings.

phpSettings

  public 
  
 phpSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IPhpSettings 
 | 
 null 
 );

ClientLibrarySettings phpSettings.

pythonSettings

  public 
  
 pythonSettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IPythonSettings 
 | 
 null 
 );

ClientLibrarySettings pythonSettings.

restNumericEnums

  public 
  
 restNumericEnums 
 : 
  
 boolean 
 ;

ClientLibrarySettings restNumericEnums.

rubySettings

  public 
  
 rubySettings 
 ?: 
  
 ( 
 google 
 . 
 api 
 . 
 IRubySettings 
 | 
 null 
 );

ClientLibrarySettings rubySettings.

version

  public 
  
 version 
 : 
  
 string 
 ;

ClientLibrarySettings version.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 api 
 . 
 IClientLibrarySettings 
 ) 
 : 
  
 google 
 . 
 api 
 . 
 ClientLibrarySettings 
 ;

Creates a new ClientLibrarySettings instance using the specified properties.

Parameter

Name	Description
`properties`	`IClientLibrarySettings` Properties to set

Returns

Type	Description
`google.api.ClientLibrarySettings`	ClientLibrarySettings instance

decode(reader, length)

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

Decodes a ClientLibrarySettings 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.api.ClientLibrarySettings`	ClientLibrarySettings

decodeDelimited(reader)

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

Decodes a ClientLibrarySettings 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.api.ClientLibrarySettings`	ClientLibrarySettings

encode(message, writer)

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

Encodes the specified ClientLibrarySettings message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IClientLibrarySettings` ClientLibrarySettings 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 
 . 
 api 
 . 
 IClientLibrarySettings 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ;

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

Parameters

Name	Description
`message`	`IClientLibrarySettings` ClientLibrarySettings 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 
 . 
 api 
 . 
 ClientLibrarySettings 
 ;

Creates a ClientLibrarySettings 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.api.ClientLibrarySettings`	ClientLibrarySettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ClientLibrarySettings

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 ClientLibrarySettings to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
`message`	`google.api.ClientLibrarySettings` ClientLibrarySettings
`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 ClientLibrarySettings 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

Class protos.google.api.ClientLibrarySettings (3.3.1) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(properties)

Properties

cppSettings

dotnetSettings

goSettings

javaSettings

launchStage

nodeSettings

phpSettings

pythonSettings

restNumericEnums

rubySettings

version

Methods

create(properties)

decode(reader, length)

decodeDelimited(reader)

encode(message, writer)

encodeDelimited(message, writer)

fromObject(object)

getTypeUrl(typeUrlPrefix)

toJSON()

toObject(message, options)

verify(message)

Class protos.google.api.ClientLibrarySettings (3.3.1)