Constructor
new TableFieldSchema(propertiesopt)
Constructs a new TableFieldSchema.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.storage.v1.ITableFieldSchema |
<optional> |
Properties to set |
- Implements:
-
- ITableFieldSchema
Members
Mode
Mode enum.
Properties:
| Name | Type | Description |
|---|---|---|
MODE_UNSPECIFIED |
number |
MODE_UNSPECIFIED value |
NULLABLE |
number |
NULLABLE value |
REQUIRED |
number |
REQUIRED value |
REPEATED |
number |
REPEATED value |
Type
Type enum.
Properties:
| Name | Type | Description |
|---|---|---|
TYPE_UNSPECIFIED |
number |
TYPE_UNSPECIFIED value |
STRING |
number |
STRING value |
INT64 |
number |
INT64 value |
DOUBLE |
number |
DOUBLE value |
STRUCT |
number |
STRUCT value |
BYTES |
number |
BYTES value |
BOOL |
number |
BOOL value |
TIMESTAMP |
number |
TIMESTAMP value |
DATE |
number |
DATE value |
TIME |
number |
TIME value |
DATETIME |
number |
DATETIME value |
GEOGRAPHY |
number |
GEOGRAPHY value |
NUMERIC |
number |
NUMERIC value |
BIGNUMERIC |
number |
BIGNUMERIC value |
INTERVAL |
number |
INTERVAL value |
JSON |
number |
JSON value |
description
TableFieldSchema description.
fields
TableFieldSchema fields.
maxLength
TableFieldSchema maxLength.
mode
TableFieldSchema mode.
name
TableFieldSchema name.
precision
TableFieldSchema precision.
scale
TableFieldSchema scale.
type
TableFieldSchema type.
Methods
(static) create(propertiesopt) → {google.cloud.bigquery.storage.v1.TableFieldSchema}
Creates a new TableFieldSchema instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.storage.v1.ITableFieldSchema |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.storage.v1.TableFieldSchema |
TableFieldSchema instance |
(static) decode(reader, lengthopt) → {google.cloud.bigquery.storage.v1.TableFieldSchema}
Decodes a TableFieldSchema message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.storage.v1.TableFieldSchema |
TableFieldSchema |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.bigquery.storage.v1.TableFieldSchema}
Decodes a TableFieldSchema message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.storage.v1.TableFieldSchema |
TableFieldSchema |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified TableFieldSchema message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.storage.v1.ITableFieldSchema |
TableFieldSchema message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified TableFieldSchema message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.storage.v1.ITableFieldSchema |
TableFieldSchema message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.bigquery.storage.v1.TableFieldSchema}
Creates a TableFieldSchema message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.storage.v1.TableFieldSchema |
TableFieldSchema |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a TableFieldSchema message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.storage.v1.TableFieldSchema |
TableFieldSchema |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a TableFieldSchema message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|
toJSON() → {Object.<string, *>}
Converts this TableFieldSchema to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |