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

    Interface TransferSpec

    Represents the nebius.storage.v1.TransferSpec protobuf message.

    interface TransferSpec {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.storage.v1.TransferSpec";
        destination?: TransferDestination;
        enableDeletesInDestination: boolean;
        interIterationInterval?: Duration;
        limiters?: TransferSpec_Limiters;
        overwriteStrategy: TransferSpec_OverwriteStrategy;
        source?: TransferSource;
        stopCondition?:
            | {
                $case: "afterOneIteration";
                afterOneIteration: TransferSpec_StopConditionAfterOneIteration;
            }
            | {
                $case: "afterNEmptyIterations";
                afterNEmptyIterations: TransferSpec_StopConditionAfterNEmptyIterations;
            }
            | { $case: "infinite"; infinite: TransferSpec_StopConditionInfinite };
        touchUnmanaged: boolean;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

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

      Represents the nebius.storage.v1.TransferSpec protobuf message.

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

          • Represents the nebius.storage.v1.TransferSpec protobuf message.

            Returns unknown

      • undefined
    Index
    [customJson]? [unknownFieldsSymbol]? $type destination? enableDeletesInDestination interIterationInterval? limiters? overwriteStrategy source? stopCondition? touchUnmanaged
    "[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.storage.v1.TransferSpec"

    Contains the fully qualified protobuf type name.

    destination?: TransferDestination

    Destination to which the transfer writes data.

    enableDeletesInDestination: boolean

    If enable_deletes_in_destination flag is set, service will delete objects that exist in destination, but don't exist in source. If touch_unmanaged flag isn't set, we do not delete objects that haven't been created by Data Transfer service.

    interIterationInterval?: Duration

    The time to wait since the previous iteration before starting the next one. Default is 15 minutes if not specified.

    limiters?: TransferSpec_Limiters

    Limiters applied to source bucket operations. These limits include all operations required for transfer (HeadObject, GetObject, ListObjects). For details about which operations are used, see public documentation: http://docs.nebius.com/object-storage/transfer/quickstart#background.

    Note: Since the service performs comparable request volumes and data transfers to both source and destination, these limits will indirectly constrain destination operations as well.

    overwriteStrategy: TransferSpec_OverwriteStrategy

    Overwrite strategy set logic of overwrite already existed objects in destination bucket.

    source?: TransferSource

    Source from which the transfer reads data.

    stopCondition?:
        | {
            $case: "afterOneIteration";
            afterOneIteration: TransferSpec_StopConditionAfterOneIteration;
        }
        | {
            $case: "afterNEmptyIterations";
            afterNEmptyIterations: TransferSpec_StopConditionAfterNEmptyIterations;
        }
        | { $case: "infinite"; infinite: TransferSpec_StopConditionInfinite }

    The stop condition is checked after every iteration. If the condition is met, the transfer will stop.

    Type Declaration

    touchUnmanaged: boolean

    If touch_unmanaged flag is set, service will be allowed to overwrite and delete from destination objects that were not created by Data Transfer Service. If this flag is false, Data Transfer Service will never overwrite or delete objects that haven't been created by Data Transfer service.

    Settings
    Member Visibility

    On This Page
    Properties