BigQuery Data Transfer V1 Client - Class TableDefinition (1.5.2)

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
NameDescription
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
TypeDescription
string

setTableId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceUris

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSourceUris

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getFormat

Describes the format of the data in source_uri.

Returns
TypeDescription
int

setFormat

Describes the format of the data in source_uri.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMaxBadRecords

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

If bad records exceed this threshold the query is aborted.

Returns
TypeDescription
int

setMaxBadRecords

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

If bad records exceed this threshold the query is aborted.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEncoding

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

Defaults to UTF8.

Returns
TypeDescription
int

setEncoding

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

Defaults to UTF8.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCsvOptions

CSV specific options.

Returns
TypeDescription
Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\TableDefinition\CsvOptions

setCsvOptions

CSV specific options.

Parameter
NameDescription
var Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\TableDefinition\CsvOptions
Returns
TypeDescription
$this

getSchema

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema
Returns
TypeDescription
$this

getIgnoreUnknownValues

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

Returns
TypeDescription
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
TypeDescription
bool|null

setIgnoreUnknownValues

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

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$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
NameDescription
var bool|null
Returns
TypeDescription
$this