Google Cloud Sql Admin V1 Client - Class SqlExportOptions (1.2.1)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlExportOptions.

Generated from protobuf message google.cloud.sql.v1.ExportContext.SqlExportOptions

Namespace

Google \ Cloud \ Sql \ V1 \ ExportContext

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ tables`	`array` Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
`↳ schema_only`	`Google\Protobuf\BoolValue` Export only schemas.
`↳ mysql_export_options`	`SqlExportOptions\MysqlExportOptions`
`↳ threads`	`Google\Protobuf\Int32Value` Optional. The number of threads to use for parallel export.
`↳ parallel`	`Google\Protobuf\BoolValue` Optional. Whether or not the export should be parallel.
`↳ postgres_export_options`	`SqlExportOptions\PostgresExportOptions` Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.

getTables

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTables

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSchemaOnly

Export only schemas.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasSchemaOnly

clearSchemaOnly

getSchemaOnlyUnwrapped

Returns the unboxed value from getSchemaOnly()

Export only schemas.

Returns
Type	Description
`bool\|null`

setSchemaOnly

Export only schemas.

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setSchemaOnlyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Export only schemas.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getMysqlExportOptions

Generated from protobuf field .google.cloud.sql.v1.ExportContext.SqlExportOptions.MysqlExportOptions mysql_export_options = 3;

Returns
Type	Description
`SqlExportOptions\MysqlExportOptions\|null`

hasMysqlExportOptions

clearMysqlExportOptions

setMysqlExportOptions

Generated from protobuf field .google.cloud.sql.v1.ExportContext.SqlExportOptions.MysqlExportOptions mysql_export_options = 3;

Parameter
Name	Description
`var`	`SqlExportOptions\MysqlExportOptions`

Returns
Type	Description
`$this`

getThreads

Optional. The number of threads to use for parallel export.

Returns
Type	Description
`Google\Protobuf\Int32Value\|null`

hasThreads

clearThreads

getThreadsUnwrapped

Returns the unboxed value from getThreads()

Optional. The number of threads to use for parallel export.

Returns
Type	Description
`int\|null`

setThreads

Optional. The number of threads to use for parallel export.

Parameter
Name	Description
`var`	`Google\Protobuf\Int32Value`

Returns
Type	Description
`$this`

setThreadsUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Optional. The number of threads to use for parallel export.

Parameter
Name	Description
`var`	`int\|null`

Returns
Type	Description
`$this`

getParallel

Optional. Whether or not the export should be parallel.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasParallel

clearParallel

getParallelUnwrapped

Returns the unboxed value from getParallel()

Optional. Whether or not the export should be parallel.

Returns
Type	Description
`bool\|null`

setParallel

Optional. Whether or not the export should be parallel.

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setParallelUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Optional. Whether or not the export should be parallel.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getPostgresExportOptions

Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.

Returns
Type	Description
`SqlExportOptions\PostgresExportOptions\|null`

hasPostgresExportOptions

clearPostgresExportOptions

setPostgresExportOptions

Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.

Parameter
Name	Description
`var`	`SqlExportOptions\PostgresExportOptions`

Returns
Type	Description
`$this`