Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource.
Cloud SQL source import data from.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#database_id
defdatabase_id()->::String
Returns
(::String) — Required. The Cloud SQL database to copy the data from with a length limit
of 256 characters.
#database_id=
defdatabase_id=(value)->::String
Parameter
value (::String) — Required. The Cloud SQL database to copy the data from with a length limit
of 256 characters.
Returns
(::String) — Required. The Cloud SQL database to copy the data from with a length limit
of 256 characters.
#gcs_staging_dir
defgcs_staging_dir()->::String
Returns
(::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.
#gcs_staging_dir=
defgcs_staging_dir=(value)->::String
Parameter
value (::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.
Returns
(::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.
#instance_id
definstance_id()->::String
Returns
(::String) — Required. The Cloud SQL instance to copy the data from with a length limit
of 256 characters.
#instance_id=
definstance_id=(value)->::String
Parameter
value (::String) — Required. The Cloud SQL instance to copy the data from with a length limit
of 256 characters.
Returns
(::String) — Required. The Cloud SQL instance to copy the data from with a length limit
of 256 characters.
#offload
defoffload()->::Boolean
Returns
(::Boolean) — Option for serverless export. Enabling this option will incur additional
cost. More info can be found
here.
#offload=
defoffload=(value)->::Boolean
Parameter
value (::Boolean) — Option for serverless export. Enabling this option will incur additional
cost. More info can be found
here.
Returns
(::Boolean) — Option for serverless export. Enabling this option will incur additional
cost. More info can be found
here.
#project_id
defproject_id()->::String
Returns
(::String) — The project ID that contains the Cloud SQL source. Has a length limit of
128 characters. If not specified, inherits the project ID from the parent
request.
#project_id=
defproject_id=(value)->::String
Parameter
value (::String) — The project ID that contains the Cloud SQL source. Has a length limit of
128 characters. If not specified, inherits the project ID from the parent
request.
Returns
(::String) — The project ID that contains the Cloud SQL source. Has a length limit of
128 characters. If not specified, inherits the project ID from the parent
request.
#table_id
deftable_id()->::String
Returns
(::String) — Required. The Cloud SQL table to copy the data from with a length limit of
256 characters.
#table_id=
deftable_id=(value)->::String
Parameter
value (::String) — Required. The Cloud SQL table to copy the data from with a length limit of
256 characters.
Returns
(::String) — Required. The Cloud SQL table to copy the data from with a length limit of
256 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-CloudSqlSource) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource.\n\nCloud SQL source import data from. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #database_id\n\n def database_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.\n\n### #database_id=\n\n def database_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. \n**Returns**\n\n- (::String) --- Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.\n\n### #gcs_staging_dir\n\n def gcs_staging_dir() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n Ensure that the Cloud SQL service account has the necessary Cloud\n Storage Admin permissions to access the specified Cloud Storage directory.\n\n### #gcs_staging_dir=\n\n def gcs_staging_dir=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\n Ensure that the Cloud SQL service account has the necessary Cloud\nStorage Admin permissions to access the specified Cloud Storage directory. \n**Returns**\n\n- (::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.\n\n Ensure that the Cloud SQL service account has the necessary Cloud\n Storage Admin permissions to access the specified Cloud Storage directory.\n\n### #instance_id\n\n def instance_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.\n\n### #instance_id=\n\n def instance_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. \n**Returns**\n\n- (::String) --- Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.\n\n### #offload\n\n def offload() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).\n\n### #offload=\n\n def offload=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). \n**Returns**\n\n- (::Boolean) --- Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).\n\n### #project_id\n\n def project_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.\n\n### #project_id=\n\n def project_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. \n**Returns**\n\n- (::String) --- The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.\n\n### #table_id\n\n def table_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.\n\n### #table_id=\n\n def table_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. \n**Returns**\n\n- (::String) --- Required. The Cloud SQL table to copy the data from with a length limit of 256 characters."]]
