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.



6743
6744
6745
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6743

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>) 


6666
6667
6668
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6666

def database_roles
  @database_roles
end

#dual_password_type ⇒ String

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

Returns:

  • (String) 


6671
6672
6673
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6671

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) 


6676
6677
6678
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6676

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) 


6685
6686
6687
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6685

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) 


6691
6692
6693
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6691

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) 


6696
6697
6698
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6696

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) 


6702
6703
6704
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6702

def instance
  @instance
end

#kind ⇒ String

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

Returns:

  • (String) 


6707
6708
6709
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6707

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) 


6713
6714
6715
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6713

def name
  @name
end

#password ⇒ String

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

Returns:

  • (String) 


6718
6719
6720
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6718

def password
  @password
end

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

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

Returns:



6723
6724
6725
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6723

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) 


6730
6731
6732
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6730

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:



6735
6736
6737
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6735

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) 


6741
6742
6743
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6741

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 6748

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