public final class TableFieldSchema extends GeneratedMessageV3 implements TableFieldSchemaOrBuilder
TableFieldSchema defines a single field/column within a table schema.
Protobuf type google.cloud.bigquery.storage.v1.TableFieldSchema
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DEFAULT_VALUE_EXPRESSION_FIELD_NUMBER
public static final int DEFAULT_VALUE_EXPRESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_LENGTH_FIELD_NUMBER
public static final int MAX_LENGTH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRECISION_FIELD_NUMBER
public static final int PRECISION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RANGE_ELEMENT_TYPE_FIELD_NUMBER
public static final int RANGE_ELEMENT_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCALE_FIELD_NUMBER
public static final int SCALE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TableFieldSchema getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TableFieldSchema.Builder newBuilder()
newBuilder(TableFieldSchema prototype)
public static TableFieldSchema.Builder newBuilder(TableFieldSchema prototype)
public static TableFieldSchema parseDelimitedFrom(InputStream input)
public static TableFieldSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TableFieldSchema parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TableFieldSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TableFieldSchema parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TableFieldSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TableFieldSchema parseFrom(CodedInputStream input)
public static TableFieldSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TableFieldSchema parseFrom(InputStream input)
public static TableFieldSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TableFieldSchema parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TableFieldSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TableFieldSchema> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public TableFieldSchema getDefaultInstanceForType()
getDefaultValueExpression()
public String getDefaultValueExpression()
Optional. A SQL expression to specify the default value for this field.
string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The defaultValueExpression.
|
getDefaultValueExpressionBytes()
public ByteString getDefaultValueExpressionBytes()
Optional. A SQL expression to specify the default value for this field.
string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for defaultValueExpression.
|
getDescription()
public String getDescription()
Optional. The field description. The maximum length is 1,024 characters.
string description = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The field description. The maximum length is 1,024 characters.
string description = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getFields(int index)
public TableFieldSchema getFields(int index)
Optional. Describes the nested schema fields if the type property is set to
STRUCT.
repeated .google.cloud.bigquery.storage.v1.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getFieldsCount()
public int getFieldsCount()
Optional. Describes the nested schema fields if the type property is set to
STRUCT.
repeated .google.cloud.bigquery.storage.v1.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getFieldsList()
public List<TableFieldSchema> getFieldsList()
Optional. Describes the nested schema fields if the type property is set to
STRUCT.
repeated .google.cloud.bigquery.storage.v1.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];
getFieldsOrBuilder(int index)
public TableFieldSchemaOrBuilder getFieldsOrBuilder(int index)
Optional. Describes the nested schema fields if the type property is set to
STRUCT.
repeated .google.cloud.bigquery.storage.v1.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getFieldsOrBuilderList()
public List<? extends TableFieldSchemaOrBuilder> getFieldsOrBuilderList()
Optional. Describes the nested schema fields if the type property is set to
STRUCT.
repeated .google.cloud.bigquery.storage.v1.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.bigquery.storage.v1.TableFieldSchemaOrBuilder> |
|
getMaxLength()
public long getMaxLength()
Optional. Maximum length of values of this field for STRINGS or BYTES.
If max_length is not specified, no maximum length constraint is imposed
on this field.
If type = "STRING", then max_length represents the maximum UTF-8
length of strings in this field.
If type = "BYTES", then max_length represents the maximum number of
bytes in this field.
It is invalid to set this field if type is not "STRING" or "BYTES".
int64 max_length = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The maxLength.
|
getMode()
public TableFieldSchema.Mode getMode()
Optional. The field mode. The default value is NULLABLE.
.google.cloud.bigquery.storage.v1.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];
getModeValue()
public int getModeValue()
Optional. The field mode. The default value is NULLABLE.
.google.cloud.bigquery.storage.v1.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for mode.
|
getName()
Required. The field name. The name must contain only letters (a-z, A-Z),
numbers (0-9), or underscores (_), and must start with a letter or
underscore. The maximum length is 128 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The field name. The name must contain only letters (a-z, A-Z),
numbers (0-9), or underscores (_), and must start with a letter or
underscore. The maximum length is 128 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<TableFieldSchema> getParserForType()
Overrides
getPrecision()
public long getPrecision()
Optional. Precision (maximum number of total digits in base 10) and scale
(maximum number of digits in the fractional part in base 10) constraints
for values of this field for NUMERIC or BIGNUMERIC.
It is invalid to set precision or scale if type is not "NUMERIC" or
"BIGNUMERIC".
If precision and scale are not specified, no value range constraint is
imposed on this field insofar as values are permitted by the type.
Values of this NUMERIC or BIGNUMERIC field must be in this range when:
- Precision (P) and scale (S) are specified:
[-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
Precision (P) is specified but not scale (and thus scale is
interpreted to be equal to zero):
[-10^P + 1, 10^P - 1].
Acceptable values for precision and scale if both are specified:
If type = "NUMERIC":
1 <= precision - scale <= 29 and 0 <= scale <= 9.
If type = "BIGNUMERIC":
1 <= precision - scale <= 38 and 0 <= scale <= 38.
Acceptable values for precision if only precision is specified but not
scale (and thus scale is interpreted to be equal to zero):
If type = "NUMERIC": 1 <= precision <= 29.
If type = "BIGNUMERIC": 1 <= precision <= 38.
If scale is specified but not precision, then it is invalid.
int64 precision = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The precision.
|
getRangeElementType()
public TableFieldSchema.FieldElementType getRangeElementType()
Optional. The subtype of the RANGE, if the type of this field is RANGE. If
the type is RANGE, this field is required. Possible values for the field
element type of a RANGE include:
.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];
getRangeElementTypeOrBuilder()
public TableFieldSchema.FieldElementTypeOrBuilder getRangeElementTypeOrBuilder()
Optional. The subtype of the RANGE, if the type of this field is RANGE. If
the type is RANGE, this field is required. Possible values for the field
element type of a RANGE include:
.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];
getScale()
Optional. See documentation for precision.
int64 scale = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The scale.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getType()
public TableFieldSchema.Type getType()
Required. The field data type.
.google.cloud.bigquery.storage.v1.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];
getTypeValue()
public int getTypeValue()
Required. The field data type.
.google.cloud.bigquery.storage.v1.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
hasRangeElementType()
public boolean hasRangeElementType()
Optional. The subtype of the RANGE, if the type of this field is RANGE. If
the type is RANGE, this field is required. Possible values for the field
element type of a RANGE include:
.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the rangeElementType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TableFieldSchema.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TableFieldSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TableFieldSchema.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
