nebius.api.nebius.common.v1.PreflightCheckContext

class documentation

class PreflightCheckContext(Message): (source)

Constructor: PreflightCheckContext(initial_message, action, tool, unknown_paths, ...)

View In Hierarchy

Context supplied by a caller when requesting a server-side preflight check.

Class Action Operation evaluated by the preflight check.
Method __init__ Create a message from a source message and field values.
Method action.setter Set or clear the generated action field.
Method paths_require_recreate.setter Set or clear the generated paths_require_recreate field.
Method tool.setter Set or clear the generated tool field.
Method unknown_paths.setter Set or clear the generated unknown_paths field.
Property action Operation evaluated by the preflight check.
Property paths_require_recreate Additive Nebius mask of fields that require resource recreation when changed. For RECREATE, the calling tool fills this mask with the paths that caused it to recreate the resource. If a field at one of these paths changes, the calling tool must delete the existing resource and create a new resource with the requested values...
Property tool Lower-case name of the calling tool, such as "terraform", "cli", or "console". Empty means that no tool-specific behavior is requested.
Property unknown_paths Nebius mask identifying values in the proposed request that are unknown. An unknown value is not available to the caller when it sends the preflight request. The caller expects the actual value to be available when the create or update operation runs...

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, *, action: Action | None | UnsetType = ..., tool: str | None | UnsetType = ..., unknown_paths: str | None | UnsetType = ..., paths_require_recreate: str | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@action.setter
def action(self, value: Action | None): (source)

Set or clear the generated action field.

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

Set or clear the generated paths_require_recreate field.

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

Set or clear the generated tool field.

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

Set or clear the generated unknown_paths field.

@property
action: Action = (source)

Operation evaluated by the preflight check.

@property
paths_require_recreate: str = (source)

Additive Nebius mask of fields that require resource recreation when changed. For RECREATE, the calling tool fills this mask with the paths that caused it to recreate the resource. If a field at one of these paths changes, the calling tool must delete the existing resource and create a new resource with the requested values. Empty means that the caller has not identified any such fields.

@property
tool: str = (source)

Lower-case name of the calling tool, such as "terraform", "cli", or "console". Empty means that no tool-specific behavior is requested.

@property
unknown_paths: str = (source)

Nebius mask identifying values in the proposed request that are unknown. An unknown value is not available to the caller when it sends the preflight request. The caller expects the actual value to be available when the create or update operation runs. The mask is rooted at the request's metadata and spec fields. Empty means all supplied values are known; "*" means the complete proposed request is unknown.