Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class User.
A Cloud SQL user resource.
Generated from protobuf message google.cloud.sql.v1.User
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ kind
string
This is always sql#user
.
↳ password
string
The password for the user.
↳ etag
string
This field is deprecated and will be removed from a future version of the API.
↳ name
string
The name of the user in the Cloud SQL instance. Can be omitted for update
because it is already specified in the URL.
↳ host
string
Optional. The host from which the user can connect. For insert
operations, host defaults to an empty string. For update
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
↳ instance
string
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update
because it is already specified on the URL.
↳ project
string
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update
because it is already specified on the URL.
↳ type
int
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
↳ sqlserver_user_details
↳ iam_email
string
Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
↳ password_policy
↳ dual_password_type
int
Dual password status for the user.
↳ iam_status
int
Indicates if a group is active or inactive for IAM database authentication.
↳ database_roles
array
Optional. Role memberships of the user
getKind
This is always sql#user
.
string
setKind
This is always sql#user
.
var
string
$this
getPassword
The password for the user.
string
setPassword
The password for the user.
var
string
$this
getEtag
This field is deprecated and will be removed from a future version of the API.
string
setEtag
This field is deprecated and will be removed from a future version of the API.
var
string
$this
getName
The name of the user in the Cloud SQL instance. Can be omitted for update
because it is already specified in the URL.
string
setName
The name of the user in the Cloud SQL instance. Can be omitted for update
because it is already specified in the URL.
var
string
$this
getHost
Optional. The host from which the user can connect. For insert
operations, host defaults to an empty string. For update
operations, host is specified as part of the request URL. The host name
cannot be updated after insertion. For a MySQL instance, it's required;
for a PostgreSQL or SQL Server instance, it's optional.
string
setHost
Optional. The host from which the user can connect. For insert
operations, host defaults to an empty string. For update
operations, host is specified as part of the request URL. The host name
cannot be updated after insertion. For a MySQL instance, it's required;
for a PostgreSQL or SQL Server instance, it's optional.
var
string
$this
getInstance
The name of the Cloud SQL instance. This does not include the project ID.
Can be omitted for update
because it is already specified on the
URL.
string
setInstance
The name of the Cloud SQL instance. This does not include the project ID.
Can be omitted for update
because it is already specified on the
URL.
var
string
$this
getProject
The project ID of the project containing the Cloud SQL database. The Google
apps domain is prefixed if applicable. Can be omitted for update
because
it is already specified on the URL.
string
setProject
The project ID of the project containing the Cloud SQL database. The Google
apps domain is prefixed if applicable. Can be omitted for update
because
it is already specified on the URL.
var
string
$this
getType
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
setType
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
$this
getSqlserverUserDetails
Generated from protobuf field .google.cloud.sql.v1.SqlServerUserDetails sqlserver_user_details = 9;
hasSqlserverUserDetails
setSqlserverUserDetails
Generated from protobuf field .google.cloud.sql.v1.SqlServerUserDetails sqlserver_user_details = 9;
$this
getIamEmail
Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
string
setIamEmail
Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
var
string
$this
getPasswordPolicy
User level password validation policy.
hasPasswordPolicy
clearPasswordPolicy
setPasswordPolicy
User level password validation policy.
$this
getDualPasswordType
Dual password status for the user.
int
hasDualPasswordType
clearDualPasswordType
setDualPasswordType
Dual password status for the user.
var
int
$this
getIamStatus
Indicates if a group is active or inactive for IAM database authentication.
int
hasIamStatus
clearIamStatus
setIamStatus
Indicates if a group is active or inactive for IAM database authentication.
var
int
$this
getDatabaseRoles
Optional. Role memberships of the user
setDatabaseRoles
Optional. Role memberships of the user
var
string[]
$this
getUserDetails
string
