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

Class TableFieldSchema

  • All Implemented Interfaces:
    TableFieldSchemaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TableFieldSchema
extends com.google.protobuf.GeneratedMessageV3
implements TableFieldSchemaOrBuilder
     TableFieldSchema defines a single field/column within a table schema.
    Protobuf type google.cloud.bigquery.storage.v1.TableFieldSchema
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface TableFieldSchemaOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface TableFieldSchemaOrBuilder
        Returns:
        The bytes for name.

      • getTypeValue

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

      • getType

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

      • 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];
        Specified by:
        getModeValue in interface TableFieldSchemaOrBuilder
        Returns:
        The enum numeric value on the wire for mode.

      • 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];
        Specified by:
        getMode in interface TableFieldSchemaOrBuilder
        Returns:
        The mode.

      • 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];
        Specified by:
        getFieldsList in interface TableFieldSchemaOrBuilder

      • 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];
        Specified by:
        getFieldsCount in interface TableFieldSchemaOrBuilder

      • getFields

        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];
        Specified by:
        getFields in interface TableFieldSchemaOrBuilder

      • getFieldsOrBuilder

        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];
        Specified by:
        getFieldsOrBuilder in interface TableFieldSchemaOrBuilder

      • getDescription

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

      • getDescriptionBytes

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

      • 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];
        Specified by:
        getMaxLength in interface TableFieldSchemaOrBuilder
        Returns:
        The maxLength.

      • 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];
        Specified by:
        getPrecision in interface TableFieldSchemaOrBuilder
        Returns:
        The precision.

      • getScale

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

      • getDefaultValueExpression

        public 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];
        Specified by:
        getDefaultValueExpression in interface TableFieldSchemaOrBuilder
        Returns:
        The defaultValueExpression.

      • getDefaultValueExpressionBytes

        public 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];
        Specified by:
        getDefaultValueExpressionBytes in interface TableFieldSchemaOrBuilder
        Returns:
        The bytes for defaultValueExpression.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TableFieldSchema parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TableFieldSchema parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TableFieldSchema.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TableFieldSchema.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TableFieldSchema.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<TableFieldSchema> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TableFieldSchema getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder