AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::ExportClusterRequest (v1.3.0)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::ExportClusterRequest.

Export cluster request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#csv_export_options

def csv_export_options() -> ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions
Returns
  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions) — Options for exporting data in CSV format. Required field to be set for CSV file type.

    Note: The following fields are mutually exclusive: csv_export_options, sql_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#csv_export_options=

def csv_export_options=(value) -> ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions
Parameter
  • value (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions) — Options for exporting data in CSV format. Required field to be set for CSV file type.

    Note: The following fields are mutually exclusive: csv_export_options, sql_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions) — Options for exporting data in CSV format. Required field to be set for CSV file type.

    Note: The following fields are mutually exclusive: csv_export_options, sql_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database

def database() -> ::String
Returns
  • (::String) — Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

#database=

def database=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.
Returns
  • (::String) — Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

#gcs_destination

def gcs_destination() -> ::Google::Cloud::AlloyDB::V1::GcsDestination
Returns

#gcs_destination=

def gcs_destination=(value) -> ::Google::Cloud::AlloyDB::V1::GcsDestination
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Required. The resource name of the cluster.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the cluster.
Returns
  • (::String) — Required. The resource name of the cluster.

#sql_export_options

def sql_export_options() -> ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions
Returns
  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions) — Options for exporting data in SQL format. Required field to be set for SQL file type.

    Note: The following fields are mutually exclusive: sql_export_options, csv_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sql_export_options=

def sql_export_options=(value) -> ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions
Parameter
  • value (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions) — Options for exporting data in SQL format. Required field to be set for SQL file type.

    Note: The following fields are mutually exclusive: sql_export_options, csv_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions) — Options for exporting data in SQL format. Required field to be set for SQL file type.

    Note: The following fields are mutually exclusive: sql_export_options, csv_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.