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, sourceFileDescriptors: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: scala.Option[Version] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage 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. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. 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.

sourceFileDescriptors

File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.

compilerVersion

The version number of protocol compiler.

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[CodeGeneratorRequest], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CodeGeneratorRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  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, sourceFileDescriptors: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: scala.Option[Version] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...)

    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. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. 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.

    sourceFileDescriptors

    File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.

    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 addAllSourceFileDescriptors(__vs: Iterable[FileDescriptorProto]): CodeGeneratorRequest
  7. def addFileToGenerate(__vs: String*): CodeGeneratorRequest
  8. def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest
  9. def addSourceFileDescriptors(__vs: FileDescriptorProto*): CodeGeneratorRequest
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clearCompilerVersion: CodeGeneratorRequest
  12. def clearFileToGenerate: CodeGeneratorRequest
  13. def clearParameter: CodeGeneratorRequest
  14. def clearProtoFile: CodeGeneratorRequest
  15. def clearSourceFileDescriptors: CodeGeneratorRequest
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def companion: CodeGeneratorRequest.type
    Definition Classes
    CodeGeneratorRequest → GeneratedMessage
  18. val compilerVersion: scala.Option[Version]
  19. def discardUnknownFields: CodeGeneratorRequest
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val fileToGenerate: Seq[String]
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def getCompilerVersion: Version
  25. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    CodeGeneratorRequest → GeneratedMessage
  26. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    CodeGeneratorRequest → GeneratedMessage
  27. def getParameter: String
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. val parameter: scala.Option[String]
  33. val protoFile: Seq[FileDescriptorProto]
  34. def serializedSize: Int
    Definition Classes
    CodeGeneratorRequest → GeneratedMessage
  35. val sourceFileDescriptors: Seq[FileDescriptorProto]
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. 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
  38. 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
  39. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  40. 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
    CodeGeneratorRequest → GeneratedMessage
  41. val unknownFields: scalapb.UnknownFieldSet
  42. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) ⇒ Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest
    Definition Classes
    Updatable
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  46. def withCompilerVersion(__v: Version): CodeGeneratorRequest
  47. def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest
  48. def withParameter(__v: String): CodeGeneratorRequest
  49. def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest
  50. def withSourceFileDescriptors(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest
  51. def withUnknownFields(__v: scalapb.UnknownFieldSet): CodeGeneratorRequest
  52. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  53. 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
    CodeGeneratorRequest → GeneratedMessage
  54. 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 Updatable[CodeGeneratorRequest]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped