Reference documentation and code samples for the BigQuery Data Transfer V1 Client class FieldSchema.
Defines schema of a field in the imported data.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.FieldSchema
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_name |
string
Field name. Matches: [A-Za-z_][A-Za-z_0-9]{0,127} |
↳ type |
int
Field type |
↳ is_repeated |
bool
Is field repeated. |
↳ description |
string
Description for this field. |
↳ schema |
Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema
Present iff type == RECORD. |
getFieldName
Field name. Matches: [A-Za-z_][A-Za-z_0-9]{0,127}
Generated from protobuf field string field_name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setFieldName
Field name. Matches: [A-Za-z_][A-Za-z_0-9]{0,127}
Generated from protobuf field string field_name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Field type
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.FieldSchema.Type type = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Field type
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.FieldSchema.Type type = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIsRepeated
Is field repeated.
Generated from protobuf field bool is_repeated = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setIsRepeated
Is field repeated.
Generated from protobuf field bool is_repeated = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description for this field.
Generated from protobuf field string description = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description for this field.
Generated from protobuf field string description = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchema
Present iff type == RECORD.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.RecordSchema schema = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema | |
setSchema
Present iff type == RECORD.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.RecordSchema schema = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo\RecordSchema
|
| Returns | |
|---|---|
| Type | Description |
$this | |