Google Cloud AlloyDB for PostgreSQL V1 Client - Class ExportClusterRequest (1.3.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ExportClusterRequest.

Export cluster request.

Generated from protobuf message google.cloud.alloydb.v1.ExportClusterRequest

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ gcs_destination GcsDestination

Required. Option to export data to cloud storage.
↳ csv_export_options ExportClusterRequest\CsvExportOptions

Options for exporting data in CSV format. Required field to be set for CSV file type.
↳ sql_export_options ExportClusterRequest\SqlExportOptions

Options for exporting data in SQL format. Required field to be set for SQL file type.
↳ name string

Required. The resource name of the cluster.
↳ database 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.

getGcsDestination

Required. Option to export data to cloud storage.

Returns
Type Description
GcsDestination|null

hasGcsDestination

setGcsDestination

Required. Option to export data to cloud storage.

Parameter
Name Description
var GcsDestination
Returns
Type Description
$this

getCsvExportOptions

Options for exporting data in CSV format. Required field to be set for CSV file type.

Returns
Type Description
ExportClusterRequest\CsvExportOptions|null

hasCsvExportOptions

setCsvExportOptions

Options for exporting data in CSV format. Required field to be set for CSV file type.

Parameter
Name Description
var ExportClusterRequest\CsvExportOptions
Returns
Type Description
$this

getSqlExportOptions

Options for exporting data in SQL format. Required field to be set for SQL file type.

Returns
Type Description
ExportClusterRequest\SqlExportOptions|null

hasSqlExportOptions

setSqlExportOptions

Options for exporting data in SQL format. Required field to be set for SQL file type.

Parameter
Name Description
var ExportClusterRequest\SqlExportOptions
Returns
Type Description
$this

getName

Required. The resource name of the cluster.

Returns
Type Description
string

setName

Required. The resource name of the cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getDatabase

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
Type Description
string

setDatabase

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestination

Returns
Type Description
string

getExportOptions

Returns
Type Description
string

static::build

Parameters
Name Description
name string

Required. The resource name of the cluster. Please see AlloyDBAdminClient::clusterName() for help formatting this field.
gcsDestination GcsDestination

Required. Option to export data to cloud storage.
database 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.
csvExportOptions ExportClusterRequest\CsvExportOptions

Options for exporting data in CSV format. Required field to be set for CSV file type.
sqlExportOptions ExportClusterRequest\SqlExportOptions

Options for exporting data in SQL format. Required field to be set for SQL file type.
Returns
Type Description
ExportClusterRequest