Class/Object

com.google.protobuf.compiler.plugin

CodeGeneratorRequest

Related Docs: object CodeGeneratorRequest | package plugin

Permalink

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.collection.Seq.empty, parameter: scala.Option[String] = None, protoFile: Seq[FileDescriptorProto] = _root_.scala.collection.Seq.empty, compilerVersion: scala.Option[Version] = 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, 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. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addAllFileToGenerate(__vs: TraversableOnce[String]): CodeGeneratorRequest

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

    Permalink
  6. def addFileToGenerate(__vs: String*): CodeGeneratorRequest

    Permalink
  7. def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clearCompilerVersion: CodeGeneratorRequest

    Permalink
  10. def clearFileToGenerate: CodeGeneratorRequest

    Permalink
  11. def clearParameter: CodeGeneratorRequest

    Permalink
  12. def clearProtoFile: CodeGeneratorRequest

    Permalink
  13. def clone(): AnyRef

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

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  15. val compilerVersion: scala.Option[Version]

    Permalink

    The version number of protocol compiler.

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

    Permalink
    Definition Classes
    AnyRef
  17. val fileToGenerate: Seq[String]

    Permalink

    The .proto files that were explicitly listed on the command-line.

    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.

  18. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getCompilerVersion: Version

    Permalink
  21. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): scala.Any

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  23. def getParameter: String

    Permalink
  24. final def isInstanceOf[T0]: Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val parameter: scala.Option[String]

    Permalink

    The generator parameter passed on the command-line.

  30. val protoFile: Seq[FileDescriptorProto]

    Permalink

    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.

  31. final def serializedSize: Int

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

    Permalink
    Definition Classes
    AnyRef
  33. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  34. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  35. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  36. def toString(): String

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

    Permalink
    Definition Classes
    Updatable
  38. final def wait(): Unit

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

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

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

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

    Permalink
  43. def withParameter(__v: String): CodeGeneratorRequest

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

    Permalink
  45. def writeDelimitedTo(output: OutputStream): Unit

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

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

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, scala.Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

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

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped