Package com.elide.model

Class FieldPersistenceOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.elide.model.FieldPersistenceOptions
All Implemented Interfaces:
FieldPersistenceOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class FieldPersistenceOptions extends com.google.protobuf.GeneratedMessageV3 implements FieldPersistenceOptionsOrBuilder
 Persistence/data engine options specific to an individual message field.
Protobuf type elide.model.FieldPersistenceOptions
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FieldPersistenceOptions.Builder
    Persistence/data engine options specific to an individual message 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
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXPLICIT_FIELD_NUMBER
     
    static final int
    IMMUTABLE_FIELD_NUMBER
     
    static final int
    READ_ONLY_FIELD_NUMBER
     
    static final int
    STAMP_CREATE_FIELD_NUMBER
     
    static final int
    STAMP_UPDATE_FIELD_NUMBER
     
    static final int
    SUMMARY_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     
    static final int
    VISIBILITY_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)
     
    static FieldPersistenceOptions
    getDefaultInstance()
     
    FieldPersistenceOptions
    getDefaultInstanceForType()
     
    String
    getDescription()
    Deprecated.
    elide.model.FieldPersistenceOptions.description is deprecated.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Deprecated.
    elide.model.FieldPersistenceOptions.description is deprecated.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getExplicit()
    This field should always be explicitly listed with a value, even if it is set to the default value.
    boolean
    getImmutable()
    This field should allow writes when the model that contains it is written, but then, henceforth, the model should not allow this field to be mutated.
    com.google.protobuf.Parser<FieldPersistenceOptions>
    getParserForType()
     
    boolean
    getReadOnly()
    This field should not allow writes, but rather produce its value dynamically.
    int
    getSerializedSize()
     
    boolean
    getStampCreate()
    This item is a timestamp, and we would like it to be automatically set when the model is created.
    boolean
    getStampUpdate()
    This item is a timestamp, and we would like it to be automatically updated each time the model that contains it is modified in underlying storage.
    String
    getSummary()
    Summary for this field, which provides a narrative description.
    com.google.protobuf.ByteString
    getSummaryBytes()
    Summary for this field, which provides a narrative description.
    FieldType
    getType()
    Field type, for special-case fields.
    int
    getTypeValue()
    Field type, for special-case fields.
    FieldVisibility
    getVisibility()
    Describes the visibility level of a given field in a tree of fields.
    int
    getVisibilityValue()
    Describes the visibility level of a given field in a tree of fields.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FieldPersistenceOptions.Builder
    newBuilder()
     
    static FieldPersistenceOptions.Builder
    newBuilder(FieldPersistenceOptions prototype)
     
    FieldPersistenceOptions.Builder
    newBuilderForType()
     
    protected FieldPersistenceOptions.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FieldPersistenceOptions
    parseDelimitedFrom(InputStream input)
     
    static FieldPersistenceOptions
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPersistenceOptions
    parseFrom(byte[] data)
     
    static FieldPersistenceOptions
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPersistenceOptions
    parseFrom(com.google.protobuf.ByteString data)
     
    static FieldPersistenceOptions
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPersistenceOptions
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FieldPersistenceOptions
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPersistenceOptions
    parseFrom(InputStream input)
     
    static FieldPersistenceOptions
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPersistenceOptions
    parseFrom(ByteBuffer data)
     
    static FieldPersistenceOptions
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FieldPersistenceOptions>
    parser()
     
    FieldPersistenceOptions.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

    • getTypeValue

      public int getTypeValue()
       Field type, for special-case fields.
      .elide.model.FieldType type = 1 [json_name = "type"];
      Specified by:
      getTypeValue in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public FieldType getType()
       Field type, for special-case fields.
      .elide.model.FieldType type = 1 [json_name = "type"];
      Specified by:
      getType in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The type.

    • getSummary

      public String getSummary()
       Summary for this field, which provides a narrative description. It should be suitable for use in external
 circumstances, like documentation.
      string summary = 2 [json_name = "summary"];
      Specified by:
      getSummary in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The summary.

    • getSummaryBytes

      public com.google.protobuf.ByteString getSummaryBytes()
       Summary for this field, which provides a narrative description. It should be suitable for use in external
 circumstances, like documentation.
      string summary = 2 [json_name = "summary"];
      Specified by:
      getSummaryBytes in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The bytes for summary.

    • getStampUpdate

      public boolean getStampUpdate()
       This item is a timestamp, and we would like it to be automatically updated each time the model that contains it is
 modified in underlying storage. The field should be read-only.
      bool stamp_update = 3 [json_name = "stampUpdate"];
      Specified by:
      getStampUpdate in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The stampUpdate.

    • getStampCreate

      public boolean getStampCreate()
       This item is a timestamp, and we would like it to be automatically set when the model is created. After that point,
 we would like this field to be read-only.
      bool stamp_create = 4 [json_name = "stampCreate"];
      Specified by:
      getStampCreate in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The stampCreate.

    • getReadOnly

      public boolean getReadOnly()
       This field should not allow writes, but rather produce its value dynamically. Fields marked in this manner cannot
 be set by external code at any point in time.
      bool read_only = 5 [json_name = "readOnly"];
      Specified by:
      getReadOnly in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The readOnly.

    • getImmutable

      public boolean getImmutable()
       This field should allow writes when the model that contains it is written, but then, henceforth, the model should
 not allow this field to be mutated.
      bool immutable = 6 [json_name = "immutable"];
      Specified by:
      getImmutable in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The immutable.

    • getExplicit

      public boolean getExplicit()
       This field should always be explicitly listed with a value, even if it is set to the default value. This function
 is especially useful for enums with default values, when there is a desire to have consistent indexes.
      bool explicit = 7 [json_name = "explicit"];
      Specified by:
      getExplicit in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The explicit.

    • getVisibilityValue

      public int getVisibilityValue()
       Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
 fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
 certain data may be withheld corresponding to the invoking user or system's access level.
      .elide.model.FieldVisibility visibility = 8 [json_name = "visibility"];
      Specified by:
      getVisibilityValue in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      public FieldVisibility getVisibility()
       Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
 fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
 certain data may be withheld corresponding to the invoking user or system's access level.
      .elide.model.FieldVisibility visibility = 8 [json_name = "visibility"];
      Specified by:
      getVisibility in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The visibility.

    • getDescription

      @Deprecated public String getDescription()
      Deprecated.
      elide.model.FieldPersistenceOptions.description is deprecated. See elide/model/model.proto;l=254
       Provided for backwards compatibility. Do not use.
      string description = 9 [json_name = "description", deprecated = true];
      Specified by:
      getDescription in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      @Deprecated public com.google.protobuf.ByteString getDescriptionBytes()
      Deprecated.
      elide.model.FieldPersistenceOptions.description is deprecated. See elide/model/model.proto;l=254
       Provided for backwards compatibility. Do not use.
      string description = 9 [json_name = "description", deprecated = true];
      Specified by:
      getDescriptionBytes in interface FieldPersistenceOptionsOrBuilder
      Returns:
      The bytes for description.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FieldPersistenceOptions.Builder newBuilder()

    • newBuilder

      public static FieldPersistenceOptions.Builder newBuilder(FieldPersistenceOptions prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FieldPersistenceOptions getDefaultInstance()

    • parser

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

    • getParserForType

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