Class protos.google.cloud.iap.v1.OAuth2 (4.2.0)

Represents a OAuth2.

Package

@google-cloud/iap

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IOAuth2 
 ); 
 

Constructs a new OAuth2.

Parameter
Name
Description
properties
IOAuth2

Properties to set

Properties

clientId

  public 
  
 clientId 
 : 
  
 string 
 ; 
 

OAuth2 clientId.

clientSecret

  public 
  
 clientSecret 
 : 
  
 string 
 ; 
 

OAuth2 clientSecret.

clientSecretSha256

  public 
  
 clientSecretSha256 
 : 
  
 string 
 ; 
 

OAuth2 clientSecretSha256.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IOAuth2 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 OAuth2 
 ; 
 

Creates a new OAuth2 instance using the specified properties.

Parameter
Name
Description
properties
IOAuth2

Properties to set

Returns
Type
Description

OAuth2 instance

decode(reader, length)

  public 
  
 static 
  
 decode 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 ), 
  
 length 
 ?: 
  
 number 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 OAuth2 
 ; 
 

Decodes a OAuth2 message from the specified reader or buffer.

Parameters
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

length
number

Message length if known beforehand

Returns
Type
Description

OAuth2

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 )) 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 OAuth2 
 ; 
 

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

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

OAuth2

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IOAuth2 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified OAuth2 message. Does not implicitly messages.

Parameters
Name
Description
message
IOAuth2

OAuth2 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 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IOAuth2 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
IOAuth2

OAuth2 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 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 OAuth2 
 ; 
 

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

OAuth2

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OAuth2

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
OAuth2

OAuth2

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 OAuth2 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

Create a Mobile Website
View Site in Mobile | Classic
Share by: