Class/Object

com.google.protobuf.compiler.plugin

CodeGeneratorRequest

Related Docs: object CodeGeneratorRequest | package plugin

Permalink

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.Seq.empty, parameter: Option[String] = _root_.scala.None, protoFile: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: Option[Version] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) 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, 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.Seq.empty, parameter: Option[String] = _root_.scala.None, protoFile: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: Option[Version] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...)

    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: 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. def addAllFileToGenerate(__vs: Iterable[String]): CodeGeneratorRequest

    Permalink
  5. def addAllProtoFile(__vs: Iterable[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: Option[Version]

    Permalink

    The version number of protocol compiler.

  16. def discardUnknownFields: CodeGeneratorRequest

    Permalink
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. 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.

  19. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  24. def getParameter: String

    Permalink
  25. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

    Permalink

    The generator parameter passed on the command-line.

  31. 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.

  32. final def serializedSize: Int

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

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

    Permalink
    Definition Classes
    GeneratedMessage
  35. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  36. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  37. 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
    CodeGeneratorRequestGeneratedMessage
  38. val unknownFields: scalapb.UnknownFieldSet

    Permalink
  39. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) ⇒ Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest

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

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

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

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

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

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

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

    Permalink
  47. def withUnknownFields(__v: scalapb.UnknownFieldSet): CodeGeneratorRequest

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

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

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  50. 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[CodeGeneratorRequest]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped