Google Cloud Sql Admin V1 Client - Class SqlExportOptions (0.17.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`	`Google\Cloud\Sql\V1\ExportContext\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.

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

getSchemaOnlyValue

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`

setSchemaOnlyValue

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
`Google\Cloud\Sql\V1\ExportContext\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`	`Google\Cloud\Sql\V1\ExportContext\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

getThreadsValue

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`

setThreadsValue

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

getParallelValue

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`

setParallelValue

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`