nebius.api.nebius.common.v1alpha1.Operation

class documentation

class Operation(Message): (source)

Constructor: Operation(initial_message, id, description, created_at, ...)

View In Hierarchy

Migrate to common/v1.

Method __init__ Create a message from a source message and field values.
Method created_at.setter Set or clear the generated created_at field.
Method created_by.setter Set or clear the generated created_by field.
Method description.setter Set or clear the generated description field.
Method finished_at.setter Set or clear the generated finished_at field.
Method id.setter Set or clear the generated id field.
Method progress_data.setter Set or clear the generated progress_data field.
Method request.setter Set or clear the generated request field.
Method request_headers.setter Set or clear the generated request_headers field.
Method resource.setter Set or clear the generated resource field.
Method resource_id.setter Set or clear the generated resource_id field.
Method status.setter Set or clear the generated status 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 created_at Creation timestamp.
Property created_by ID of the user or service account who initiated the operation.
Property description Human readable description of the operation. 0-256 characters long.
Property finished_at The time when the operation finished.
Property id ID of the operation.
Property progress_data Additional information about the progress of an operation, e.g., a progress percentage. MAY be absent while the operation is running, MUST be absent after the operation has completed.
Property request The request that generated this operation.
Property request_headers The request headers that are essential for the request that generated the operation. For instance, x-resetmask. Without these headers the request might have been processed differently if repeated. All the header names ...
Property resource Snapshot of the resource at the moment this operation started.
Property resource_id ID of the resource that this operation creates, updates, deletes or otherwise changes.
Property status The status of this operation. Set when this operation is completed. See https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto.

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, *, id: str | None | UnsetType = _NEBIUS_UNSET, description: str | None | UnsetType = _NEBIUS_UNSET, created_at: datetime | Timestamp | None | UnsetType = _NEBIUS_UNSET, created_by: str | None | UnsetType = _NEBIUS_UNSET, finished_at: datetime | Timestamp | None | UnsetType = _NEBIUS_UNSET, request: Any | None | UnsetType = _NEBIUS_UNSET, request_headers: Mapping[str, Operation__request_header] | None | UnsetType = _NEBIUS_UNSET, resource_id: str | None | UnsetType = _NEBIUS_UNSET, resource: Any | None | UnsetType = _NEBIUS_UNSET, progress_data: Any | None | UnsetType = _NEBIUS_UNSET, status: RequestStatus | Status | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@created_at.setter
def created_at(self, value: datetime | Timestamp | None): (source)

Set or clear the generated created_at field.

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

Set or clear the generated created_by field.

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

Set or clear the generated description field.

@finished_at.setter
def finished_at(self, value: datetime | Timestamp | None): (source)

Set or clear the generated finished_at field.

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

Set or clear the generated id field.

@progress_data.setter
def progress_data(self, value: Any | None): (source)

Set or clear the generated progress_data field.

@request.setter
def request(self, value: Any | None): (source)

Set or clear the generated request field.

@request_headers.setter
def request_headers(self, value: Mapping[str, Operation__request_header] | None): (source)

Set or clear the generated request_headers field.

@resource.setter
def resource(self, value: Any | None): (source)

Set or clear the generated resource field.

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

Set or clear the generated resource_id field.

@status.setter
def status(self, value: RequestStatus | Status | None): (source)

Set or clear the generated status field.

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

Protobuf message descriptor from the registry.

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

Fully qualified protobuf message name.

Value
'nebius.common.v1alpha1.Operation'
__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
{'id': 'id',
 'description': 'description',
 'created_at': 'created_at',
 'created_by': 'created_by',
 'finished_at': 'finished_at',
 'request': 'request',
 'request_headers': 'request_headers',
...
@_NebiusProperty
created_at: datetime | None = (source)

Creation timestamp.

@_NebiusProperty
created_by: str = (source)

ID of the user or service account who initiated the operation.

@_NebiusProperty
description: str = (source)

Human readable description of the operation. 0-256 characters long.

@_NebiusProperty
finished_at: datetime | None = (source)

The time when the operation finished.

@_NebiusProperty
id: str = (source)

ID of the operation.

@_NebiusProperty
progress_data: Any = (source)

Additional information about the progress of an operation, e.g., a progress percentage. MAY be absent while the operation is running, MUST be absent after the operation has completed.

Format of message inside [progress_data] is service-dependent and MUST be documented by the service, IF it is used.

@_NebiusProperty
request: Any = (source)

The request that generated this operation.

@_NebiusProperty
request_headers: MutableMapping[str, Operation__request_header] = (source)

The request headers that are essential for the request that generated the operation. For instance, x-resetmask. Without these headers the request might have been processed differently if repeated. All the header names must be converted to lower case. Validator is based on: https://httpwg.org/specs/rfc9110.html#considerations.for.new.field.names

@_NebiusProperty
resource: Any = (source)

Snapshot of the resource at the moment this operation started.

  • [resource.spec] and [resource.metadata] reflect the desired resource state at the moment this operation started. E.g., in an Update operation it will be the updated resource spec and metadata, in a Create operation it will be the spec and metadata of the resource being created, and so on.
  • [resource.status] reflects the status of the resource at the moment this operation started. This is a snapshot, call the <Resource>Service/Get to get current status of the resource.

The [resource] field MUST never be updated after this operation has started.

In a Delete operation, an operation affecting multiple resources or an operation that doesn't affect any API resources at all (e.g. a routine maintenance operation visible to the user), the [resource] inside MUST be a [google.protobuf.Empty].

@_NebiusProperty
resource_id: str = (source)

ID of the resource that this operation creates, updates, deletes or otherwise changes.

If the operation affects multiple resources or does not affect any API resources at all (e.g. a routine maintenance operation visible to the user), the [resource_id] must be empty.

@_NebiusProperty
status: RequestStatus | None = (source)

The status of this operation. Set when this operation is completed. See https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto.

[status.code] is https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto:

  • If [status.code] == OK, the operation has completed successfully.
  • If [status.code] != OK, the operation has failed or has been cancelled.
    • [status.message] will contain a user-readable and actionable error message.
    • [status.details] will contain additional diagnostic information in the form of [ServiceError] from ../error/v1alpha1/error.proto
  • [status.code] must belong to an Operation-compatible subset of GRPC codes: OK, CANCELLED, PERMISSION_DENIED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, INTERNAL