Google Cloud Sql Admin V1 Client - Class User (0.3.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
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 updatesince it is already specified in the URL.

↳ host
string

The host name from which the user can connect. For insertoperations, host defaults to an empty string. For updateoperations, host is specified as part of the request URL. The host name cannot be updated after insertion.

↳ instance
string

The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for updatesince 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 updatesince 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

getKind

This is always sql#user.

Returns
Type
Description
string

setKind

This is always sql#user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPassword

The password for the user.

Returns
Type
Description
string

setPassword

The password for the user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEtag

This field is deprecated and will be removed from a future version of the API.

Returns
Type
Description
string

setEtag

This field is deprecated and will be removed from a future version of the API.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getName

The name of the user in the Cloud SQL instance. Can be omitted for updatesince it is already specified in the URL.

Returns
Type
Description
string

setName

The name of the user in the Cloud SQL instance. Can be omitted for updatesince it is already specified in the URL.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getHost

The host name from which the user can connect. For insertoperations, host defaults to an empty string. For updateoperations, host is specified as part of the request URL. The host name cannot be updated after insertion.

Returns
Type
Description
string

setHost

The host name from which the user can connect. For insertoperations, host defaults to an empty string. For updateoperations, host is specified as part of the request URL. The host name cannot be updated after insertion.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInstance

The name of the Cloud SQL instance. This does not include the project ID.

Can be omitted for updatesince it is already specified on the URL.

Returns
Type
Description
string

setInstance

The name of the Cloud SQL instance. This does not include the project ID.

Can be omitted for updatesince it is already specified on the URL.

Parameter
Name
Description
var
string
Returns
Type
Description
$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 updatesince it is already specified on the URL.

Returns
Type
Description
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 updatesince it is already specified on the URL.

Parameter
Name
Description
var
string
Returns
Type
Description
$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.

Returns
Type
Description
int

setType

The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getSqlserverUserDetails

Generated from protobuf field .google.cloud.sql.v1.SqlServerUserDetails sqlserver_user_details = 9;

Returns
Type
Description

hasSqlserverUserDetails

setSqlserverUserDetails

Generated from protobuf field .google.cloud.sql.v1.SqlServerUserDetails sqlserver_user_details = 9;

Parameter
Name
Description
Returns
Type
Description
$this

getUserDetails

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: