Package com.elide.model

Interface FieldPersistenceOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FieldPersistenceOptions, FieldPersistenceOptions.Builder
public interface FieldPersistenceOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Deprecated.
    elide.model.FieldPersistenceOptions.description is deprecated.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Deprecated.
    elide.model.FieldPersistenceOptions.description is deprecated.
    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.
    boolean
    getReadOnly()
    This field should not allow writes, but rather produce its value dynamically.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getTypeValue

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

    • getType

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

    • getSummary

      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"];
      Returns:
      The summary.

    • getSummaryBytes

      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"];
      Returns:
      The bytes for summary.

    • getStampUpdate

      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"];
      Returns:
      The stampUpdate.

    • getStampCreate

      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"];
      Returns:
      The stampCreate.

    • getReadOnly

      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"];
      Returns:
      The readOnly.

    • getImmutable

      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"];
      Returns:
      The immutable.

    • getExplicit

      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"];
      Returns:
      The explicit.

    • getVisibilityValue

      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"];
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      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"];
      Returns:
      The visibility.

    • getDescription

      @Deprecated 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];
      Returns:
      The description.

    • getDescriptionBytes

      @Deprecated 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];
      Returns:
      The bytes for description.