nebius.api.nebius.common.v1alpha1.Operation

class documentation

class Operation(pb_classes.Message): (source)

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

Undocumented

Class	`request_header`	Request header is a container for all the values of a particular header of a request as there is no such thing as map<string, repeated string>
Class	`RequestHeadersEntry`	Undocumented
Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`created_at.setter`	Undocumented
Method	`created_by.setter`	Undocumented
Method	`description.setter`	Undocumented
Method	`finished_at.setter`	Undocumented
Method	`id.setter`	Undocumented
Method	`progress_data.setter`	Undocumented
Method	`request.setter`	Undocumented
Method	`request_headers.setter`	Undocumented
Method	`resource.setter`	Undocumented
Method	`resource_id.setter`	Undocumented
Method	`status.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
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	`get_descriptor`	Return the protobuf descriptor for this message class.
Class Method	`is_credentials`	Return True if the field contains credentials.
Class Method	`is_sensitive`	Return True if the field is marked as sensitive.
Method	`__repr__`	Return a human-readable representation of the message, sanitizing sensitive fields.
Method	`check_presence`	Check explicit presence for a field in the protobuf message.
Method	`get_full_update_reset_mask`	Build a reset mask for a full update of this message.
Method	`get_mask`	Return the tracked reset mask.
Method	`is_default`	Return True if a field equals its default value.
Method	`set_mask`	Replace the tracked reset mask.
Method	`which_field_in_oneof`	Return the set field name for a given oneof.
Instance Variable	`__PB2_CLASS__`	Protobuf message class associated with this wrapper.
Instance Variable	`__pb2_message__`	Underlying protobuf message instance.
Method	`_clear_field`	Clear a field and record it in the reset mask.
Method	`_get_field`	Return a field value with optional wrapping and presence handling.
Method	`_set_field`	Set a field value and update the reset mask.
Class Variable	`__credentials_fields`	Undocumented
Class Variable	`__default`	Undocumented
Class Variable	`__sensitive_fields`	Undocumented
Instance Variable	`__recorded_reset_mask`	Mask tracking fields cleared or set to default.

def __dir__(self) -> abc.Iterable[builtins.str]: (source) ¶

Undocumented

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

@request_headers.setter
def request_headers(self, value: abc.Mapping[builtins.str, Operation.request_header] | None): (source) ¶

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.common.v1alpha1.Oper↵
ation',
                                                   operation_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)

__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value

{'id': 'id',
 'description': 'description',
 'created_at': 'created_at',
 'created_by': 'created_by',
 'finished_at': 'finished_at',
 'request': 'request',
 'request_headers': 'request_headers',
...

__mask_functions__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
created_at: datetime.datetime = (source) ¶

Creation timestamp.

@builtins.property
created_by: builtins.str = (source) ¶

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

@builtins.property
description: builtins.str = (source) ¶

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

@builtins.property
finished_at: datetime.datetime = (source) ¶

The time when the operation finished.

@builtins.property
id: builtins.str = (source) ¶

ID of the operation.

@builtins.property
progress_data: any_pb2.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.

@builtins.property
request: any_pb2.Any = (source) ¶

The request that generated this operation.

@builtins.property
request_headers: abc.MutableMapping[builtins.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

@builtins.property
resource: any_pb2.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].

@builtins.property
resource_id: builtins.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.

@builtins.property
status: request_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