Packages

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.Seq.empty, parameter: scala.Option[String] = _root_.scala.None, protoFile: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: scala.Option[Version] = _root_.scala.None) extends scalapb.GeneratedMessage with scalapb.Message[CodeGeneratorRequest] with Updatable[CodeGeneratorRequest] with Product with Serializable

An encoded CodeGeneratorRequest is written to the plugin's stdin.

fileToGenerate

The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.

parameter

The generator parameter passed on the command-line.

protoFile

FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.

compilerVersion

The version number of protocol compiler.

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

Instance Constructors

  1. new CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.Seq.empty, parameter: scala.Option[String] = _root_.scala.None, protoFile: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: scala.Option[Version] = _root_.scala.None)

    fileToGenerate

    The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.

    parameter

    The generator parameter passed on the command-line.

    protoFile

    FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.

    compilerVersion

    The version number of protocol compiler.

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 addAllFileToGenerate(__vs: Iterable[String]): CodeGeneratorRequest
  5. def addAllProtoFile(__vs: Iterable[FileDescriptorProto]): CodeGeneratorRequest
  6. def addFileToGenerate(__vs: String*): CodeGeneratorRequest
  7. def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearCompilerVersion: CodeGeneratorRequest
  10. def clearFileToGenerate: CodeGeneratorRequest
  11. def clearParameter: CodeGeneratorRequest
  12. def clearProtoFile: CodeGeneratorRequest
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. def companion: CodeGeneratorRequest
  15. val compilerVersion: scala.Option[Version]
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val fileToGenerate: Seq[String]
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def getCompilerVersion: Version
  20. def getField(__field: FieldDescriptor): PValue
  21. def getFieldByNumber(__fieldNumber: Int): scala.Any
  22. def getParameter: String
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def mergeFrom(_input__: CodedInputStream): CodeGeneratorRequest
    Definition Classes
    CodeGeneratorRequestMessage
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. val parameter: scala.Option[String]
  29. def productElementNames: Iterator[String]
    Definition Classes
    Product
  30. val protoFile: Seq[FileDescriptorProto]
  31. final def serializedSize: Int
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  34. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  35. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  36. 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
    CodeGeneratorRequestGeneratedMessage
  37. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) => Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest
    Definition Classes
    Updatable
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def withCompilerVersion(__v: Version): CodeGeneratorRequest
  42. def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest
  43. def withParameter(__v: String): CodeGeneratorRequest
  44. def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest
  45. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  46. def writeTo(_output__: CodedOutputStream): Unit
  47. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, scala.Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  3. def getField(field: FieldDescriptor): scala.Any
    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[CodeGeneratorRequest]

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped