nebius.api.google.protobuf.compiler.CodeGeneratorRequest

class documentation

class CodeGeneratorRequest(Message): (source)

Constructor: CodeGeneratorRequest(initial_message, file_to_generate, parameter, proto_file, ...)

View In Hierarchy

An encoded CodeGeneratorRequest is written to the plugin's stdin.

Method __init__ Create a message from a source message and field values.
Method compiler_version.setter Set or clear the generated compiler_version field.
Method file_to_generate.setter Set or clear the generated file_to_generate field.
Method parameter.setter Set or clear the generated parameter field.
Method proto_file.setter Set or clear the generated proto_file field.
Method source_file_descriptors.setter Set or clear the generated source_file_descriptors field.
Property compiler_version The version number of protocol compiler.
Property file_to_generate 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.
Property parameter The generator parameter passed on the command-line.
Property proto_file 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.
Property source_file_descriptors File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.

Inherited from Message:

Class Method from_json Create a message from protobuf JSON mapping.
Class Method FromString Create a message by parsing protobuf wire-format bytes.
Class Method get_descriptor Return the message descriptor from the registry.
Class Method is_credentials Return True if a Python field contains credentials.
Class Method is_sensitive Return True if a Python field has the sensitive annotation.
Method __dir__ List generated fields, oneofs, and nested declarations.
Method __repr__ Render non-default fields without disclosing annotated secrets.
Method ByteSize Return the serialized protobuf wire size in bytes.
Method check_presence Check presence using a generated Python field name.
Method Clear Clear all fields, extensions, unknown fields, and the reset mask.
Method clear_extension Clear an extension value.
Method ClearField Clear a protobuf field or oneof and record it in the reset mask.
Method CopyFrom Replace this message with an independent copy of another message.
Method FindInitializationErrors Return paths of missing required fields.
Method get_extension Return an extension value.
Method get_full_update_reset_mask Create a reset mask from the current protobuf state.
Method get_mask Return the reset mask for field changes.
Method has_extension Return True if an extension has explicit presence.
Method HasField Return True if a protobuf field or oneof has explicit presence.
Method is_default Return True if a generated field has its default value.
Method IsInitialized Return True if every required field is initialized.
Method MergeFrom Merge fields from another message of the same generated type.
Method MergeFromString Merge protobuf wire-format bytes into this message.
Method ParseFromString Parse protobuf wire-format bytes and replace this message.
Method SerializeToString Serialize the message using protobuf wire format.
Method set_extension Set an extension value.
Method set_mask Set the reset mask for this message.
Method to_json Serialize this message using protobuf JSON mapping.
Method which_field_in_oneof Return the selected Python field name for a protobuf oneof.
Method WhichOneof Return the selected protobuf field name for a oneof.
Constant __DEPRECATION_DETAILS__ Undocumented
Constant __EXTENSION_REGISTRY__ Registry that decodes protobuf extensions.
Constant __FIELDS__ Runtime field data that the generator creates.
Constant __MAX_NESTING_DEPTH__ Maximum protobuf nesting depth for serialization, parsing, and initialization checks.
Constant __PB2_DESCRIPTOR__ Alias for code that expects a protobuf descriptor.
Constant __PROTO_DESCRIPTOR__ Message descriptor from the registry.
Constant __PY_TO_PB2__ Mapping from Python names to protobuf names.
Constant __REGISTRY__ Registry for the message and its descriptor.
Class Variable __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Property Extensions Provide protobuf-compatible mapping access to extension values.
Class Method _fields_by_number Undocumented
Class Method _fields_by_proto_name Undocumented
Class Method _fields_by_python_name Undocumented
Class Method _from_string Deserialize internally without invoking generated user warnings.
Class Method _oneof_python_name Undocumented
Class Method _public_fields_by_proto_name Undocumented
Class Method _public_fields_by_python_name Undocumented
Static Method _format_map_key Undocumented
Static Method _repr_field Undocumented
Method _bind_child Undocumented
Method _bind_mutation Undocumented
Method _check_same_type Undocumented
Method _child_changed Undocumented
Method _clear_state Undocumented
Method _closed_enum_unknown Undocumented
Method _converted_view Undocumented
Method _decode_map_entry Undocumented
Method _detach_child Undocumented
Method _field_has_value Undocumented
Method _field_is_default Undocumented
Method _find_initialization_errors Undocumented
Method _get_field Undocumented
Method _initialize Initialize message state, optionally suppressing generated warnings.
Method _map Undocumented
Method _merge_from_string Undocumented
Method _nesting_limit Undocumented
Method _notify Undocumented
Method _record_reset Undocumented
Method _repeated Undocumented
Method _select Undocumented
Method _serialize_to_string Undocumented
Method _set_field Undocumented
Method _suspend_mutation Undocumented
Method _suspend_reset_mask Undocumented
Method _try_decode_field Undocumented
Method _write_field Undocumented
Instance Variable _extensions Undocumented
Instance Variable _mutation_suspended Undocumented
Instance Variable _on_mutation Undocumented
Instance Variable _oneofs Undocumented
Instance Variable _present Undocumented
Instance Variable _reset_mask Undocumented
Instance Variable _reset_mask_suspended Undocumented
Instance Variable _unknown_fields Undocumented
Instance Variable _values Undocumented
Instance Variable _views Undocumented
def __init__(self, initial_message: SerializableMessage | None = None, *, file_to_generate: Iterable[str] | None | UnsetType = ..., parameter: str | None | UnsetType = ..., proto_file: Iterable[FileDescriptorProto] | None | UnsetType = ..., source_file_descriptors: Iterable[FileDescriptorProto] | None | UnsetType = ..., compiler_version: Version | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@compiler_version.setter
def compiler_version(self, value: Version | None): (source)

Set or clear the generated compiler_version field.

@file_to_generate.setter
def file_to_generate(self, value: Iterable[str] | None): (source)

Set or clear the generated file_to_generate field.

@parameter.setter
def parameter(self, value: str | None): (source)

Set or clear the generated parameter field.

@proto_file.setter
def proto_file(self, value: Iterable[FileDescriptorProto] | None): (source)

Set or clear the generated proto_file field.

@source_file_descriptors.setter
def source_file_descriptors(self, value: Iterable[FileDescriptorProto] | None): (source)

Set or clear the generated source_file_descriptors field.

@property
compiler_version: Version = (source)

The version number of protocol compiler.

@property
file_to_generate: MutableSequence[str] = (source)

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.

@property
parameter: str = (source)

The generator parameter passed on the command-line.

@property
proto_file: MutableSequence[FileDescriptorProto] = (source)

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.

@property
source_file_descriptors: MutableSequence[FileDescriptorProto] = (source)

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