final case class FieldOptions(ctype: scala.Option[CType] = _root_.scala.None, packed: scala.Option[Boolean] = _root_.scala.None, jstype: scala.Option[JSType] = _root_.scala.None, lazy: scala.Option[Boolean] = _root_.scala.None, unverifiedLazy: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, weak: scala.Option[Boolean] = _root_.scala.None, debugRedact: scala.Option[Boolean] = _root_.scala.None, retention: scala.Option[OptionRetention] = _root_.scala.None, targets: Seq[OptionTargetType] = _root_.scala.Seq.empty, editionDefaults: Seq[EditionDefault] = _root_.scala.Seq.empty, features: scala.Option[FeatureSet] = _root_.scala.None, featureSupport: scala.Option[FeatureSupport] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[FieldOptions] with ExtendableMessage[FieldOptions] with Product with Serializable

ctype

NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.

packed

The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.

jstype

The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

lazy

Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

unverifiedLazy

unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.

deprecated

Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.

weak

For Google-internal migration only. Do not use.

debugRedact

Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

features

Any features defined in the specific edition.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

Annotations
@SerialVersionUID()
Linear Supertypes
ExtendableMessage[FieldOptions], Updatable[FieldOptions], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldOptions
  2. ExtendableMessage
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldOptions(ctype: scala.Option[CType] = _root_.scala.None, packed: scala.Option[Boolean] = _root_.scala.None, jstype: scala.Option[JSType] = _root_.scala.None, lazy: scala.Option[Boolean] = _root_.scala.None, unverifiedLazy: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, weak: scala.Option[Boolean] = _root_.scala.None, debugRedact: scala.Option[Boolean] = _root_.scala.None, retention: scala.Option[OptionRetention] = _root_.scala.None, targets: Seq[OptionTargetType] = _root_.scala.Seq.empty, editionDefaults: Seq[EditionDefault] = _root_.scala.Seq.empty, features: scala.Option[FeatureSet] = _root_.scala.None, featureSupport: scala.Option[FeatureSupport] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...)

    ctype

    NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.

    packed

    The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.

    jstype

    The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

    lazy

    Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

    unverifiedLazy

    unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.

    deprecated

    Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.

    weak

    For Google-internal migration only. Do not use.

    debugRedact

    Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

    features

    Any features defined in the specific edition.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See above.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllEditionDefaults(__vs: Iterable[EditionDefault]): FieldOptions
  5. def addAllTargets(__vs: Iterable[OptionTargetType]): FieldOptions
  6. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): FieldOptions
  7. def addEditionDefaults(__vs: EditionDefault*): FieldOptions
  8. def addTargets(__vs: OptionTargetType*): FieldOptions
  9. def addUninterpretedOption(__vs: UninterpretedOption*): FieldOptions
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clearCtype: FieldOptions
  12. def clearDebugRedact: FieldOptions
  13. def clearDeprecated: FieldOptions
  14. def clearEditionDefaults: FieldOptions
  15. def clearFeatureSupport: FieldOptions
  16. def clearFeatures: FieldOptions
  17. def clearJstype: FieldOptions
  18. def clearLazy: FieldOptions
  19. def clearPacked: FieldOptions
  20. def clearRetention: FieldOptions
  21. def clearTargets: FieldOptions
  22. def clearUninterpretedOption: FieldOptions
  23. def clearUnverifiedLazy: FieldOptions
  24. def clearWeak: FieldOptions
  25. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. def companion: FieldOptions.type
    Definition Classes
    FieldOptions → GeneratedMessage
  27. val ctype: scala.Option[CType]
  28. val debugRedact: scala.Option[Boolean]
  29. val deprecated: scala.Option[Boolean]
  30. def discardUnknownFields: FieldOptions
  31. val editionDefaults: Seq[EditionDefault]
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def extension[T](generatedExtension: GeneratedExtension[FieldOptions, T]): T
    Definition Classes
    ExtendableMessage
  34. val featureSupport: scala.Option[FeatureSupport]
  35. val features: scala.Option[FeatureSet]
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def getCtype: CType
  39. def getDebugRedact: Boolean
  40. def getDeprecated: Boolean
  41. def getFeatureSupport: FeatureSupport
  42. def getFeatures: FeatureSet
  43. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FieldOptions → GeneratedMessage
  44. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    FieldOptions → GeneratedMessage
  45. def getJstype: JSType
  46. def getLazy: Boolean
  47. def getPacked: Boolean
  48. def getRetention: OptionRetention
  49. def getUnverifiedLazy: Boolean
  50. def getWeak: Boolean
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. val jstype: scala.Option[JSType]
  53. val lazy: scala.Option[Boolean]
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  57. val packed: scala.Option[Boolean]
  58. val retention: scala.Option[OptionRetention]
  59. def serializedSize: Int
    Definition Classes
    FieldOptions → GeneratedMessage
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. val targets: Seq[OptionTargetType]
  62. final def toByteArray: Array[Byte]

    Serializes the message and returns a byte array containing its raw bytes

    Serializes the message and returns a byte array containing its raw bytes

    Definition Classes
    GeneratedMessage
  63. final def toByteString: ByteString

    Serializes the message and returns a ByteString containing its raw bytes

    Serializes the message and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  64. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  65. def toProtoString: String

    Returns a human-readable ASCII format representation of this message.

    Returns a human-readable ASCII format representation of this message.

    The original message can be decoded from this format by using fromAscii on the companion object.

    returns

    human-readable representation of this message.

    Definition Classes
    FieldOptions → GeneratedMessage
  66. val uninterpretedOption: Seq[UninterpretedOption]
  67. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    FieldOptions → ExtendableMessage
  68. val unverifiedLazy: scala.Option[Boolean]
  69. def update(ms: (Lens[FieldOptions, FieldOptions]) ⇒ Mutation[FieldOptions]*): FieldOptions
    Definition Classes
    Updatable
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  73. val weak: scala.Option[Boolean]
  74. def withCtype(__v: CType): FieldOptions
  75. def withDebugRedact(__v: Boolean): FieldOptions
  76. def withDeprecated(__v: Boolean): FieldOptions
  77. def withEditionDefaults(__v: Seq[EditionDefault]): FieldOptions
  78. def withExtension[T](generatedExtension: GeneratedExtension[FieldOptions, T])(value: T): FieldOptions
    Definition Classes
    ExtendableMessage
  79. def withFeatureSupport(__v: FeatureSupport): FieldOptions
  80. def withFeatures(__v: FeatureSet): FieldOptions
  81. def withJstype(__v: JSType): FieldOptions
  82. def withLazy(__v: Boolean): FieldOptions
  83. def withPacked(__v: Boolean): FieldOptions
  84. def withRetention(__v: OptionRetention): FieldOptions
  85. def withTargets(__v: Seq[OptionTargetType]): FieldOptions
  86. def withUninterpretedOption(__v: Seq[UninterpretedOption]): FieldOptions
  87. def withUnknownFields(__v: scalapb.UnknownFieldSet): FieldOptions
    Definition Classes
    FieldOptions → ExtendableMessage
  88. def withUnverifiedLazy(__v: Boolean): FieldOptions
  89. def withWeak(__v: Boolean): FieldOptions
  90. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  91. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    FieldOptions → GeneratedMessage
  92. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from ExtendableMessage[FieldOptions]

Inherited from Updatable[FieldOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped