nebius.api.nebius.common.error.v1alpha1.ServiceError

class documentation

class ServiceError(Message): (source)

Constructor: ServiceError(initial_message, service, code, bad_request, ...)

View In Hierarchy

Migrate to common/v1.

Class __OneOfClass_details__ Undocumented
Class __OneOfClass_details_bad_request__ Undocumented
Class __OneOfClass_details_bad_resource_state__ Undocumented
Class __OneOfClass_details_internal_error__ Undocumented
Class __OneOfClass_details_operation_aborted__ Undocumented
Class __OneOfClass_details_out_of_range__ Undocumented
Class __OneOfClass_details_permission_denied__ Undocumented
Class __OneOfClass_details_quota_failure__ Undocumented
Class __OneOfClass_details_resource_already_exists__ Undocumented
Class __OneOfClass_details_resource_conflict__ Undocumented
Class __OneOfClass_details_resource_not_found__ Undocumented
Class __OneOfClass_details_too_many_requests__ Undocumented
Method __init__ Create a message from a source message and field values.
Method bad_request.setter Set or clear the generated bad_request field.
Method bad_resource_state.setter Set or clear the generated bad_resource_state field.
Method code.setter Set or clear the generated code field.
Method internal_error.setter Set or clear the generated internal_error field.
Method operation_aborted.setter Set or clear the generated operation_aborted field.
Method out_of_range.setter Set or clear the generated out_of_range field.
Method permission_denied.setter Set or clear the generated permission_denied field.
Method quota_failure.setter Set or clear the generated quota_failure field.
Method resource_already_exists.setter Set or clear the generated resource_already_exists field.
Method resource_conflict.setter Set or clear the generated resource_conflict field.
Method resource_not_found.setter Set or clear the generated resource_not_found field.
Method retry_type.setter Set or clear the generated retry_type field.
Method service.setter Set or clear the generated service field.
Method too_many_requests.setter Set or clear the generated too_many_requests field.
Constant __PROTO_DESCRIPTOR__ Protobuf message descriptor from the registry.
Constant __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Constant __PY_TO_PB2__ Mapping from Python member names to protobuf names.
Property bad_request Undocumented
Property bad_resource_state Undocumented
Property code Detailed error code, service-specific. E.g. "DnsZoneNotEmpty". Name of the exception, without Exception suffix if not set Example: for PermissionDeniedException -> code == PermissionDenied
Property details Undocumented
Property internal_error Undocumented
Property operation_aborted Undocumented
Property out_of_range Undocumented
Property permission_denied Undocumented
Property quota_failure Undocumented
Property resource_already_exists Undocumented
Property resource_conflict Undocumented
Property resource_not_found Undocumented
Property retry_type Retry type tells how to provide retry, e.g.: just a single call or the whole logic before it.
Property service ID of Service which the error originated in. E.g. "dns".
Property too_many_requests Undocumented

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 __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 __REGISTRY__ Registry for the message and its descriptor.
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 _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, *, service: str | None | UnsetType = _NEBIUS_UNSET, code: str | None | UnsetType = _NEBIUS_UNSET, bad_request: BadRequest | None | UnsetType = _NEBIUS_UNSET, bad_resource_state: BadResourceState | None | UnsetType = _NEBIUS_UNSET, resource_not_found: ResourceNotFound | None | UnsetType = _NEBIUS_UNSET, resource_already_exists: ResourceAlreadyExists | None | UnsetType = _NEBIUS_UNSET, out_of_range: OutOfRange | None | UnsetType = _NEBIUS_UNSET, permission_denied: PermissionDenied | None | UnsetType = _NEBIUS_UNSET, resource_conflict: ResourceConflict | None | UnsetType = _NEBIUS_UNSET, operation_aborted: OperationAborted | None | UnsetType = _NEBIUS_UNSET, too_many_requests: TooManyRequests | None | UnsetType = _NEBIUS_UNSET, quota_failure: QuotaFailure | None | UnsetType = _NEBIUS_UNSET, internal_error: InternalError | None | UnsetType = _NEBIUS_UNSET, retry_type: ServiceError__RetryType | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@bad_request.setter
def bad_request(self, value: BadRequest | None): (source)

Set or clear the generated bad_request field.

@bad_resource_state.setter
def bad_resource_state(self, value: BadResourceState | None): (source)

Set or clear the generated bad_resource_state field.

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

Set or clear the generated code field.

@internal_error.setter
def internal_error(self, value: InternalError | None): (source)

Set or clear the generated internal_error field.

@operation_aborted.setter
def operation_aborted(self, value: OperationAborted | None): (source)

Set or clear the generated operation_aborted field.

@out_of_range.setter
def out_of_range(self, value: OutOfRange | None): (source)

Set or clear the generated out_of_range field.

@permission_denied.setter
def permission_denied(self, value: PermissionDenied | None): (source)

Set or clear the generated permission_denied field.

@quota_failure.setter
def quota_failure(self, value: QuotaFailure | None): (source)

Set or clear the generated quota_failure field.

@resource_already_exists.setter
def resource_already_exists(self, value: ResourceAlreadyExists | None): (source)

Set or clear the generated resource_already_exists field.

@resource_conflict.setter
def resource_conflict(self, value: ResourceConflict | None): (source)

Set or clear the generated resource_conflict field.

@resource_not_found.setter
def resource_not_found(self, value: ResourceNotFound | None): (source)

Set or clear the generated resource_not_found field.

@retry_type.setter
def retry_type(self, value: ServiceError__RetryType | None): (source)

Set or clear the generated retry_type field.

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

Set or clear the generated service field.

@too_many_requests.setter
def too_many_requests(self, value: TooManyRequests | None): (source)

Set or clear the generated too_many_requests field.

__PROTO_DESCRIPTOR__ = (source)
overrides nebius.base.protos.direct.Message.__PROTO_DESCRIPTOR__

Protobuf message descriptor from the registry.

Value
REGISTRY.message_descriptor('nebius.common.error.v1alpha1.ServiceError')
__PROTO_FULL_NAME__: str = (source)
overrides nebius.base.protos.direct.Message.__PROTO_FULL_NAME__

Fully qualified protobuf message name.

Value
'nebius.common.error.v1alpha1.ServiceError'
__PY_TO_PB2__: dict[str, str] = (source)
overrides nebius.base.protos.direct.Message.__PY_TO_PB2__

Mapping from Python member names to protobuf names.

Value
{'service': 'service',
 'code': 'code',
 'bad_request': 'bad_request',
 'bad_resource_state': 'bad_resource_state',
 'resource_not_found': 'resource_not_found',
 'resource_already_exists': 'resource_already_exists',
 'out_of_range': 'out_of_range',
...
@_NebiusProperty
bad_request: BadRequest | None = (source)

Undocumented

@_NebiusProperty
bad_resource_state: BadResourceState | None = (source)

Undocumented

@_NebiusProperty
code: str = (source)

Detailed error code, service-specific. E.g. "DnsZoneNotEmpty". Name of the exception, without Exception suffix if not set Example: for PermissionDeniedException -> code == PermissionDenied

@_NebiusProperty
details: __OneOfClass_details_bad_request__ | __OneOfClass_details_bad_resource_state__ | __OneOfClass_details_resource_not_found__ | __OneOfClass_details_resource_already_exists__ | __OneOfClass_details_out_of_range__ | __OneOfClass_details_permission_denied__ | __OneOfClass_details_resource_conflict__ | __OneOfClass_details_operation_aborted__ | __OneOfClass_details_too_many_requests__ | __OneOfClass_details_quota_failure__ | __OneOfClass_details_internal_error__ | None = (source)

Undocumented

@_NebiusProperty
internal_error: InternalError | None = (source)

Undocumented

@_NebiusProperty
operation_aborted: OperationAborted | None = (source)

Undocumented

@_NebiusProperty
out_of_range: OutOfRange | None = (source)

Undocumented

@_NebiusProperty
permission_denied: PermissionDenied | None = (source)

Undocumented

@_NebiusProperty
quota_failure: QuotaFailure | None = (source)

Undocumented

@_NebiusProperty
resource_already_exists: ResourceAlreadyExists | None = (source)

Undocumented

@_NebiusProperty
resource_conflict: ResourceConflict | None = (source)

Undocumented

@_NebiusProperty
resource_not_found: ResourceNotFound | None = (source)

Undocumented

@_NebiusProperty
retry_type: ServiceError__RetryType = (source)

Retry type tells how to provide retry, e.g.: just a single call or the whole logic before it.

@_NebiusProperty
service: str = (source)

ID of Service which the error originated in. E.g. "dns".

@_NebiusProperty
too_many_requests: TooManyRequests | None = (source)

Undocumented