Google BigQuery Connection V1 Client - Class Connection (1.3.1)

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

Configuration parameters to establish connection with an external data source, except the credential attributes.

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

Namespace

Google \ Cloud \ BigQuery \ Connection \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

↳ friendly_name string

User provided display name for the connection.

↳ description string

User provided description.

↳ cloud_sql Google\Cloud\BigQuery\Connection\V1\CloudSqlProperties

Cloud SQL properties.

↳ aws Google\Cloud\BigQuery\Connection\V1\AwsProperties

Amazon Web Services (AWS) properties.

↳ azure Google\Cloud\BigQuery\Connection\V1\AzureProperties

Azure properties.

↳ cloud_spanner Google\Cloud\BigQuery\Connection\V1\CloudSpannerProperties

Cloud Spanner properties.

↳ cloud_resource Google\Cloud\BigQuery\Connection\V1\CloudResourceProperties

Cloud Resource properties.

↳ spark Google\Cloud\BigQuery\Connection\V1\SparkProperties

Spark properties.

↳ creation_time int|string

Output only. The creation timestamp of the connection.

↳ last_modified_time int|string

Output only. The last update timestamp of the connection.

↳ has_credential bool

Output only. True, if credential is configured for this connection.

getName

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

Returns
TypeDescription
string

setName

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFriendlyName

User provided display name for the connection.

Returns
TypeDescription
string

setFriendlyName

User provided display name for the connection.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

User provided description.

Returns
TypeDescription
string

setDescription

User provided description.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCloudSql

Cloud SQL properties.

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

hasCloudSql

setCloudSql

Cloud SQL properties.

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

getAws

Amazon Web Services (AWS) properties.

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

hasAws

setAws

Amazon Web Services (AWS) properties.

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

getAzure

Azure properties.

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

hasAzure

setAzure

Azure properties.

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

getCloudSpanner

Cloud Spanner properties.

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

hasCloudSpanner

setCloudSpanner

Cloud Spanner properties.

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

getCloudResource

Cloud Resource properties.

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

hasCloudResource

setCloudResource

Cloud Resource properties.

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

getSpark

Spark properties.

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

hasSpark

setSpark

Spark properties.

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

getCreationTime

Output only. The creation timestamp of the connection.

Returns
TypeDescription
int|string

setCreationTime

Output only. The creation timestamp of the connection.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getLastModifiedTime

Output only. The last update timestamp of the connection.

Returns
TypeDescription
int|string

setLastModifiedTime

Output only. The last update timestamp of the connection.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getHasCredential

Output only. True, if credential is configured for this connection.

Returns
TypeDescription
bool

setHasCredential

Output only. True, if credential is configured for this connection.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getProperties

Returns
TypeDescription
string