26.87. Class S3
Namespace: ArmoniK.Core.Adapters.S3.Options
Assembly: ArmoniK.Core.Adapters.S3.dll
Represents the configuration settings for connecting to AWS S3 object storage service.
[ExtractDocumentation("Options for S3")]
public class S3
26.87.1. Inheritance
26.87.2. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
26.87.3. Fields
26.87.3.1. SettingSection
The name of the configuration section for S3 Object Storage settings.
public const string SettingSection = "S3"
26.87.3.1.1. Field Value
26.87.4. Properties
26.87.4.1. BucketName
Name of the S3 bucket that the application will interact with. Default is an empty string.
public string BucketName { get; set; }
26.87.4.1.1. Property Value
26.87.4.2. ChunkDownloadSize
Size of one chunk when downloading an object by chunks
public int ChunkDownloadSize { get; set; }
26.87.4.2.1. Property Value
26.87.4.3. DegreeOfParallelism
Number of tasks to be used in parallel execution
public int DegreeOfParallelism { get; set; }
26.87.4.3.1. Property Value
26.87.4.4. EndpointUrl
Endpoint URL of the S3 bucket. Default is an empty string.
public string EndpointUrl { get; set; }
26.87.4.4.1. Property Value
26.87.4.5. Login
Login credential for accessing the S3 service. Default is an empty string.
public string Login { get; set; }
26.87.4.5.1. Property Value
26.87.4.6. MaxRetry
Number of retry in case of a connection error
public int MaxRetry { get; set; }
26.87.4.6.1. Property Value
26.87.4.7. MsAfterRetry
Delay in milliseconds after an error
public int MsAfterRetry { get; set; }
26.87.4.7.1. Property Value
26.87.4.8. MustForcePathStyle
Boolean property to indicate whether path-style access should be enforced when connecting to the S3 service. Defaults to false.
public bool MustForcePathStyle { get; set; }
26.87.4.8.1. Property Value
26.87.4.9. Password
Password associated with the login for S3 access. Default is an empty string.
public string Password { get; set; }
26.87.4.9.1. Property Value
26.87.4.10. UseChecksum
If true, checksum will be verified by the client during upload
public bool UseChecksum { get; set; }
26.87.4.10.1. Property Value
26.87.4.11. UseChunkEncoding
Use Chunk Encoding during upload Should be disabled for GCS
public bool UseChunkEncoding { get; set; }
26.87.4.11.1. Property Value
26.87.5. Methods
26.87.5.1. Confidential()
Get a copy of the options with confidential fields removed
public S3 Confidential()
26.87.5.1.1. Returns
Confidential copy