Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::User (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::User.

A Cloud SQL user resource.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#database_roles

def database_roles() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Role memberships of the user

#database_roles=

def database_roles=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Role memberships of the user
Returns
  • (::Array<::String>) — Optional. Role memberships of the user

#dual_password_type

def dual_password_type() -> ::Google::Cloud::Sql::V1::User::DualPasswordType
Returns

#dual_password_type=

def dual_password_type=(value) -> ::Google::Cloud::Sql::V1::User::DualPasswordType
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — This field is deprecated and will be removed from a future version of the API.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — This field is deprecated and will be removed from a future version of the API.
Returns
  • (::String) — This field is deprecated and will be removed from a future version of the API.

#host

def host() -> ::String
Returns
  • (::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.

#host=

def host=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#iam_email

def iam_email() -> ::String
Returns
  • (::String) — Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.

#iam_email=

def iam_email=(value) -> ::String
Parameter
  • value (::String) — Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
Returns
  • (::String) — Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.

#iam_status

def iam_status() -> ::Google::Cloud::Sql::V1::User::IamStatus
Returns

#iam_status=

def iam_status=(value) -> ::Google::Cloud::Sql::V1::User::IamStatus
Parameter
Returns

#instance

def instance() -> ::String
Returns
  • (::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.

#instance=

def instance=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#kind

def kind() -> ::String
Returns
  • (::String) — This is always sql#user.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — This is always sql#user.
Returns
  • (::String) — This is always sql#user.

#name

def name() -> ::String
Returns
  • (::String) — The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
Returns
  • (::String) — The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.

#password

def password() -> ::String
Returns
  • (::String) — The password for the user.

#password=

def password=(value) -> ::String
Parameter
  • value (::String) — The password for the user.
Returns
  • (::String) — The password for the user.

#password_policy

def password_policy() -> ::Google::Cloud::Sql::V1::UserPasswordValidationPolicy
Returns

#password_policy=

def password_policy=(value) -> ::Google::Cloud::Sql::V1::UserPasswordValidationPolicy
Parameter
Returns

#project

def project() -> ::String
Returns
  • (::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.

#project=

def project=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#sqlserver_user_details

def sqlserver_user_details() -> ::Google::Cloud::Sql::V1::SqlServerUserDetails
Returns

#sqlserver_user_details=

def sqlserver_user_details=(value) -> ::Google::Cloud::Sql::V1::SqlServerUserDetails
Parameter
Returns

#type

def type() -> ::Google::Cloud::Sql::V1::User::SqlUserType
Returns

#type=

def type=(value) -> ::Google::Cloud::Sql::V1::User::SqlUserType
Parameter
Returns