@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface Operation

    Represents the nebius.common.v1.Operation protobuf message.

    interface Operation {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.common.v1.Operation";
        createdAt?: Dayjs;
        createdBy: string;
        description: string;
        finishedAt?: Dayjs;
        id: string;
        progressData?: { typeUrl: string; value: Uint8Array };
        progressTracker?: ProgressTracker;
        request?: { typeUrl: string; value: Uint8Array };
        requestHeaders: { [key: string]: Operation_RequestHeader };
        resourceId: string;
        status?: Status;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined

      Represents the nebius.common.v1.Operation protobuf message.

      • Uint8Array<ArrayBufferLike>
      • () => unknown
          • (): unknown

          • Represents the nebius.common.v1.Operation protobuf message.

            Returns unknown

      • undefined
    Index
    [customJson]? [unknownFieldsSymbol]? $type createdAt? createdBy description finishedAt? id progressData? progressTracker? request? requestHeaders resourceId status?
    "[customJson]"?: () => unknown

    Returns a safe value for JSON logs.

    Type Declaration

      • (): unknown

      • Returns a safe value for JSON logs.

        Returns unknown

    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>

    Preserves protobuf fields that this SDK version does not recognize.

    $type: "nebius.common.v1.Operation"

    Contains the fully qualified protobuf type name.

    createdAt?: Dayjs

    Creation timestamp.

    createdBy: string

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

    description: string

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

    finishedAt?: Dayjs

    The time when the operation has finished.

    id: string

    ID of the operation.

    progressData?: { typeUrl: string; value: Uint8Array }

    Extra information about this operation's progress. MAY be absent while the operation is running, MUST be absent after the operation has completed.

    Type of message that's stored inside [progress_data] is service-dependent.

    Type Declaration

    • typeUrl: string

      Contains the type URL.

    • value: Uint8Array

      Contains the value.

    progressTracker?: ProgressTracker

    Information about this operation's progress, if this operation tracks its progress. If the operation tracks its progress, progress_tracker MUST be present both while the operation is running and after it has been completed.

    request?: { typeUrl: string; value: Uint8Array }

    The request that generated this operation.

    Type Declaration

    • typeUrl: string

      Contains the type URL.

    • value: Uint8Array

      Contains the value.

    requestHeaders: { [key: string]: Operation_RequestHeader }

    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

    Type Declaration

    resourceId: string

    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.

    status?: 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.

    [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 nebius/common/v1/error.proto
    • [status.code] must belong to an Operation-compatible subset of GRPC codes: OK, CANCELLED, PERMISSION_DENIED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, INTERNAL

    Settings
    Member Visibility

    On This Page
    Properties