nebius.api.google.protobuf.Api

class documentation

class Api(Message): (source)

Constructor: Api(initial_message, name, methods, options, ...)

View In Hierarchy

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

Method __init__ Create a message from a source message and field values.
Method edition.setter Set or clear the generated edition field.
Method methods.setter Set or clear the generated methods field.
Method mixins.setter Set or clear the generated mixins field.
Method name.setter Set or clear the generated name field.
Method options.setter Set or clear the generated options field.
Method source_context.setter Set or clear the generated source_context field.
Method syntax.setter Set or clear the generated syntax field.
Method version.setter Set or clear the generated version field.
Property edition The source edition string, only valid when syntax is SYNTAX_EDITIONS.
Property methods The methods of this interface, in unspecified order.
Property mixins Included interfaces. See [Mixin][].
Property name The fully qualified name of this interface, including package name followed by the interface's simple name.
Property options Any metadata attached to the interface.
Property source_context Source context for the protocol buffer service represented by this message.
Property syntax The source syntax of the service.
Property version A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below...

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, *, name: str | None | UnsetType = ..., methods: Iterable[Method] | None | UnsetType = ..., options: Iterable[Option] | None | UnsetType = ..., version: str | None | UnsetType = ..., source_context: SourceContext | None | UnsetType = ..., mixins: Iterable[Mixin] | None | UnsetType = ..., syntax: Syntax | None | UnsetType = ..., edition: str | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

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

Set or clear the generated edition field.

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

Set or clear the generated methods field.

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

Set or clear the generated mixins field.

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

Set or clear the generated name field.

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

Set or clear the generated options field.

@source_context.setter
def source_context(self, value: SourceContext | None): (source)

Set or clear the generated source_context field.

@syntax.setter
def syntax(self, value: Syntax | None): (source)

Set or clear the generated syntax field.

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

Set or clear the generated version field.

@property
edition: str = (source)

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

@property
methods: MutableSequence[Method] = (source)

The methods of this interface, in unspecified order.

@property
mixins: MutableSequence[Mixin] = (source)

Included interfaces. See [Mixin][].

@property
name: str = (source)

The fully qualified name of this interface, including package name followed by the interface's simple name.

@property
options: MutableSequence[Option] = (source)

Any metadata attached to the interface.

@property
source_context: SourceContext = (source)

Source context for the protocol buffer service represented by this message.

@property
syntax: Syntax = (source)

The source syntax of the service.

@property
version: str = (source)

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.