Interface TableFieldSchemaOrBuilder (3.9.0) 

public interface TableFieldSchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultValueExpression()

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

getRangeElementTypeOrBuilder()

public abstract 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 abstract long getScale()

Optional. See documentation for precision.

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

Returns
Type Description
long

The scale.

getType()

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