Class protos.google.cloud.sql.v1.User (0.7.0)

Represents a User.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IUser 
 ); 
 

Constructs a new User.

Parameter
Name
Description
properties
IUser

Properties to set

Properties

_dualPasswordType

  public 
  
 _dualPasswordType 
 ?: 
  
 "dualPasswordType" 
 ; 
 

User _dualPasswordType.

dualPasswordType

  public 
  
 dualPasswordType 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 User 
 . 
 DualPasswordType 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 User 
 . 
 DualPasswordType 
 | 
 null 
 ); 
 

User dualPasswordType.

etag

  public 
  
 etag 
 : 
  
 string 
 ; 
 

User etag.

host

  public 
  
 host 
 : 
  
 string 
 ; 
 

User host.

instance

  public 
  
 instance 
 : 
  
 string 
 ; 
 

User instance.

kind

  public 
  
 kind 
 : 
  
 string 
 ; 
 

User kind.

name

  public 
  
 name 
 : 
  
 string 
 ; 
 

User name.

password

  public 
  
 password 
 : 
  
 string 
 ; 
 

User password.

passwordPolicy

  public 
  
 passwordPolicy 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IUserPasswordValidationPolicy 
 | 
 null 
 ); 
 

User passwordPolicy.

project

  public 
  
 project 
 : 
  
 string 
 ; 
 

User project.

sqlserverUserDetails

  public 
  
 sqlserverUserDetails 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 ISqlServerUserDetails 
 | 
 null 
 ); 
 

User sqlserverUserDetails.

type

  public 
  
 type 
 : 
  
 ( 
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 User 
 . 
 SqlUserType 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 User 
 . 
 SqlUserType 
 ); 
 

User type.

userDetails

  public 
  
 userDetails 
 ?: 
  
 "sqlserverUserDetails" 
 ; 
 

User userDetails.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IUser 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 User 
 ; 
 

Creates a new User instance using the specified properties.

Parameter
Name
Description
properties
IUser

Properties to set

Returns
Type
Description

User instance

decode(reader, length)

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

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

User

decodeDelimited(reader)

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

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

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

User

encode(message, writer)

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

Encodes the specified User message. Does not implicitly messages.

Parameters
Name
Description
message
IUser

User 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 
 . 
 sql 
 . 
 v1 
 . 
 IUser 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
IUser

User 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 
 . 
 sql 
 . 
 v1 
 . 
 User 
 ; 
 

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

User

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for User

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
User

User

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