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.



3605
3606
3607
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3605

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

Instance Attribute Details

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


3549
3550
3551
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3549

def etag
  @etag
end

#host ⇒ String

Optional. The host name 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) 


3558
3559
3560
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3558

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 since it is already specified on the URL. Corresponds to the JSON property instance

Returns:

  • (String) 


3564
3565
3566
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3564

def instance
  @instance
end

#kind ⇒ String

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

Returns:

  • (String) 


3569
3570
3571
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3569

def kind
  @kind
end

#name ⇒ String

The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified in the URL. Corresponds to the JSON property name

Returns:

  • (String) 


3575
3576
3577
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3575

def name
  @name
end

#password ⇒ String

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

Returns:

  • (String) 


3580
3581
3582
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3580

def password
  @password
end

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

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

Returns:



3585
3586
3587
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3585

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 since it is already specified on the URL. Corresponds to the JSON property project

Returns:

  • (String) 


3592
3593
3594
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3592

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:



3597
3598
3599
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3597

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) 


3603
3604
3605
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3603

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3610

def update!(**args)
  @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