Google Cloud Dms V1 Client - Class OracleConnectionProfile (2.0.3)

Reference documentation and code samples for the Google Cloud Dms V1 Client class OracleConnectionProfile.

Specifies connection parameters required specifically for Oracle databases.

Generated from protobuf message google.cloud.clouddms.v1.OracleConnectionProfile

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ host string

Required. The IP or hostname of the source Oracle database.

↳ port int

Required. The network port of the source Oracle database.

↳ 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.

↳ 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.

↳ password_set bool

Output only. Indicates whether a new password is included in the request.

↳ database_service string

Required. Database service for the Oracle connection.

↳ ssl SslConfig

SSL configuration for the connection to the source Oracle database. * * Only SERVER_ONLY configuration is supported for Oracle SSL. * * SSL is supported for Oracle versions 12 and above.

↳ static_service_ip_connectivity StaticServiceIpConnectivity

Static Service IP connectivity.

↳ forward_ssh_connectivity ForwardSshTunnelConnectivity

Forward SSH tunnel connectivity.

↳ private_connectivity PrivateConnectivity

Private connectivity.

getHost

Required. The IP or hostname of the source Oracle database.

Returns
Type Description
string

setHost

Required. The IP or hostname of the source Oracle database.

Parameter
Name Description
var string
Returns
Type Description
$this

getPort

Required. The network port of the source Oracle database.

Returns
Type Description
int

setPort

Required. The network port of the source Oracle database.

Parameter
Name Description
var int
Returns
Type Description
$this

getUsername

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

Returns
Type Description
string

setUsername

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPassword

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.

Returns
Type Description
string

setPassword

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getPasswordSet

Output only. Indicates whether a new password is included in the request.

Returns
Type Description
bool

setPasswordSet

Output only. Indicates whether a new password is included in the request.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDatabaseService

Required. Database service for the Oracle connection.

Returns
Type Description
string

setDatabaseService

Required. Database service for the Oracle connection.

Parameter
Name Description
var string
Returns
Type Description
$this

getSsl

SSL configuration for the connection to the source Oracle database.

  • Only SERVER_ONLY configuration is supported for Oracle SSL.
    • SSL is supported for Oracle versions 12 and above.
Returns
Type Description
SslConfig|null

hasSsl

clearSsl

setSsl

SSL configuration for the connection to the source Oracle database.

  • Only SERVER_ONLY configuration is supported for Oracle SSL.
    • SSL is supported for Oracle versions 12 and above.
Parameter
Name Description
var SslConfig
Returns
Type Description
$this

getStaticServiceIpConnectivity

Static Service IP connectivity.

Returns
Type Description
StaticServiceIpConnectivity|null

hasStaticServiceIpConnectivity

setStaticServiceIpConnectivity

Static Service IP connectivity.

Parameter
Name Description
var StaticServiceIpConnectivity
Returns
Type Description
$this

getForwardSshConnectivity

Forward SSH tunnel connectivity.

Returns
Type Description
ForwardSshTunnelConnectivity|null

hasForwardSshConnectivity

setForwardSshConnectivity

Forward SSH tunnel connectivity.

Parameter
Name Description
var ForwardSshTunnelConnectivity
Returns
Type Description
$this

getPrivateConnectivity

Private connectivity.

Returns
Type Description
PrivateConnectivity|null

hasPrivateConnectivity

setPrivateConnectivity

Private connectivity.

Parameter
Name Description
var PrivateConnectivity
Returns
Type Description
$this

getConnectivity

Returns
Type Description
string