Class google.cloud.scheduler.v1.OAuthToken (2.1.1)

Represents a OAuthToken.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 scheduler 
 . 
 v1 
 . 
 IOAuthToken 
 ); 
 

Constructs a new OAuthToken.

Parameter
Name Description
properties IOAuthToken

Properties to set

Properties

scope

  public 
  
 scope 
 : 
  
 string 
 ; 
 

OAuthToken scope.

Property Value
Type Description
string

serviceAccountEmail

  public 
  
 serviceAccountEmail 
 : 
  
 string 
 ; 
 

OAuthToken serviceAccountEmail.

Property Value
Type Description
string

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 scheduler 
 . 
 v1 
 . 
 IOAuthToken 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 scheduler 
 . 
 v1 
 . 
 OAuthToken 
 ; 
 

Creates a new OAuthToken instance using the specified properties.

Parameter
Name Description
properties IOAuthToken

Properties to set

Returns
Type Description
OAuthToken

OAuthToken instance

decode(reader, length)

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

Decodes a OAuthToken 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
OAuthToken

OAuthToken

decodeDelimited(reader)

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

Decodes a OAuthToken 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
OAuthToken

OAuthToken

encode(message, writer)

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

Encodes the specified OAuthToken message. Does not implicitly verify messages.

Parameters
Name Description
message IOAuthToken

OAuthToken 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 
 . 
 scheduler 
 . 
 v1 
 . 
 IOAuthToken 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name Description
message IOAuthToken

OAuthToken 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 
 . 
 scheduler 
 . 
 v1 
 . 
 OAuthToken 
 ; 
 

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

OAuthToken

toJSON()

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

Converts this OAuthToken to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message OAuthToken

OAuthToken

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 OAuthToken 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: