Class TableFieldSchema (2.28.3)

Version 2.28.3

• 3.10.3 (latest)
• 3.10.2
• 3.9.3
• 3.8.0
• 3.6.1
• 3.5.2
• 3.4.0
• 3.3.1
• 3.2.0
• 3.1.0
• 3.0.1
• 2.47.0
• 2.45.0
• 2.44.1
• 2.43.0

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TableFieldSchema

Implements

TableFieldSchemaOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

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

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()

Returns

Type	Description
TableFieldSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static TableFieldSchema.Builder newBuilder()

Returns

Type	Description
TableFieldSchema.Builder

newBuilder(TableFieldSchema prototype)

public static TableFieldSchema.Builder newBuilder(TableFieldSchema prototype)

Parameter

Name	Description
prototype	TableFieldSchema

Returns

Type	Description
TableFieldSchema.Builder

parseDelimitedFrom(InputStream input)

public static TableFieldSchema parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static TableFieldSchema parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TableFieldSchema parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TableFieldSchema parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static TableFieldSchema parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static TableFieldSchema parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TableFieldSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TableFieldSchema

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TableFieldSchema> parser()

Returns

Type	Description
Parser<TableFieldSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TableFieldSchema getDefaultInstanceForType()

Returns

Type	Description
TableFieldSchema

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

Returns

Type	Description
TableFieldSchema

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];

Returns

Type	Description
List<TableFieldSchema>

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

Returns

Type	Description
TableFieldSchemaOrBuilder

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];

Returns

Type	Description
TableFieldSchema.Mode	The mode.

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()

public String 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()

Returns

Type	Description
Parser<TableFieldSchema>

Overrides

GeneratedMessageV3.getParserForType()

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.

getScale()

public long 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

GeneratedMessageV3.getSerializedSize()

getType()

public TableFieldSchema.Type getType()

Required. The field data type.

.google.cloud.bigquery.storage.v1.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TableFieldSchema.Type	The type.

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TableFieldSchema.Builder newBuilderForType()

Returns

Type	Description
TableFieldSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TableFieldSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
TableFieldSchema.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TableFieldSchema.Builder toBuilder()

Returns

Type	Description
TableFieldSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException