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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance_id |
string
Cloud SQL instance ID in the form |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setInstanceId
Cloud SQL instance ID in the form project:location:instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatabase
Database name.
| Returns | |
|---|---|
| Type | Description |
string | |
setDatabase
Database name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Type of the Cloud SQL database.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Type of the Cloud SQL database.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCredential
Input only. Cloud SQL credential.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\Connection\V1\CloudSqlCredential|null | |
hasCredential
clearCredential
setCredential
Input only. Cloud SQL credential.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\Connection\V1\CloudSqlCredential
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |