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()
- Alphabetic
- By Inheritance
- CodeGeneratorRequest
- Product
- Equals
- Updatable
- Message
- GeneratedMessage
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- 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
- final def !=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllFileToGenerate(__vs: Iterable[String]): CodeGeneratorRequest
- def addAllProtoFile(__vs: Iterable[FileDescriptorProto]): CodeGeneratorRequest
- def addFileToGenerate(__vs: String*): CodeGeneratorRequest
- def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearCompilerVersion: CodeGeneratorRequest
- def clearFileToGenerate: CodeGeneratorRequest
- def clearParameter: CodeGeneratorRequest
- def clearProtoFile: CodeGeneratorRequest
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def companion: CodeGeneratorRequest
- Definition Classes
- CodeGeneratorRequest → GeneratedMessage
- val compilerVersion: scala.Option[Version]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fileToGenerate: Seq[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getCompilerVersion: Version
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- CodeGeneratorRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): scala.Any
- Definition Classes
- CodeGeneratorRequest → GeneratedMessage
- def getParameter: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mergeFrom(_input__: CodedInputStream): CodeGeneratorRequest
- Definition Classes
- CodeGeneratorRequest → Message
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val parameter: scala.Option[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val protoFile: Seq[FileDescriptorProto]
- final def serializedSize: Int
- Definition Classes
- CodeGeneratorRequest → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- 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
- def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) => Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest
- Definition Classes
- Updatable
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withCompilerVersion(__v: Version): CodeGeneratorRequest
- def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest
- def withParameter(__v: String): CodeGeneratorRequest
- def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest
- def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- CodeGeneratorRequest → GeneratedMessage
- def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
- 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.
- def getAllFields: Map[FieldDescriptor, scala.Any]
- Definition Classes
- GeneratedMessage
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use toPMessage
- 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