Package com.elide.model

Class FieldPersistenceOptions.Builder

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

  • Method Details

    • 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.Builder<FieldPersistenceOptions.Builder>

    • clear

      public FieldPersistenceOptions.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public FieldPersistenceOptions.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • setField

      public FieldPersistenceOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • clearField

      public FieldPersistenceOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • clearOneof

      public FieldPersistenceOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • setRepeatedField

      public FieldPersistenceOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • addRepeatedField

      public FieldPersistenceOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • mergeFrom

      public FieldPersistenceOptions.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldPersistenceOptions.Builder>

    • mergeFrom

      public FieldPersistenceOptions.Builder mergeFrom(FieldPersistenceOptions other)

    • isInitialized

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

    • mergeFrom

      public FieldPersistenceOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldPersistenceOptions.Builder>
      Throws:
      IOException

    • 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.

    • setTypeValue

      public FieldPersistenceOptions.Builder setTypeValue(int value)
       Field type, for special-case fields.
      .elide.model.FieldType type = 1 [json_name = "type"];
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • 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.

    • setType

      public FieldPersistenceOptions.Builder setType(FieldType value)
       Field type, for special-case fields.
      .elide.model.FieldType type = 1 [json_name = "type"];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public FieldPersistenceOptions.Builder clearType()
       Field type, for special-case fields.
      .elide.model.FieldType type = 1 [json_name = "type"];
      Returns:
      This builder for chaining.

    • 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.

    • setSummary

      public FieldPersistenceOptions.Builder setSummary(String value)
       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"];
      Parameters:
      value - The summary to set.
      Returns:
      This builder for chaining.

    • clearSummary

      public FieldPersistenceOptions.Builder clearSummary()
       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:
      This builder for chaining.

    • setSummaryBytes

      public FieldPersistenceOptions.Builder setSummaryBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for summary to set.
      Returns:
      This builder for chaining.

    • 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.

    • setStampUpdate

      public FieldPersistenceOptions.Builder setStampUpdate(boolean value)
       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"];
      Parameters:
      value - The stampUpdate to set.
      Returns:
      This builder for chaining.

    • clearStampUpdate

      public FieldPersistenceOptions.Builder clearStampUpdate()
       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:
      This builder for chaining.

    • 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.

    • setStampCreate

      public FieldPersistenceOptions.Builder setStampCreate(boolean value)
       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"];
      Parameters:
      value - The stampCreate to set.
      Returns:
      This builder for chaining.

    • clearStampCreate

      public FieldPersistenceOptions.Builder clearStampCreate()
       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:
      This builder for chaining.

    • 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.

    • setReadOnly

      public FieldPersistenceOptions.Builder setReadOnly(boolean value)
       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"];
      Parameters:
      value - The readOnly to set.
      Returns:
      This builder for chaining.

    • clearReadOnly

      public FieldPersistenceOptions.Builder clearReadOnly()
       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:
      This builder for chaining.

    • 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.

    • setImmutable

      public FieldPersistenceOptions.Builder setImmutable(boolean value)
       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"];
      Parameters:
      value - The immutable to set.
      Returns:
      This builder for chaining.

    • clearImmutable

      public FieldPersistenceOptions.Builder clearImmutable()
       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:
      This builder for chaining.

    • 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.

    • setExplicit

      public FieldPersistenceOptions.Builder setExplicit(boolean value)
       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"];
      Parameters:
      value - The explicit to set.
      Returns:
      This builder for chaining.

    • clearExplicit

      public FieldPersistenceOptions.Builder clearExplicit()
       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:
      This builder for chaining.

    • 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.

    • setVisibilityValue

      public FieldPersistenceOptions.Builder setVisibilityValue(int value)
       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"];
      Parameters:
      value - The enum numeric value on the wire for visibility to set.
      Returns:
      This builder for chaining.

    • 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.

    • setVisibility

      public FieldPersistenceOptions.Builder setVisibility(FieldVisibility value)
       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"];
      Parameters:
      value - The visibility to set.
      Returns:
      This builder for chaining.

    • clearVisibility

      public FieldPersistenceOptions.Builder clearVisibility()
       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:
      This builder for chaining.

    • 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.

    • setDescription

      @Deprecated public FieldPersistenceOptions.Builder setDescription(String value)
      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];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      @Deprecated public FieldPersistenceOptions.Builder clearDescription()
      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:
      This builder for chaining.

    • setDescriptionBytes

      @Deprecated public FieldPersistenceOptions.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
      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];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final FieldPersistenceOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>

    • mergeUnknownFields

      public final FieldPersistenceOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPersistenceOptions.Builder>