Google Cloud Discovery Engine V1 Client - Class CloudSqlSource (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CloudSqlSource.

Cloud SQL source import data from.

Generated from protobuf message google.cloud.discoveryengine.v1.CloudSqlSource

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ project_id string

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

↳ instance_id string

Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.

↳ database_id string

Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.

↳ table_id string

Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.

↳ gcs_staging_dir string

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

↳ offload bool

Option for serverless export. Enabling this option will incur additional cost. More info can be found here.

getProjectId

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

Returns
Type Description
string

setProjectId

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceId

Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.

Returns
Type Description
string

setInstanceId

Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDatabaseId

Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.

Returns
Type Description
string

setDatabaseId

Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getTableId

Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.

Returns
Type Description
string

setTableId

Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getGcsStagingDir

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory.

Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

Returns
Type Description
string

setGcsStagingDir

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory.

Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

Parameter
Name Description
var string
Returns
Type Description
$this

getOffload

Option for serverless export. Enabling this option will incur additional cost. More info can be found here.

Returns
Type Description
bool

setOffload

Option for serverless export. Enabling this option will incur additional cost. More info can be found here.

Parameter
Name Description
var bool
Returns
Type Description
$this