Package com.google.cloud.bigquery.storage.v1

Interface TableFieldSchemaOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TableFieldSchema, TableFieldSchema.Builder
    public interface TableFieldSchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getTypeValue

        int getTypeValue()
         Required. The field data type.
        .google.cloud.bigquery.storage.v1.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The enum numeric value on the wire for type.

      • getType

        TableFieldSchema.Type getType()
         Required. The field data type.
        .google.cloud.bigquery.storage.v1.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The type.

      • getModeValue

        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:
        The enum numeric value on the wire for mode.

      • getMode

        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:
        The mode.

      • getFieldsList

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

      • getFields

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

      • getFieldsCount

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

      • getFieldsOrBuilderList

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

      • getFieldsOrBuilder

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

      • getDescription

        String getDescription()
         Optional. The field description. The maximum length is 1,024 characters.
        string description = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Optional. The field description. The maximum length is 1,024 characters.
        string description = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for description.

      • getMaxLength

        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:
        The maxLength.

      • getPrecision

        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:
        The precision.

      • getScale

        long getScale()
         Optional. See documentation for precision.
        int64 scale = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The scale.

      • getDefaultValueExpression

        String getDefaultValueExpression()
         Optional. A SQL expression to specify the [default value]
 (https://cloud.google.com/bigquery/docs/default-values) for this field.
        string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The defaultValueExpression.

      • getDefaultValueExpressionBytes

        com.google.protobuf.ByteString getDefaultValueExpressionBytes()
         Optional. A SQL expression to specify the [default value]
 (https://cloud.google.com/bigquery/docs/default-values) for this field.
        string default_value_expression = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for defaultValueExpression.