blob: 8b2d9bfb0765aeebcf20300ae2538bfd946e3766 [file]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
// DO NOT EDIT IT MANUALLY. This file is generated by opendal/dev/src/generate/dotnet.rs.
using OpenDAL.ServiceConfig.Abstractions;
namespace OpenDAL.ServiceConfig
{
/// <summary>
/// Configuration for service oss.
/// </summary>
public sealed class OssServiceConfig : IServiceConfig
{
/// <summary>
/// Access key id for oss. - this field if it's `is_some` - env value: `ALIBABA_CLOUD_ACCESS_KEY_ID`
/// </summary>
public string? AccessKeyId { get; init; }
/// <summary>
/// Access key secret for oss. - this field if it's `is_some` - env value: `ALIBABA_CLOUD_ACCESS_KEY_SECRET`
/// </summary>
public string? AccessKeySecret { get; init; }
/// <summary>
/// Addressing style for oss.
/// </summary>
public string? AddressingStyle { get; init; }
/// <summary>
/// Allow anonymous for oss.
/// </summary>
[System.Obsolete("Please use SkipSignature instead of AllowAnonymous")]
public bool? AllowAnonymous { get; init; }
/// <summary>
/// Deprecated: OSS delete batch capability is enabled by default.
/// </summary>
[System.Obsolete("OSS delete batch capability is enabled by default. Use CapabilityOverrideLayer to override delete_max_size for specific endpoints.")]
public long? BatchMaxOperations { get; init; }
/// <summary>
/// Bucket for oss.
/// </summary>
public string? Bucket { get; init; }
/// <summary>
/// Deprecated: OSS delete batch capability is enabled by default.
/// </summary>
[System.Obsolete("OSS delete batch capability is enabled by default. Use CapabilityOverrideLayer to override delete_max_size for specific endpoints.")]
public long? DeleteMaxSize { get; init; }
/// <summary>
/// Deprecated: OSS versioning capability is enabled by default.
/// </summary>
[System.Obsolete("OSS versioning capability is enabled by default and this option is no longer needed.")]
public bool? EnableVersioning { get; init; }
/// <summary>
/// Endpoint for oss.
/// </summary>
public string? Endpoint { get; init; }
/// <summary>
/// external_id for this backend.
/// </summary>
public string? ExternalId { get; init; }
/// <summary>
/// `oidc_provider_arn` will be loaded from - this field if it's `is_some` - env value: `ALIBABA_CLOUD_OIDC_PROVIDER_ARN`
/// </summary>
public string? OidcProviderArn { get; init; }
/// <summary>
/// `oidc_token_file` will be loaded from - this field if it's `is_some` - env value: `ALIBABA_CLOUD_OIDC_TOKEN_FILE`
/// </summary>
public string? OidcTokenFile { get; init; }
/// <summary>
/// Pre sign addressing style for oss.
/// </summary>
public string? PresignAddressingStyle { get; init; }
/// <summary>
/// Presign endpoint for oss.
/// </summary>
public string? PresignEndpoint { get; init; }
/// <summary>
/// If `role_arn` is set, we will use already known config as source credential to assume role with `role_arn`. - this field if it's `is_some` - env value: `ALIBABA_CLOUD_ROLE_ARN`
/// </summary>
public string? RoleArn { get; init; }
/// <summary>
/// role_session_name for this backend.
/// </summary>
public string? RoleSessionName { get; init; }
/// <summary>
/// Root for oss.
/// </summary>
public string? Root { get; init; }
/// <summary>
/// `security_token` will be loaded from - this field if it's `is_some` - env value: `ALIBABA_CLOUD_SECURITY_TOKEN`
/// </summary>
public string? SecurityToken { get; init; }
/// <summary>
/// Server side encryption for oss.
/// </summary>
public string? ServerSideEncryption { get; init; }
/// <summary>
/// Server side encryption key id for oss.
/// </summary>
public string? ServerSideEncryptionKeyId { get; init; }
/// <summary>
/// Skip signature will skip loading credentials and signing requests.
/// </summary>
public bool? SkipSignature { get; init; }
/// <summary>
/// `sts_endpoint` will be loaded from - this field if it's `is_some` - env value: `ALIBABA_CLOUD_STS_ENDPOINT`
/// </summary>
public string? StsEndpoint { get; init; }
public string Scheme => "oss";
public IReadOnlyDictionary<string, string> ToOptions()
{
var map = new Dictionary<string, string>();
if (AccessKeyId is not null)
{
map["access_key_id"] = Utilities.ToOptionString(AccessKeyId);
}
if (AccessKeySecret is not null)
{
map["access_key_secret"] = Utilities.ToOptionString(AccessKeySecret);
}
if (AddressingStyle is not null)
{
map["addressing_style"] = Utilities.ToOptionString(AddressingStyle);
}
#pragma warning disable CS0618
if (AllowAnonymous is not null)
{
map["allow_anonymous"] = Utilities.ToOptionString(AllowAnonymous);
}
#pragma warning restore CS0618
#pragma warning disable CS0618
if (BatchMaxOperations is not null)
{
map["batch_max_operations"] = Utilities.ToOptionString(BatchMaxOperations);
}
#pragma warning restore CS0618
if (Bucket is not null)
{
map["bucket"] = Utilities.ToOptionString(Bucket);
}
#pragma warning disable CS0618
if (DeleteMaxSize is not null)
{
map["delete_max_size"] = Utilities.ToOptionString(DeleteMaxSize);
}
#pragma warning restore CS0618
#pragma warning disable CS0618
if (EnableVersioning is not null)
{
map["enable_versioning"] = Utilities.ToOptionString(EnableVersioning);
}
#pragma warning restore CS0618
if (Endpoint is not null)
{
map["endpoint"] = Utilities.ToOptionString(Endpoint);
}
if (ExternalId is not null)
{
map["external_id"] = Utilities.ToOptionString(ExternalId);
}
if (OidcProviderArn is not null)
{
map["oidc_provider_arn"] = Utilities.ToOptionString(OidcProviderArn);
}
if (OidcTokenFile is not null)
{
map["oidc_token_file"] = Utilities.ToOptionString(OidcTokenFile);
}
if (PresignAddressingStyle is not null)
{
map["presign_addressing_style"] = Utilities.ToOptionString(PresignAddressingStyle);
}
if (PresignEndpoint is not null)
{
map["presign_endpoint"] = Utilities.ToOptionString(PresignEndpoint);
}
if (RoleArn is not null)
{
map["role_arn"] = Utilities.ToOptionString(RoleArn);
}
if (RoleSessionName is not null)
{
map["role_session_name"] = Utilities.ToOptionString(RoleSessionName);
}
if (Root is not null)
{
map["root"] = Utilities.ToOptionString(Root);
}
if (SecurityToken is not null)
{
map["security_token"] = Utilities.ToOptionString(SecurityToken);
}
if (ServerSideEncryption is not null)
{
map["server_side_encryption"] = Utilities.ToOptionString(ServerSideEncryption);
}
if (ServerSideEncryptionKeyId is not null)
{
map["server_side_encryption_key_id"] = Utilities.ToOptionString(ServerSideEncryptionKeyId);
}
if (SkipSignature is not null)
{
map["skip_signature"] = Utilities.ToOptionString(SkipSignature);
}
if (StsEndpoint is not null)
{
map["sts_endpoint"] = Utilities.ToOptionString(StsEndpoint);
}
return map;
}
}
}