Console
    Contact Us Start free

    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 
 , 
 "satisfiesPzs" 
 : 
 boolean 
 , 
 "satisfiesPzi" 
 : 
 boolean 
 , 
 // 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 
 
) 
 } 
 , 
 "salesforceProfile" 
 : 
 { 
 object (  SalesforceProfile 
 
) 
 } 
 , 
 "mongodbProfile" 
 : 
 { 
 object (  MongodbProfile 
 
) 
 } 
 // 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. Identifier. The resource's name.

    createTime

    string ( Timestamp format)

    Output only. The create time of the resource.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    updateTime

    string ( Timestamp format)

    Output only. The update time of the resource.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    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.

    satisfiesPzs

    boolean

    Output only. Reserved for future use.

    satisfiesPzi

    boolean

    Output only. Reserved for future use.

    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.

    salesforceProfile

    object ( SalesforceProfile )

    Salesforce Connection Profile configuration.

    mongodbProfile

    object ( MongodbProfile )

    MongoDB 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 
 
) 
 } 
 , 
 "oracleAsmConfig" 
 : 
 { 
 object (  OracleAsmConfig 
 
) 
 } 
 , 
 "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.
    oracleAsmConfig

    object ( OracleAsmConfig )

    Optional. Configuration for Oracle ASM 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 
 , 
 "serverCertificateDistinguishedName" 
 : 
 string 
 }
    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.
    serverCertificateDistinguishedName

    string

    Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced.

    OracleAsmConfig

    Configuration for Oracle Automatic Storage Management (ASM) connection.

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

    string

    Required. Hostname for the Oracle ASM connection.
    port

    integer

    Required. Port for the Oracle ASM connection.
    username

    string

    Required. Username for the Oracle ASM connection.
    password

    string

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

    string

    Required. ASM service name for the Oracle ASM connection.
    connectionAttributes

    map (key: string, value: string)

    Optional. 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 ASM connection password. Mutually exclusive with the password field.

    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 
 
) 
 } 
 , 
 "secretManagerStoredPassword" 
 : 
 string 
 }
    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

    Optional. Input only. Password for the MySQL connection. Mutually exclusive with the secretManagerStoredPassword field.
    sslConfig

    object ( MysqlSslConfig )

    SSL configuration for the MySQL connection.
    secretManagerStoredPassword

    string

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

    MysqlSslConfig

    MySQL SSL configuration information.

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

    string

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

    Optional. 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 
 , 
 "secretManagerStoredPassword" 
 : 
 string 
 , 
 "sslConfig" 
 : 
 { 
 object (  PostgresqlSslConfig 
 
) 
 } 
 }
    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

    Optional. Password for the PostgreSQL connection. Mutually exclusive with the secretManagerStoredPassword field.
    database

    string

    Required. Database for the PostgreSQL connection.
    secretManagerStoredPassword

    string

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

    object ( PostgresqlSslConfig )

    Optional. SSL configuration for the PostgreSQL connection. In case PostgresqlSslConfig is not set, the connection will use the default SSL mode, which is prefer (i.e. this mode will only use encryption if enabled from database side, otherwise will use unencrypted communication)

    PostgresqlSslConfig

    PostgreSQL SSL configuration information.

    JSON representation 
     { 
 // Union field encryption_setting 
can be only one of the following: 
 "serverVerification" 
 : 
 { 
 object (  ServerVerification 
 
) 
 } 
 , 
 "serverAndClientVerification" 
 : 
 { 
 object (  ServerAndClientVerification 
 
) 
 } 
 // End of list of possible types for union field encryption_setting 
. 
 }
    Fields
    Union field encryption_setting . The encryption settings available for PostgreSQL connection profiles. This captures various SSL mode supported by PostgreSQL, which includes TLS encryption with server verification, TLS encryption with both server and client verification and no TLS encryption. encryption_setting can be only one of the following:
    serverVerification

    object ( ServerVerification )

     If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated.

    serverAndClientVerification

    object ( ServerAndClientVerification )

    If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated.

    ServerVerification

    Message represents the option where Datastream will enforce the encryption and authenticate the server identity. caCertificate must be set if user selects this option.

    JSON representation 
     { 
 "caCertificate" 
 : 
 string 
 , 
 "serverCertificateHostname" 
 : 
 string 
 }
    Fields
    caCertificate

    string

    Required. Input only. PEM-encoded server root CA certificate.
    serverCertificateHostname

    string

    Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated.

    ServerAndClientVerification

    Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. caCertificate, clientCertificate and clientKey must be set if user selects this option.

    JSON representation 
     { 
 "clientCertificate" 
 : 
 string 
 , 
 "clientKey" 
 : 
 string 
 , 
 "caCertificate" 
 : 
 string 
 , 
 "serverCertificateHostname" 
 : 
 string 
 }
    Fields
    clientCertificate

    string

    Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate.
    clientKey

    string

    Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream.
    caCertificate

    string

    Required. Input only. PEM-encoded server root CA certificate.
    serverCertificateHostname

    string

    Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated.

    SqlServerProfile

    SQLServer database profile.

    JSON representation 
     { 
 "hostname" 
 : 
 string 
 , 
 "port" 
 : 
 integer 
 , 
 "username" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 , 
 "database" 
 : 
 string 
 , 
 "sslConfig" 
 : 
 { 
 object (  SqlServerSslConfig 
 
) 
 } 
 , 
 "secretManagerStoredPassword" 
 : 
 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

    Optional. Password for the SQLServer connection. Mutually exclusive with the secretManagerStoredPassword field.
    database

    string

    Required. Database for the SQLServer connection.
    sslConfig

    object ( SqlServerSslConfig )

    Optional. SSL configuration for the SQLServer connection.
    secretManagerStoredPassword

    string

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

    SqlServerSslConfig

    SQL Server SSL configuration information.

    JSON representation 
     { 
 // Union field encryption_setting 
can be only one of the following: 
 "encryptionNotEnforced" 
 : 
 { 
 object (  EncryptionNotEnforced 
 
) 
 } 
 , 
 "basicEncryption" 
 : 
 { 
 object (  BasicEncryption 
 
) 
 } 
 , 
 "encryptionAndServerValidation" 
 : 
 { 
 object (  EncryptionAndServerValidation 
 
) 
 } 
 // End of list of possible types for union field encryption_setting 
. 
 }
    Fields
    Union field encryption_setting . The encryption settings available for SQL Server connection profiles. This captures various options like no TLS encryption from client if server doesn't ask for it, only encryption without validation and both encryption as well as validation of server certificate. encryption_setting can be only one of the following:
    encryptionNotEnforced

    object ( EncryptionNotEnforced )

    If set, Datastream will not enforce encryption. If the DB server mandates encryption, then connection will be encrypted but server identity will not be authenticated.

    basicEncryption

    object ( BasicEncryption )

    If set, Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.

    encryptionAndServerValidation

    object ( EncryptionAndServerValidation )

    If set, Datastream will enforce encryption and authenticate server identity.

    EncryptionNotEnforced

    This type has no fields.

    Message to represent the option where encryption is not enforced. An empty message right now to allow future extensibility.

    BasicEncryption

    This type has no fields.

    Message to represent the option where Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.

    EncryptionAndServerValidation

    Message to represent the option where Datastream will enforce encryption and authenticate server identity. caCertificate must be set if user selects this option.

    JSON representation 
     { 
 "caCertificate" 
 : 
 string 
 , 
 "serverCertificateHostname" 
 : 
 string 
 }
    Fields
    caCertificate

    string

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

    string

    Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. This field is used for bypassing the hostname validation while verifying server certificate. This is required for scenarios where the host name that datastream connects to is different from the certificate's subject. This specifically happens for private connectivity. It could also happen when the customer provides a public IP in connection profile but the same is not present in the server certificate.

    SalesforceProfile

    Salesforce profile

    JSON representation 
     { 
 "domain" 
 : 
 string 
 , 
 // Union field credentials 
can be only one of the following: 
 "userCredentials" 
 : 
 { 
 object (  UserCredentials 
 
) 
 } 
 , 
 "oauth2ClientCredentials" 
 : 
 { 
 object (  Oauth2ClientCredentials 
 
) 
 } 
 // End of list of possible types for union field credentials 
. 
 }
    Fields
    domain

    string

    Required. Domain endpoint for the Salesforce connection.

    Union field credentials . Credentials for Salesforce connection. credentials can be only one of the following:
    userCredentials

    object ( UserCredentials )

    User-password authentication.

    oauth2ClientCredentials

    object ( Oauth2ClientCredentials )

    Connected app authentication.

    UserCredentials

    Username-password credentials.

    JSON representation 
     { 
 "username" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 , 
 "securityToken" 
 : 
 string 
 , 
 "secretManagerStoredPassword" 
 : 
 string 
 , 
 "secretManagerStoredSecurityToken" 
 : 
 string 
 }
    Fields
    username

    string

    Required. Username for the Salesforce connection.
    password

    string

    Optional. Password for the Salesforce connection. Mutually exclusive with the secretManagerStoredPassword field.
    securityToken

    string

    Optional. Security token for the Salesforce connection. Mutually exclusive with the secretManagerStoredSecurityToken field.
    secretManagerStoredPassword

    string

    Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the password field.
    secretManagerStoredSecurityToken

    string

    Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the securityToken field.

    Oauth2ClientCredentials

    OAuth2 Client Credentials.

    JSON representation 
     { 
 "clientId" 
 : 
 string 
 , 
 "clientSecret" 
 : 
 string 
 , 
 "secretManagerStoredClientSecret" 
 : 
 string 
 }
    Fields
    clientId

    string

    Required. Client ID for Salesforce OAuth2 Client Credentials.
    clientSecret

    string

    Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the secretManagerStoredClientSecret field.
    secretManagerStoredClientSecret

    string

    Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 clientSecret. Mutually exclusive with the clientSecret field.

    MongodbProfile

    MongoDB profile.

    JSON representation 
     { 
 "hostAddresses" 
 : 
 [ 
 { 
 object (  HostAddress 
 
) 
 } 
 ] 
 , 
 "replicaSet" 
 : 
 string 
 , 
 "username" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 , 
 "secretManagerStoredPassword" 
 : 
 string 
 , 
 "sslConfig" 
 : 
 { 
 object (  MongodbSslConfig 
 
) 
 } 
 , 
 // Union field mongodb_connection_format 
can be only one of the following: 
 "srvConnectionFormat" 
 : 
 { 
 object (  SrvConnectionFormat 
 
) 
 } 
 , 
 "standardConnectionFormat" 
 : 
 { 
 object (  StandardConnectionFormat 
 
) 
 } 
 // End of list of possible types for union field mongodb_connection_format 
. 
 }
    Fields
    hostAddresses[]

    object ( HostAddress )

    Required. List of host addresses for a MongoDB cluster. For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.

    replicaSet

    string

    Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty. For Standard connection format, this field must be specified.

    username

    string

    Required. Username for the MongoDB connection.

    password

    string

    Optional. Password for the MongoDB connection. Mutually exclusive with the secretManagerStoredPassword field.

    secretManagerStoredPassword

    string

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

    sslConfig

    object ( MongodbSslConfig )

    Optional. SSL configuration for the MongoDB connection.

    Union field mongodb_connection_format . MongoDB connection format. Must specify either srv_connection_format or standard_connection_format. mongodb_connection_format can be only one of the following:
    srvConnectionFormat

    object ( SrvConnectionFormat )

    Srv connection format.

    standardConnectionFormat

    object ( StandardConnectionFormat )

    Standard connection format.

    HostAddress

    A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.

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

    string

    Required. Hostname for the connection.
    port

    integer

    Optional. Port for the connection.

    MongodbSslConfig

    MongoDB SSL configuration information.

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

    string

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

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

    Optional. 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.
    secretManagerStoredClientKey

    string

    Optional. Input only. A reference to a Secret Manager resource name storing the PEM-encoded private key associated with the Client Certificate. If this field is used then the 'clientCertificate' and the 'caCertificate' fields are mandatory. Mutually exclusive with the clientKey field.

    SrvConnectionFormat

    This type has no fields.

    Srv connection format.

    StandardConnectionFormat

    Standard connection format.

    JSON representation 
     { 
 "directConnection" 
 : 
 boolean 
 }
    Fields
    directConnection

    boolean

    Optional. Specifies whether the client connects directly to the host[:port] in the connection URI.

    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.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: