Class protos.google.cloud.sql.v1.User (0.14.0)
Represents a User.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?:google.cloud.sql.v1.IUser);Constructs a new User.
| Parameter | |
|---|---|
| Name | Description |
properties | IUserProperties to set |
Properties
_dualPasswordType
public_dualPasswordType?:"dualPasswordType";User _dualPasswordType.
dualPasswordType
publicdualPasswordType?:(google.cloud.sql.v1.User.DualPasswordType|keyoftypeofgoogle.cloud.sql.v1.User.DualPasswordType|null);User dualPasswordType.
etag
publicetag:string;User etag.
host
publichost:string;User host.
instance
publicinstance:string;User instance.
kind
publickind:string;User kind.
name
publicname:string;User name.
password
publicpassword:string;User password.
passwordPolicy
publicpasswordPolicy?:(google.cloud.sql.v1.IUserPasswordValidationPolicy|null);User passwordPolicy.
project
publicproject:string;User project.
sqlserverUserDetails
publicsqlserverUserDetails?:(google.cloud.sql.v1.ISqlServerUserDetails|null);User sqlserverUserDetails.
type
publictype:(google.cloud.sql.v1.User.SqlUserType|keyoftypeofgoogle.cloud.sql.v1.User.SqlUserType);User type.
userDetails
publicuserDetails?:"sqlserverUserDetails";User userDetails.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.sql.v1.IUser):google.cloud.sql.v1.User;Creates a new User instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IUserProperties to set |
| Returns | |
|---|---|
| Type | Description |
User | User instance |
decode(reader, length)
publicstaticdecode(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 | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
User | User |
decodeDelimited(reader)
publicstaticdecodeDelimited(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 | User |
encode(message, writer)
publicstaticencode(message:google.cloud.sql.v1.IUser,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified User message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IUserUser message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(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 | IUserUser message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(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 | User |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for User
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this User to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(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 | UserUser |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(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) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.