Class: Google::Apis::DatamigrationV1::PostgreSqlConnectionProfile

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

Overview

Specifies connection parameters required specifically for PostgreSQL databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PostgreSqlConnectionProfile

Returns a new instance of PostgreSqlConnectionProfile.



4480
4481
4482
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4480

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

Instance Attribute Details

#alloydb_cluster_id ⇒ String

Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID. Corresponds to the JSON property alloydbClusterId

Returns:

  • (String) 


4395
4396
4397
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4395

def alloydb_cluster_id
  @alloydb_cluster_id
end

#cloud_sql_id ⇒ String

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. Corresponds to the JSON property cloudSqlId

Returns:

  • (String) 


4401
4402
4403
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4401

def cloud_sql_id
  @cloud_sql_id
end

#database ⇒ String

Optional. The name of the specific database within the host. Corresponds to the JSON property database

Returns:

  • (String) 


4406
4407
4408
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4406

def database
  @database
end

#enable_iam_authentication ⇒ Boolean Also known as: enable_iam_authentication?

Optional. If true, Database Migration Service will use IAM database authentication to connect to the database. Corresponds to the JSON property enableIamAuthentication

Returns:

  • (Boolean) 


4412
4413
4414
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4412

def enable_iam_authentication
  @enable_iam_authentication
end

#forward_ssh_connectivity ⇒ Google::Apis::DatamigrationV1::ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity. Corresponds to the JSON property forwardSshConnectivity

Returns:



4418
4419
4420
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4418

def forward_ssh_connectivity
  @forward_ssh_connectivity
end

#host ⇒ String

Required. The IP or hostname of the source PostgreSQL database. Corresponds to the JSON property host

Returns:

  • (String) 


4423
4424
4425
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4423

def host
  @host
end

#network_architecture ⇒ String

Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with. Corresponds to the JSON property networkArchitecture

Returns:

  • (String) 


4429
4430
4431
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4429

def network_architecture
  @network_architecture
end

#password ⇒ String

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. Corresponds to the JSON property password

Returns:

  • (String) 


4437
4438
4439
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4437

def password
  @password
end

#password_set ⇒ Boolean Also known as: password_set?

Output only. Indicates If this connection profile password is stored. Corresponds to the JSON property passwordSet

Returns:

  • (Boolean) 


4442
4443
4444
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4442

def password_set
  @password_set
end

#port ⇒ Fixnum

Required. The network port of the source PostgreSQL database. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


4448
4449
4450
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4448

def port
  @port
end

#private_connectivity ⇒ Google::Apis::DatamigrationV1::PrivateConnectivity

Private Connectivity. Corresponds to the JSON property privateConnectivity

Returns:



4453
4454
4455
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4453

def private_connectivity
  @private_connectivity
end

#private_service_connect_connectivity ⇒ Google::Apis::DatamigrationV1::PrivateServiceConnectConnectivity

Private Service Connect connectivity Corresponds to the JSON property privateServiceConnectConnectivity

Returns:



4459
4460
4461
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4459

def private_service_connect_connectivity
  @private_service_connect_connectivity
end

#ssl ⇒ Google::Apis::DatamigrationV1::SslConfig

SSL configuration information. Corresponds to the JSON property ssl

Returns:



4464
4465
4466
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4464

def ssl
  @ssl
end

#static_ip_connectivity ⇒ Google::Apis::DatamigrationV1::StaticIpConnectivity

The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. Corresponds to the JSON property staticIpConnectivity

Returns:



4472
4473
4474
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4472

def static_ip_connectivity
  @static_ip_connectivity
end

#username ⇒ String

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. Corresponds to the JSON property username

Returns:

  • (String) 


4478
4479
4480
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4478

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 4485

def update!(**args)
  @alloydb_cluster_id = args[:alloydb_cluster_id] if args.key?(:alloydb_cluster_id)
  @cloud_sql_id = args[:cloud_sql_id] if args.key?(:cloud_sql_id)
  @database = args[:database] if args.key?(:database)
  @enable_iam_authentication = args[:enable_iam_authentication] if args.key?(:enable_iam_authentication)
  @forward_ssh_connectivity = args[:forward_ssh_connectivity] if args.key?(:forward_ssh_connectivity)
  @host = args[:host] if args.key?(:host)
  @network_architecture = args[:network_architecture] if args.key?(:network_architecture)
  @password = args[:password] if args.key?(:password)
  @password_set = args[:password_set] if args.key?(:password_set)
  @port = args[:port] if args.key?(:port)
  @private_connectivity = args[:private_connectivity] if args.key?(:private_connectivity)
  @private_service_connect_connectivity = args[:private_service_connect_connectivity] if args.key?(:private_service_connect_connectivity)
  @ssl = args[:ssl] if args.key?(:ssl)
  @static_ip_connectivity = args[:static_ip_connectivity] if args.key?(:static_ip_connectivity)
  @username = args[:username] if args.key?(:username)
end