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.



6627
6628
6629
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6627

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

Instance Attribute Details

#database_roles ⇒ Array<String>

Optional. Role memberships of the user Corresponds to the JSON property databaseRoles

Returns:

  • (Array<String>) 


6550
6551
6552
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6550

def database_roles
  @database_roles
end

#dual_password_type ⇒ String

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

Returns:

  • (String) 


6555
6556
6557
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6555

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) 


6560
6561
6562
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6560

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) 


6569
6570
6571
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6569

def host
  @host
end

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

Returns:

  • (String) 


6575
6576
6577
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6575

def iam_email
  @iam_email
end

#iam_status ⇒ String

Indicates if a group is active or inactive for IAM database authentication. Corresponds to the JSON property iamStatus

Returns:

  • (String) 


6580
6581
6582
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6580

def iam_status
  @iam_status
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) 


6586
6587
6588
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6586

def instance
  @instance
end

#kind ⇒ String

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

Returns:

  • (String) 


6591
6592
6593
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6591

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) 


6597
6598
6599
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6597

def name
  @name
end

#password ⇒ String

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

Returns:

  • (String) 


6602
6603
6604
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6602

def password
  @password
end

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

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

Returns:



6607
6608
6609
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6607

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) 


6614
6615
6616
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6614

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:



6619
6620
6621
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6619

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) 


6625
6626
6627
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6625

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6632

def update!(**args)
  @database_roles = args[:database_roles] if args.key?(:database_roles)
  @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)
  @iam_email = args[:iam_email] if args.key?(:iam_email)
  @iam_status = args[:iam_status] if args.key?(:iam_status)
  @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