Class/Object

com.google.protobuf.type

OptionProto

Related Docs: object OptionProto | package type

Permalink

final case class OptionProto(name: String = "", value: Option[Any] = None) extends scalapb.GeneratedMessage with scalapb.Message[OptionProto] with Updatable[OptionProto] with Product with Serializable

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

name

The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".

value

The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

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

Instance Constructors

  1. new OptionProto(name: String = "", value: Option[Any] = None)

    Permalink

    name

    The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".

    value

    The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clearValue: OptionProto

    Permalink

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def companion: OptionProto.type

    Permalink
    Definition Classes
    OptionProto → GeneratedMessage

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    OptionProto → GeneratedMessage

  12. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    OptionProto → GeneratedMessage

  13. def getValue: Any

    Permalink

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. def mergeFrom(_input__: CodedInputStream): OptionProto

    Permalink
    Definition Classes
    OptionProto → Message

  16. val name: String

    Permalink

    The option's name.

    The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def serializedSize: Int

    Permalink
    Definition Classes
    OptionProto → GeneratedMessage

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  23. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  24. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  25. def toProtoString: String

    Permalink

    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
    OptionProto → GeneratedMessage

  26. def update(ms: (Lens[OptionProto, OptionProto]) ⇒ Mutation[OptionProto]*): OptionProto

    Permalink
    Definition Classes
    Updatable

  27. val value: Option[Any]

    Permalink

    The option's value packed in an Any message.

    The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def withName(__v: String): OptionProto

    Permalink

  32. def withValue(__v: Any): OptionProto

    Permalink

  33. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  34. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    OptionProto → GeneratedMessage

  35. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[OptionProto]

Inherited from scalapb.Message[OptionProto]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped