Package com.elide.model

Interface DatapointOptionsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getConcrete()
    Whether this property contains a "concrete" sub-message, in which case, its properties are lifted to the parent entity.
    boolean
    getEphemeral()
    Indicate to the data storage engine that a given field is ephemeral, and should not be stored, but rather held with a calculated value for use in systems upstream from the data storage layer.
    boolean
    getRequired()
    Whether this data point (model or field or enum, etc) should be considered "required" for this model to be valid.
    Visibility
    getVisibility()
    Sets the visibility options for this data point.
    int
    getVisibilityValue()
    Sets the visibility options for this data point.

    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

    • getVisibilityValue

      int getVisibilityValue()
       Sets the visibility options for this data point. Depending on these options, a property or model may be exposed to
 invoking code, protected from rewriting, and so on.
      .elide.model.Visibility visibility = 1 [json_name = "visibility"];
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      Visibility getVisibility()
       Sets the visibility options for this data point. Depending on these options, a property or model may be exposed to
 invoking code, protected from rewriting, and so on.
      .elide.model.Visibility visibility = 1 [json_name = "visibility"];
      Returns:
      The visibility.

    • getRequired

      boolean getRequired()
       Whether this data point (model or field or enum, etc) should be considered "required" for this model to be valid.
 This setting is applied in various circumstances, usually when data crosses API boundaries.
      bool required = 2 [json_name = "required"];
      Returns:
      The required.

    • getConcrete

      boolean getConcrete()
       Whether this property contains a "concrete" sub-message, in which case, its properties are lifted to the parent
 entity. During decoding, a property is added to indicate the concrete selection made. This is usually combined with
 generic types in a one-of field, for instance, in `MenuProduct`.
      bool concrete = 3 [json_name = "concrete"];
      Returns:
      The concrete.

    • getEphemeral

      boolean getEphemeral()
       Indicate to the data storage engine that a given field is ephemeral, and should not be stored, but rather held with
 a calculated value for use in systems upstream from the data storage layer.
      bool ephemeral = 4 [json_name = "ephemeral"];
      Returns:
      The ephemeral.