frostfs-sdk-csharp/src/FrostFS.SDK.ClientV2/Parameters/PrmObjectPut.cs

using System.IO;

namespace FrostFS.SDK.ClientV2;

public sealed class PrmObjectPut(CallContext? ctx = null) : PrmBase(ctx), ISessionToken
{
    /// <summary>
    /// Need to provide values like <c>ContainerId</c> and <c>ObjectType</c> to create and object.
    /// Optional parameters ike <c>Attributes</c> can be provided as well.
    /// </summary>
    /// <value>Header with required parameters to create an object</value>
    public FrostFsObjectHeader? Header { get; set; }

    /// <summary>
    /// A stream with source data
    /// </summary>
    public Stream? Payload { get; set; }

    /// <summary>
    /// Object size is limited. In the data exceeds the limit, the object will be splitted.
    /// If the parameter is <c>true</c>, the client side cut is applied. Otherwise, the data is transferred
    /// as a stream and will be cut on server side.
    /// </summary>
    /// <value>Is client cut is applied</value>
    public bool ClientCut { get; set; }

    /// <summary>
    /// Overrides default size of the buffer for stream transferring.
    /// </summary>
    /// <value>Size of the buffer</value>
    public int BufferMaxSize { get; set; }

    /// <summary>
    /// Allows to define a buffer for chunks to manage by the memory allocation and releasing.
    /// </summary>
    public byte[]? CustomBuffer { get; set; }

    /// <inheritdoc />
    public FrostFsSessionToken? SessionToken { get; set; }

    internal int MaxObjectSizeCache { get; set; }

    internal ulong CurrentStreamPosition { get; set; }

    internal ulong FullLength { get; set; }
}