com.google.protobuf.compiler.plugin

CodeGeneratorRequest

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = scala.collection.Seq.empty[Nothing], parameter: Option[String] = scala.None, protoFile: Seq[FileDescriptorProto] = scala.collection.Seq.empty[Nothing], compilerVersion: Option[Version] = 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( 0L )
Linear Supertypes
Product, Equals, Updatable[CodeGeneratorRequest], scalapb.Message[CodeGeneratorRequest], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CodeGeneratorRequest
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CodeGeneratorRequest(fileToGenerate: Seq[String] = scala.collection.Seq.empty[Nothing], parameter: Option[String] = scala.None, protoFile: Seq[FileDescriptorProto] = scala.collection.Seq.empty[Nothing], compilerVersion: Option[Version] = 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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addAllFileToGenerate(__vs: TraversableOnce[String]): CodeGeneratorRequest

  7. def addAllProtoFile(__vs: TraversableOnce[FileDescriptorProto]): CodeGeneratorRequest

  8. def addFileToGenerate(__vs: String*): CodeGeneratorRequest

  9. def addProtoFile(__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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def companion: CodeGeneratorRequest.type

    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  17. val compilerVersion: Option[Version]

    The version number of protocol compiler.

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

    Definition Classes
    AnyRef
  19. val fileToGenerate: Seq[String]

    The .

    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.

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getCompilerVersion: Version

  23. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  24. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  25. def getParameter: String

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. def mergeFrom(_input__: CodedInputStream): CodeGeneratorRequest

    Definition Classes
    CodeGeneratorRequestMessage
  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. val parameter: Option[String]

    The generator parameter passed on the command-line.

  32. val protoFile: Seq[FileDescriptorProto]

    FileDescriptorProtos for all files in files_to_generate and everything they import.

    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.

  33. final def serializedSize: Int

    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage
  36. def toByteString: ByteString

    Definition Classes
    GeneratedMessage
  37. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage
  38. def toString(): String

    Definition Classes
    CodeGeneratorRequest → AnyRef → Any
  39. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) ⇒ (CodeGeneratorRequest) ⇒ CodeGeneratorRequest*): CodeGeneratorRequest

    Definition Classes
    Updatable
  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def withCompilerVersion(__v: Version): CodeGeneratorRequest

  44. def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest

  45. def withParameter(__v: String): CodeGeneratorRequest

  46. def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest

  47. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage
  48. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  49. def writeTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): 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 scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped