26.19. Class Gcs

Namespace: ArmoniK.Core.Adapters.Gcs.Options
Assembly: ArmoniK.Core.Adapters.Gcs.dll

Represents the configuration settings for connecting to Google Cloud Storage.

[ExtractDocumentation("Options for Gcs")]
public class Gcs

26.19.1. Inheritance

objectGcs

26.19.2. Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

26.19.3. Fields

26.19.3.1. SettingSection

The name of the configuration section for Gcs Object Storage settings.

public const string SettingSection = "Gcs"

26.19.3.1.1. Field Value

string

26.19.4. Properties

26.19.4.1. BucketName

Name of the bucket that the application will read from and write to.

public string BucketName { get; set; }

26.19.4.1.1. Property Value

string

26.19.4.2. ChunkDownloadSize

Size of one chunk when downloading an object by chunks

public int ChunkDownloadSize { get; set; }

26.19.4.2.1. Property Value

int

26.19.4.3. CredentialsFilePath

Path to a service-account JSON credentials file. When empty, Application Default Credentials are used.

public string CredentialsFilePath { get; set; }

26.19.4.3.1. Property Value

string

26.19.4.4. DegreeOfParallelism

Number of tasks to be used in parallel execution (deletes, metadata lookups).

public int DegreeOfParallelism { get; set; }

26.19.4.4.1. Property Value

int

26.19.4.5. EmulatorEndpoint

Custom base URI used to target an emulator (e.g. fake-gcs-server). When empty, the real Google Cloud Storage endpoint is used.

public string EmulatorEndpoint { get; set; }

26.19.4.5.1. Property Value

string

26.19.4.6. MaxRetry

Number of retry in case of a connection error

public int MaxRetry { get; set; }

26.19.4.6.1. Property Value

int

26.19.4.7. MsAfterRetry

Delay in milliseconds after an error

public int MsAfterRetry { get; set; }

26.19.4.7.1. Property Value

int

26.19.4.8. ProjectId

Google Cloud project identifier owning the bucket.

public string ProjectId { get; set; }

26.19.4.8.1. Property Value

string