Package com.elide.model

Class SpannerFieldOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.elide.model.SpannerFieldOptions
All Implemented Interfaces:
SpannerFieldOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SpannerFieldOptions extends com.google.protobuf.GeneratedMessageV3 implements SpannerFieldOptionsOrBuilder
 Extended options for use with Cloud Spanner, which may be affixed to an individual model field.
Protobuf type elide.model.SpannerFieldOptions
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SpannerFieldOptions.Builder
    Extended options for use with Cloud Spanner, which may be affixed to an individual model field.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COLUMN_FIELD_NUMBER
     
    static final int
    EXPRESSION_FIELD_NUMBER
     
    static final int
    IGNORE_FIELD_NUMBER
     
    static final int
    JSON_FIELD_NUMBER
     
    static final int
    NONNULL_FIELD_NUMBER
     
    static final int
    PRIMARY_KEY_FIELD_NUMBER
     
    static final int
    SIZE_FIELD_NUMBER
     
    static final int
    STORED_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getColumn()
    Override column name in Spanner only.
    com.google.protobuf.ByteString
    getColumnBytes()
    Override column name in Spanner only.
    static SpannerFieldOptions
    getDefaultInstance()
     
    SpannerFieldOptions
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getExpression()
    Expression value for this field.
    com.google.protobuf.ByteString
    getExpressionBytes()
    Expression value for this field.
    boolean
    getIgnore()
    Whether to ignore this column in Spanner specifically.
    boolean
    getJson()
    Override the field to store STRUCT objects as JSON.
    boolean
    getNonnull()
    Specifies this column as `NONNULL`, in which case you cannot store `NULL` values in this field.
    com.google.protobuf.Parser<SpannerFieldOptions>
    getParserForType()
     
    boolean
    getPrimaryKey()
    Marks a field as a member of a Spanner row's primary key.
    int
    getSerializedSize()
     
    int
    getSize()
    Length of this field in the database, when expressed as a string.
    boolean
    getStored()
    Specifies the `STORED` option for this field.
    SpannerOptions.SpannerType
    getType()
    Override the field type in Spanner only.
    int
    getTypeValue()
    Override the field type in Spanner only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SpannerFieldOptions.Builder
    newBuilder()
     
    static SpannerFieldOptions.Builder
    newBuilder(SpannerFieldOptions prototype)
     
    SpannerFieldOptions.Builder
    newBuilderForType()
     
    protected SpannerFieldOptions.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SpannerFieldOptions
    parseDelimitedFrom(InputStream input)
     
    static SpannerFieldOptions
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SpannerFieldOptions
    parseFrom(byte[] data)
     
    static SpannerFieldOptions
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SpannerFieldOptions
    parseFrom(com.google.protobuf.ByteString data)
     
    static SpannerFieldOptions
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SpannerFieldOptions
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SpannerFieldOptions
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SpannerFieldOptions
    parseFrom(InputStream input)
     
    static SpannerFieldOptions
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SpannerFieldOptions
    parseFrom(ByteBuffer data)
     
    static SpannerFieldOptions
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SpannerFieldOptions>
    parser()
     
    SpannerFieldOptions.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • 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

    • getColumn

      public String getColumn()
       Override column name in Spanner only.
      string column = 1 [json_name = "column"];
      Specified by:
      getColumn in interface SpannerFieldOptionsOrBuilder
      Returns:
      The column.

    • getColumnBytes

      public com.google.protobuf.ByteString getColumnBytes()
       Override column name in Spanner only.
      string column = 1 [json_name = "column"];
      Specified by:
      getColumnBytes in interface SpannerFieldOptionsOrBuilder
      Returns:
      The bytes for column.

    • getIgnore

      public boolean getIgnore()
       Whether to ignore this column in Spanner specifically.
      bool ignore = 2 [json_name = "ignore"];
      Specified by:
      getIgnore in interface SpannerFieldOptionsOrBuilder
      Returns:
      The ignore.

    • getTypeValue

      public int getTypeValue()
       Override the field type in Spanner only.
      .elide.model.SpannerOptions.SpannerType type = 3 [json_name = "type"];
      Specified by:
      getTypeValue in interface SpannerFieldOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public SpannerOptions.SpannerType getType()
       Override the field type in Spanner only.
      .elide.model.SpannerOptions.SpannerType type = 3 [json_name = "type"];
      Specified by:
      getType in interface SpannerFieldOptionsOrBuilder
      Returns:
      The type.

    • getJson

      public boolean getJson()
       Override the field to store STRUCT objects as JSON.
      bool json = 4 [json_name = "json"];
      Specified by:
      getJson in interface SpannerFieldOptionsOrBuilder
      Returns:
      The json.

    • getSize

      public int getSize()
       Length of this field in the database, when expressed as a string.
      uint32 size = 5 [json_name = "size"];
      Specified by:
      getSize in interface SpannerFieldOptionsOrBuilder
      Returns:
      The size.

    • getNonnull

      public boolean getNonnull()
       Specifies this column as `NONNULL`, in which case you cannot store `NULL` values in this field.
      bool nonnull = 6 [json_name = "nonnull"];
      Specified by:
      getNonnull in interface SpannerFieldOptionsOrBuilder
      Returns:
      The nonnull.

    • getExpression

      public String getExpression()
       Expression value for this field. Converts this field into a calculated value.
      string expression = 7 [json_name = "expression"];
      Specified by:
      getExpression in interface SpannerFieldOptionsOrBuilder
      Returns:
      The expression.

    • getExpressionBytes

      public com.google.protobuf.ByteString getExpressionBytes()
       Expression value for this field. Converts this field into a calculated value.
      string expression = 7 [json_name = "expression"];
      Specified by:
      getExpressionBytes in interface SpannerFieldOptionsOrBuilder
      Returns:
      The bytes for expression.

    • getStored

      public boolean getStored()
       Specifies the `STORED` option for this field. Only applicable if an `expression` is present.
      bool stored = 8 [json_name = "stored"];
      Specified by:
      getStored in interface SpannerFieldOptionsOrBuilder
      Returns:
      The stored.

    • getPrimaryKey

      public boolean getPrimaryKey()
       Marks a field as a member of a Spanner row's primary key.
      bool primary_key = 9 [json_name = "primaryKey"];
      Specified by:
      getPrimaryKey in interface SpannerFieldOptionsOrBuilder
      Returns:
      The primaryKey.

    • 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 SpannerFieldOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SpannerFieldOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SpannerFieldOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SpannerFieldOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SpannerFieldOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SpannerFieldOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SpannerFieldOptions.Builder newBuilder()

    • newBuilder

      public static SpannerFieldOptions.Builder newBuilder(SpannerFieldOptions prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SpannerFieldOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SpannerFieldOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<SpannerFieldOptions> 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 SpannerFieldOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder