Class: Google::Apis::SqladminV1::User

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

A Cloud SQL user resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ User

Returns a new instance of User.



5000
5001
5002
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 5000

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dual_password_type ⇒ String

Dual password status for the user. Corresponds to the JSON property dualPasswordType

Returns:

  • (String) 


4939
4940
4941
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4939

def dual_password_type
  @dual_password_type
end

#etag ⇒ String

This field is deprecated and will be removed from a future version of the API. Corresponds to the JSON property etag

Returns:

  • (String) 


4944
4945
4946
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4944

def etag
  @etag
end

#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. Corresponds to the JSON property host

Returns:

  • (String) 


4953
4954
4955
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4953

def host
  @host
end

#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. Corresponds to the JSON property instance

Returns:

  • (String) 


4959
4960
4961
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4959

def instance
  @instance
end

#kind ⇒ String

This is always sql#user. Corresponds to the JSON property kind

Returns:

  • (String) 


4964
4965
4966
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4964

def kind
  @kind
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


4970
4971
4972
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4970

def name
  @name
end

#password ⇒ String

The password for the user. Corresponds to the JSON property password

Returns:

  • (String) 


4975
4976
4977
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4975

def password
  @password
end

#password_policy ⇒ Google::Apis::SqladminV1::UserPasswordValidationPolicy

User level password validation policy. Corresponds to the JSON property passwordPolicy

Returns:



4980
4981
4982
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4980

def password_policy
  @password_policy
end

#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. Corresponds to the JSON property project

Returns:

  • (String) 


4987
4988
4989
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4987

def project
  @project
end

#sqlserver_user_details ⇒ Google::Apis::SqladminV1::SqlServerUserDetails

Represents a Sql Server user on the Cloud SQL instance. Corresponds to the JSON property sqlserverUserDetails

Returns:



4992
4993
4994
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4992

def sqlserver_user_details
  @sqlserver_user_details
end

#type ⇒ String

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

Returns:

  • (String) 


4998
4999
5000
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 4998

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 5005

def update!(**args)
  @dual_password_type = args[:dual_password_type] if args.key?(:dual_password_type)
  @etag = args[:etag] if args.key?(:etag)
  @host = args[:host] if args.key?(:host)
  @instance = args[:instance] if args.key?(:instance)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @password = args[:password] if args.key?(:password)
  @password_policy = args[:password_policy] if args.key?(:password_policy)
  @project = args[:project] if args.key?(:project)
  @sqlserver_user_details = args[:sqlserver_user_details] if args.key?(:sqlserver_user_details)
  @type = args[:type] if args.key?(:type)
end