Class TableFieldSchema.Builder (3.6.1)

public static final class TableFieldSchema.Builder extends GeneratedMessageV3.Builder<TableFieldSchema.Builder> implements TableFieldSchemaOrBuilder

TableFieldSchema defines a single field/column within a table schema.

Protobuf type google.cloud.bigquery.storage.v1.TableFieldSchema

Inheritance

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

Implements

TableFieldSchemaOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllFields(Iterable<? extends TableFieldSchema> values)

public TableFieldSchema.Builder addAllFields(Iterable<? extends TableFieldSchema> values)

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
`values`	`Iterable<? extends com.google.cloud.bigquery.storage.v1.TableFieldSchema>`

Returns
Type	Description
`TableFieldSchema.Builder`

addFields(TableFieldSchema value)

public TableFieldSchema.Builder addFields(TableFieldSchema value)

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
`value`	`TableFieldSchema`

Returns
Type	Description
`TableFieldSchema.Builder`

addFields(TableFieldSchema.Builder builderForValue)

public TableFieldSchema.Builder addFields(TableFieldSchema.Builder builderForValue)

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
`builderForValue`	`TableFieldSchema.Builder`

Returns
Type	Description
`TableFieldSchema.Builder`

addFields(int index, TableFieldSchema value)

public TableFieldSchema.Builder addFields(int index, TableFieldSchema value)

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

Parameters
Name	Description
`index`	`int`
`value`	`TableFieldSchema`

Returns
Type	Description
`TableFieldSchema.Builder`

addFields(int index, TableFieldSchema.Builder builderForValue)

public TableFieldSchema.Builder addFields(int index, TableFieldSchema.Builder builderForValue)

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`TableFieldSchema.Builder`

Returns
Type	Description
`TableFieldSchema.Builder`

addFieldsBuilder()

public TableFieldSchema.Builder addFieldsBuilder()

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
`TableFieldSchema.Builder`

addFieldsBuilder(int index)

public TableFieldSchema.Builder addFieldsBuilder(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.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TableFieldSchema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TableFieldSchema build()

Returns
Type	Description
`TableFieldSchema`

buildPartial()

public TableFieldSchema buildPartial()

Returns
Type	Description
`TableFieldSchema`

clear()

public TableFieldSchema.Builder clear()

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDefaultValueExpression()

public TableFieldSchema.Builder clearDefaultValueExpression()

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
`TableFieldSchema.Builder`	This builder for chaining.

clearDescription()

public TableFieldSchema.Builder clearDescription()

Optional. The field description. The maximum length is 1,024 characters.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TableFieldSchema.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFields()

public TableFieldSchema.Builder clearFields()

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
`TableFieldSchema.Builder`

clearMaxLength()

public TableFieldSchema.Builder clearMaxLength()

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
`TableFieldSchema.Builder`	This builder for chaining.

clearMode()

public TableFieldSchema.Builder clearMode()

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.Builder`	This builder for chaining.

clearName()

public TableFieldSchema.Builder clearName()

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
`TableFieldSchema.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TableFieldSchema.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPrecision()

public TableFieldSchema.Builder clearPrecision()

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
`TableFieldSchema.Builder`	This builder for chaining.

clearRangeElementType()

public TableFieldSchema.Builder clearRangeElementType()

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.Builder`

clearScale()

public TableFieldSchema.Builder clearScale()

Optional. See documentation for precision.

int64 scale = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

clearType()

public TableFieldSchema.Builder clearType()

Required. The field data type.

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

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

clone()

public TableFieldSchema.Builder clone()

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TableFieldSchema getDefaultInstanceForType()

Returns
Type	Description
`TableFieldSchema`

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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`

getFieldsBuilder(int index)

public TableFieldSchema.Builder getFieldsBuilder(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.Builder`

getFieldsBuilderList()

public List<TableFieldSchema.Builder> getFieldsBuilderList()

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<Builder>`

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.

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.FieldElementType`	The rangeElementType.

getRangeElementTypeBuilder()

public TableFieldSchema.FieldElementType.Builder getRangeElementTypeBuilder()

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.FieldElementType.Builder`

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TableFieldSchema.FieldElementTypeOrBuilder`

getScale()

public long getScale()

Optional. See documentation for precision.

int64 scale = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The scale.

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.

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:

DATE
DATETIME
TIMESTAMP

.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TableFieldSchema other)

public TableFieldSchema.Builder mergeFrom(TableFieldSchema other)

Parameter
Name	Description
`other`	`TableFieldSchema`

Returns
Type	Description
`TableFieldSchema.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TableFieldSchema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public TableFieldSchema.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRangeElementType(TableFieldSchema.FieldElementType value)

public TableFieldSchema.Builder mergeRangeElementType(TableFieldSchema.FieldElementType value)

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`TableFieldSchema.FieldElementType`

Returns
Type	Description
`TableFieldSchema.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TableFieldSchema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFields(int index)

public TableFieldSchema.Builder removeFields(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.Builder`

setDefaultValueExpression(String value)

public TableFieldSchema.Builder setDefaultValueExpression(String value)

Optional. A SQL expression to specify the default value for this field.

string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The defaultValueExpression to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setDefaultValueExpressionBytes(ByteString value)

public TableFieldSchema.Builder setDefaultValueExpressionBytes(ByteString value)

Optional. A SQL expression to specify the default value for this field.

string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for defaultValueExpression to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setDescription(String value)

public TableFieldSchema.Builder setDescription(String value)

Optional. The field description. The maximum length is 1,024 characters.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public TableFieldSchema.Builder setDescriptionBytes(ByteString value)

Optional. The field description. The maximum length is 1,024 characters.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TableFieldSchema.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFields(int index, TableFieldSchema value)

public TableFieldSchema.Builder setFields(int index, TableFieldSchema value)

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

Parameters
Name	Description
`index`	`int`
`value`	`TableFieldSchema`

Returns
Type	Description
`TableFieldSchema.Builder`

setFields(int index, TableFieldSchema.Builder builderForValue)

public TableFieldSchema.Builder setFields(int index, TableFieldSchema.Builder builderForValue)

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`TableFieldSchema.Builder`

Returns
Type	Description
`TableFieldSchema.Builder`

setMaxLength(long value)

public TableFieldSchema.Builder setMaxLength(long value)

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

Parameter
Name	Description
`value`	`long` The maxLength to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setMode(TableFieldSchema.Mode value)

public TableFieldSchema.Builder setMode(TableFieldSchema.Mode value)

Optional. The field mode. The default value is NULLABLE.

.google.cloud.bigquery.storage.v1.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`TableFieldSchema.Mode` The mode to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setModeValue(int value)

public TableFieldSchema.Builder setModeValue(int value)

Optional. The field mode. The default value is NULLABLE.

.google.cloud.bigquery.storage.v1.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for mode to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setName(String value)

public TableFieldSchema.Builder setName(String value)

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public TableFieldSchema.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setPrecision(long value)

public TableFieldSchema.Builder setPrecision(long value)

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

Parameter
Name	Description
`value`	`long` The precision to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setRangeElementType(TableFieldSchema.FieldElementType value)

public TableFieldSchema.Builder setRangeElementType(TableFieldSchema.FieldElementType value)

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`TableFieldSchema.FieldElementType`

Returns
Type	Description
`TableFieldSchema.Builder`

setRangeElementType(TableFieldSchema.FieldElementType.Builder builderForValue)

public TableFieldSchema.Builder setRangeElementType(TableFieldSchema.FieldElementType.Builder builderForValue)

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:

DATE
DATETIME
TIMESTAMP

.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType range_element_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`TableFieldSchema.FieldElementType.Builder`

Returns
Type	Description
`TableFieldSchema.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TableFieldSchema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScale(long value)

public TableFieldSchema.Builder setScale(long value)

Optional. See documentation for precision.

int64 scale = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The scale to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setType(TableFieldSchema.Type value)

public TableFieldSchema.Builder setType(TableFieldSchema.Type value)

Required. The field data type.

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

Parameter
Name	Description
`value`	`TableFieldSchema.Type` The type to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setTypeValue(int value)

public TableFieldSchema.Builder setTypeValue(int value)

Required. The field data type.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for type to set.

Returns
Type	Description
`TableFieldSchema.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TableFieldSchema.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`TableFieldSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)