Reference documentation and code samples for the BigQuery Data Transfer V1 Client class CsvOptions.
CSV specific options.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition.CsvOptions
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_delimiter |
Google\Protobuf\StringValue
The delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation. |
↳ allow_quoted_newlines |
Google\Protobuf\BoolValue
Whether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files. |
↳ quote_char |
Google\Protobuf\StringValue
The quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used. |
↳ skip_leading_rows |
Google\Protobuf\Int64Value
Number of leading rows to skip. |
↳ allow_jagged_rows |
Google\Protobuf\BoolValue
Accept rows that are missing trailing optional columns. |
getFieldDelimiter
The delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
Generated from protobuf field .google.protobuf.StringValue field_delimiter = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue | |
getFieldDelimiterValue
Returns the unboxed value from getFieldDelimiter()
The delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
Generated from protobuf field .google.protobuf.StringValue field_delimiter = 1;
| Returns | |
|---|---|
| Type | Description |
string|null | |
setFieldDelimiter
The delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
Generated from protobuf field .google.protobuf.StringValue field_delimiter = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setFieldDelimiterValue
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
The delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
Generated from protobuf field .google.protobuf.StringValue field_delimiter = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowQuotedNewlines
Whether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
Generated from protobuf field .google.protobuf.BoolValue allow_quoted_newlines = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue | |
getAllowQuotedNewlinesValue
Returns the unboxed value from getAllowQuotedNewlines()
Whether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
Generated from protobuf field .google.protobuf.BoolValue allow_quoted_newlines = 2;
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setAllowQuotedNewlines
Whether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
Generated from protobuf field .google.protobuf.BoolValue allow_quoted_newlines = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setAllowQuotedNewlinesValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
Generated from protobuf field .google.protobuf.BoolValue allow_quoted_newlines = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuoteChar
The quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
Generated from protobuf field .google.protobuf.StringValue quote_char = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue | |
getQuoteCharValue
Returns the unboxed value from getQuoteChar()
The quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
Generated from protobuf field .google.protobuf.StringValue quote_char = 3;
| Returns | |
|---|---|
| Type | Description |
string|null | |
setQuoteChar
The quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
Generated from protobuf field .google.protobuf.StringValue quote_char = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setQuoteCharValue
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
The quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
Generated from protobuf field .google.protobuf.StringValue quote_char = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSkipLeadingRows
Number of leading rows to skip.
Generated from protobuf field .google.protobuf.Int64Value skip_leading_rows = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value | |
getSkipLeadingRowsValue
Returns the unboxed value from getSkipLeadingRows()
Number of leading rows to skip.
Generated from protobuf field .google.protobuf.Int64Value skip_leading_rows = 4;
| Returns | |
|---|---|
| Type | Description |
int|string|null | |
setSkipLeadingRows
Number of leading rows to skip.
Generated from protobuf field .google.protobuf.Int64Value skip_leading_rows = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int64Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setSkipLeadingRowsValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Number of leading rows to skip.
Generated from protobuf field .google.protobuf.Int64Value skip_leading_rows = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowJaggedRows
Accept rows that are missing trailing optional columns.
Generated from protobuf field .google.protobuf.BoolValue allow_jagged_rows = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue | |
getAllowJaggedRowsValue
Returns the unboxed value from getAllowJaggedRows()
Accept rows that are missing trailing optional columns.
Generated from protobuf field .google.protobuf.BoolValue allow_jagged_rows = 5;
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setAllowJaggedRows
Accept rows that are missing trailing optional columns.
Generated from protobuf field .google.protobuf.BoolValue allow_jagged_rows = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setAllowJaggedRowsValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Accept rows that are missing trailing optional columns.
Generated from protobuf field .google.protobuf.BoolValue allow_jagged_rows = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |