duplicati/Duplicati/Library/Backend/Backblaze/Model/ListFilesRequest.cs
2025-03-21 08:54:24 +01:00

58 lines
No EOL
2.4 KiB
C#

// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using Newtonsoft.Json;
namespace Duplicati.Library.Backend.Backblaze.Model;
/// <summary>
/// Represents a request to list files in a Backblaze B2 bucket.
/// Contains parameters for pagination and filtering of the file list.
/// </summary>
internal class ListFilesRequest : BucketIDEntity
{
/// <summary>
/// Gets or sets the file name to start listing from.
/// Used for pagination to continue listing from a specific point.
/// </summary>
[JsonProperty("startFileName", NullValueHandling = NullValueHandling.Ignore)]
public string? StartFileName { get; set; }
/// <summary>
/// Gets or sets the file ID to start listing from.
/// Used in conjunction with StartFileName for pagination.
/// </summary>
[JsonProperty("startFileId", NullValueHandling = NullValueHandling.Ignore)]
public string? StartFileID { get; set; }
/// <summary>
/// Gets or sets the maximum number of files to return in a single request.
/// </summary>
[JsonProperty("maxFileCount")]
public long MaxFileCount { get; set; }
/// <summary>
/// Gets or sets the prefix to filter files by.
/// Only files whose names begin with this prefix will be returned.
/// </summary>
[JsonProperty("prefix")]
public required string Prefix { get; set; }
}