Google BigQuery Connection V1 Client - Class CloudSqlProperties (1.1.0)

Reference documentation and code samples for the Google BigQuery Connection V1 Client class CloudSqlProperties.

Connection properties specific to the Cloud SQL.

Generated from protobuf message google.cloud.bigquery.connection.v1.CloudSqlProperties

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ instance_id string

Cloud SQL instance ID in the form project:location:instance.

↳ database string

Database name.

↳ type int

Type of the Cloud SQL database.

↳ credential Google\Cloud\BigQuery\Connection\V1\CloudSqlCredential

Input only. Cloud SQL credential.

↳ service_account_id string

Output only. The account ID of the service used for the purpose of this connection. When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

getInstanceId

Cloud SQL instance ID in the form project:location:instance.

Returns
TypeDescription
string

setInstanceId

Cloud SQL instance ID in the form project:location:instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDatabase

Database name.

Returns
TypeDescription
string

setDatabase

Database name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Type of the Cloud SQL database.

Returns
TypeDescription
int

setType

Type of the Cloud SQL database.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCredential

Input only. Cloud SQL credential.

Returns
TypeDescription
Google\Cloud\BigQuery\Connection\V1\CloudSqlCredential|null

hasCredential

clearCredential

setCredential

Input only. Cloud SQL credential.

Parameter
NameDescription
var Google\Cloud\BigQuery\Connection\V1\CloudSqlCredential
Returns
TypeDescription
$this

getServiceAccountId

Output only. The account ID of the service used for the purpose of this connection.

When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

Returns
TypeDescription
string

setServiceAccountId

Output only. The account ID of the service used for the purpose of this connection.

When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

Parameter
NameDescription
var string
Returns
TypeDescription
$this