BigQuery Data Transfer V1 Client - Class TableDefinition (1.8.6)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class TableDefinition.

External table definition. These tables can be referenced with 'name' in the query and can be read just like any other table.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1 \ ImportedDataInfo

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ table_id`	`string` BigQuery table_id (required). This will be used to reference this table in the query.
`↳ source_uris`	`string[]` URIs for the data to be imported. All URIs must be from the same storage system.
`↳ format`	`int` Describes the format of the data in source_uri.
`↳ max_bad_records`	`int` Specify the maximum number of bad records that can be ignored. If bad records exceed this threshold the query is aborted.
`↳ encoding`	`int` Character encoding of the input when applicable (CSV, JSON). Defaults to UTF8.
`↳ csv_options`	`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\TableDefinition\CsvOptions` CSV specific options.
`↳ schema`	`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema` Optional schema for the data. When not specified for JSON and CSV formats we will try to detect it automatically.
`↳ ignore_unknown_values`	`Google\Protobuf\BoolValue` Indicates if extra values that are not represented in the table schema is allowed.

getTableId

BigQuery table_id (required). This will be used to reference this table in the query.

Returns
Type	Description
`string`

setTableId

BigQuery table_id (required). This will be used to reference this table in the query.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceUris

URIs for the data to be imported. All URIs must be from the same storage system.

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

setSourceUris

URIs for the data to be imported. All URIs must be from the same storage system.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getFormat

Describes the format of the data in source_uri.

Returns
Type	Description
`int`

setFormat

Describes the format of the data in source_uri.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMaxBadRecords

Specify the maximum number of bad records that can be ignored.

If bad records exceed this threshold the query is aborted.

Returns
Type	Description
`int`

setMaxBadRecords

Specify the maximum number of bad records that can be ignored.

If bad records exceed this threshold the query is aborted.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEncoding

Character encoding of the input when applicable (CSV, JSON).

Defaults to UTF8.

Returns
Type	Description
`int`

setEncoding

Character encoding of the input when applicable (CSV, JSON).

Defaults to UTF8.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCsvOptions

CSV specific options.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\TableDefinition\CsvOptions`

setCsvOptions

CSV specific options.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\TableDefinition\CsvOptions`

Returns
Type	Description
`$this`

getSchema

Optional schema for the data. When not specified for JSON and CSV formats we will try to detect it automatically.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema`

setSchema

Optional schema for the data. When not specified for JSON and CSV formats we will try to detect it automatically.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema`

Returns
Type	Description
`$this`

getIgnoreUnknownValues

Indicates if extra values that are not represented in the table schema is allowed.

Returns
Type	Description
`Google\Protobuf\BoolValue`

getIgnoreUnknownValuesValue

Returns the unboxed value from getIgnoreUnknownValues()

Indicates if extra values that are not represented in the table schema is allowed.

Returns
Type	Description
`bool\|null`

setIgnoreUnknownValues

Indicates if extra values that are not represented in the table schema is allowed.

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

Returns
Type	Description
`$this`

setIgnoreUnknownValuesValue

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

Indicates if extra values that are not represented in the table schema is allowed.

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

Returns
Type	Description
`$this`