Note: The following fields are mutually exclusive: csv_import_options, sql_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: csv_import_options, sql_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: csv_import_options, sql_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
#database
defdatabase()->::String
Returns
(::String) — Optional. Name of the database to which the import will be done.
For import from SQL file, this is required only if the file does not
specify a database.
Note - Value provided should be the same as expected from SELECT
current_database(); and NOT as a resource reference.
#database=
defdatabase=(value)->::String
Parameter
value (::String) — Optional. Name of the database to which the import will be done.
For import from SQL file, this is required only if the file does not
specify a database.
Note - Value provided should be the same as expected from SELECT
current_database(); and NOT as a resource reference.
Returns
(::String) — Optional. Name of the database to which the import will be done.
For import from SQL file, this is required only if the file does not
specify a database.
Note - Value provided should be the same as expected from SELECT
current_database(); and NOT as a resource reference.
#gcs_uri
defgcs_uri()->::String
Returns
(::String) — Required. The path to the file in Google Cloud Storage where the source
file for import will be stored. The URI is in the form
gs://bucketName/fileName.
#gcs_uri=
defgcs_uri=(value)->::String
Parameter
value (::String) — Required. The path to the file in Google Cloud Storage where the source
file for import will be stored. The URI is in the form
gs://bucketName/fileName.
Returns
(::String) — Required. The path to the file in Google Cloud Storage where the source
file for import will be stored. The URI is in the form
gs://bucketName/fileName.
#name
defname()->::String
Returns
(::String) — Required. The resource name of the cluster.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. The resource name of the cluster.
Returns
(::String) — Required. The resource name of the cluster.
Note: The following fields are mutually exclusive: sql_import_options, csv_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: sql_import_options, csv_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: sql_import_options, csv_import_options. If a field in that set is populated, all other fields in the set will automatically be cleared.
#user
defuser()->::String
Returns
(::String) — Optional. Database user to be used for importing the data.
Note - Value provided should be the same as expected from
SELECT current_user; and NOT as a resource reference.
#user=
defuser=(value)->::String
Parameter
value (::String) — Optional. Database user to be used for importing the data.
Note - Value provided should be the same as expected from
SELECT current_user; and NOT as a resource reference.
Returns
(::String) — Optional. Database user to be used for importing the data.
Note - Value provided should be the same as expected from
SELECT current_user; and NOT as a resource reference.
[[["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,["# AlloyDB V1ALPHA API - Class Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest (v0.14.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/latest/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.14.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.13.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.12.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.11.1](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.11.1/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.10.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.9.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.8.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.7.2/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.6.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.5.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.5.2/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.4.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.3.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.2.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.1.0/Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest) \nReference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest.\n\nImport cluster request. \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### #csv_import_options\n\n def csv_import_options() -\u003e ::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions\n\n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-CsvImportOptions)) --- Options for importing data in CSV format.\n\n\n Note: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #csv_import_options=\n\n def csv_import_options=(value) -\u003e ::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-CsvImportOptions)) --- Options for importing data in CSV format.\n\n\nNote: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-CsvImportOptions)) --- Options for importing data in CSV format.\n\n\n Note: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #database\n\n def database() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT\n current_database();` and NOT as a resource reference.\n\n### #database=\n\n def database=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT\ncurrent_database();` and NOT as a resource reference. \n**Returns**\n\n- (::String) --- Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT\n current_database();` and NOT as a resource reference.\n\n### #gcs_uri\n\n def gcs_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.\n\n### #gcs_uri=\n\n def gcs_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`. \n**Returns**\n\n- (::String) --- Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The resource name of the cluster.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The resource name of the cluster. \n**Returns**\n\n- (::String) --- Required. The resource name of the cluster.\n\n### #sql_import_options\n\n def sql_import_options() -\u003e ::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions\n\n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-SqlImportOptions)) --- Options for importing data in SQL format.\n\n\n Note: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #sql_import_options=\n\n def sql_import_options=(value) -\u003e ::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-SqlImportOptions)) --- Options for importing data in SQL format.\n\n\nNote: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions](./Google-Cloud-AlloyDB-V1alpha-ImportClusterRequest-SqlImportOptions)) --- Options for importing data in SQL format.\n\n\n Note: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #user\n\n def user() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference.\n\n### #user=\n\n def user=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference. \n**Returns**\n\n- (::String) --- Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference."]]