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.



3698
3699
3700
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3698

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) 


3637
3638
3639
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3637

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) 


3642
3643
3644
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3642

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) 


3651
3652
3653
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3651

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) 


3657
3658
3659
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3657

def instance
  @instance
end

#kind ⇒ String

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

Returns:

  • (String) 


3662
3663
3664
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3662

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) 


3668
3669
3670
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3668

def name
  @name
end

#password ⇒ String

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

Returns:

  • (String) 


3673
3674
3675
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3673

def password
  @password
end

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

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

Returns:



3678
3679
3680
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3678

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) 


3685
3686
3687
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3685

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:



3690
3691
3692
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3690

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) 


3696
3697
3698
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3696

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3703

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