REST Resource: projects.locations.connectionProfiles

Resource: ConnectionProfile

A set of reusable connection configurations to be used as a source or destination for a stream.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,

  // Union field profile can be only one of the following:
  "oracleProfile": {
    object (OracleProfile)
  },
  "gcsProfile": {
    object (GcsProfile)
  },
  "mysqlProfile": {
    object (MysqlProfile)
  },
  "bigqueryProfile": {
    object (BigQueryProfile)
  },
  "postgresqlProfile": {
    object (PostgresqlProfile)
  },
  "sqlServerProfile": {
    object (SqlServerProfile)
  }
  // End of list of possible types for union field profile.

  // Union field connectivity can be only one of the following:
  "staticServiceIpConnectivity": {
    object (StaticServiceIpConnectivity)
  },
  "forwardSshConnectivity": {
    object (ForwardSshTunnelConnectivity)
  },
  "privateConnectivity": {
    object (PrivateConnectivity)
  }
  // End of list of possible types for union field connectivity.
}
Fields
name

string

Output only. The resource's name.
createTime

string (Timestamp format)

Output only. The create time of the resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The update time of the resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Required. Display name.
Union field profile. Connection configuration for the ConnectionProfile. profile can be only one of the following:
oracleProfile

object (OracleProfile)

Oracle ConnectionProfile configuration.
gcsProfile

object (GcsProfile)

Cloud Storage ConnectionProfile configuration.
mysqlProfile

object (MysqlProfile)

MySQL ConnectionProfile configuration.
bigqueryProfile

object (BigQueryProfile)

BigQuery Connection Profile configuration.
postgresqlProfile

object (PostgresqlProfile)

PostgreSQL Connection Profile configuration.
sqlServerProfile

object (SqlServerProfile)

SQLServer Connection Profile configuration.
Union field connectivity. Connectivity options used to establish a connection to the profile. connectivity can be only one of the following:
staticServiceIpConnectivity

object (StaticServiceIpConnectivity)

Static Service IP connectivity.
forwardSshConnectivity

object (ForwardSshTunnelConnectivity)

Forward SSH tunnel connectivity.
privateConnectivity

object (PrivateConnectivity)

Private connectivity.

OracleProfile

Oracle database profile.

JSON representation 
{
  "hostname": string,
  "port": integer,
  "username": string,
  "password": string,
  "databaseService": string,
  "connectionAttributes": {
    string: string,
    ...
  },
  "oracleSslConfig": {
    object (OracleSslConfig)
  },
  "secretManagerStoredPassword": string
}
Fields
hostname

string

Required. Hostname for the Oracle connection.
port

integer

Port for the Oracle connection, default value is 1521.
username

string

Required. Username for the Oracle connection.
password

string

Optional. Password for the Oracle connection. Mutually exclusive with the secretManagerStoredPassword field.
databaseService

string

Required. Database for the Oracle connection.
connectionAttributes

map (key: string, value: string)

Connection string attributes

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
oracleSslConfig

object (OracleSslConfig)

Optional. SSL configuration for the Oracle connection.
secretManagerStoredPassword

string

Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the password field.

OracleSslConfig

Oracle SSL configuration information.

JSON representation 
{
  "caCertificate": string,
  "caCertificateSet": boolean
}
Fields
caCertificate

string

Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet

boolean

Output only. Indicates whether the caCertificate field has been set for this Connection-Profile.

GcsProfile

Cloud Storage bucket profile.

JSON representation 
{
  "bucket": string,
  "rootPath": string
}
Fields
bucket

string

Required. The Cloud Storage bucket name.
rootPath

string

The root path inside the Cloud Storage bucket.

MysqlProfile

MySQL database profile.

JSON representation 
{
  "hostname": string,
  "port": integer,
  "username": string,
  "password": string,
  "sslConfig": {
    object (MysqlSslConfig)
  }
}
Fields
hostname

string

Required. Hostname for the MySQL connection.
port

integer

Port for the MySQL connection, default value is 3306.
username

string

Required. Username for the MySQL connection.
password

string

Required. Input only. Password for the MySQL connection.
sslConfig

object (MysqlSslConfig)

SSL configuration for the MySQL connection.

MysqlSslConfig

MySQL SSL configuration information.

JSON representation 
{
  "clientKey": string,
  "clientKeySet": boolean,
  "clientCertificate": string,
  "clientCertificateSet": boolean,
  "caCertificate": string,
  "caCertificateSet": boolean
}
Fields
clientKey

string

Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'clientCertificate' and the 'caCertificate' fields are mandatory.
clientKeySet

boolean

Output only. Indicates whether the clientKey field is set.
clientCertificate

string

Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory.
clientCertificateSet

boolean

Output only. Indicates whether the clientCertificate field is set.
caCertificate

string

Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet

boolean

Output only. Indicates whether the caCertificate field is set.

BigQueryProfile

This type has no fields.

BigQuery warehouse profile.

PostgresqlProfile

PostgreSQL database profile.

JSON representation 
{
  "hostname": string,
  "port": integer,
  "username": string,
  "password": string,
  "database": string
}
Fields
hostname

string

Required. Hostname for the PostgreSQL connection.
port

integer

Port for the PostgreSQL connection, default value is 5432.
username

string

Required. Username for the PostgreSQL connection.
password

string

Required. Password for the PostgreSQL connection.
database

string

Required. Database for the PostgreSQL connection.

SqlServerProfile

SQLServer database profile.

JSON representation 
{
  "hostname": string,
  "port": integer,
  "username": string,
  "password": string,
  "database": string
}
Fields
hostname

string

Required. Hostname for the SQLServer connection.
port

integer

Port for the SQLServer connection, default value is 1433.
username

string

Required. Username for the SQLServer connection.
password

string

Required. Password for the SQLServer connection.
database

string

Required. Database for the SQLServer connection.

StaticServiceIpConnectivity

This type has no fields.

Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile.

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

JSON representation 
{
  "hostname": string,
  "username": string,
  "port": integer,

  // Union field authentication_method can be only one of the following:
  "password": string,
  "privateKey": string
  // End of list of possible types for union field authentication_method.
}
Fields
hostname

string

Required. Hostname for the SSH tunnel.
username

string

Required. Username for the SSH tunnel.
port

integer

Port for the SSH tunnel, default value is 22.

Union field authentication_method.

authentication_method can be only one of the following:
password

string

Input only. SSH password.
privateKey

string

Input only. SSH private key.

PrivateConnectivity

Private Connectivity

JSON representation 
{
  "privateConnection": string
}
Fields
privateConnection

string

Required. A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

Methods

create

 Use this method to create a connection profile in a project and location.

delete

 Use this method to delete a connection profile.

discover

 Use this method to discover a connection profile.

get

 Use this method to get details about a connection profile.

list

 Use this method to list connection profiles created in a project and location.

patch

 Use this method to update the parameters of a connection profile.