const (
    StorageBackendEnvVar = "STORAGE_BACKEND"
    PachRootEnvVar       = "PACH_ROOT"
)

const (
    Minio     = "MINIO"
    Amazon    = "AMAZON"
    Google    = "GOOGLE"
    Microsoft = "MICROSOFT"
    Local     = "LOCAL"
)

const (
    GoogleBucketEnvVar = "GOOGLE_BUCKET"
    GoogleCredEnvVar   = "GOOGLE_CRED"
)

const (
    MicrosoftContainerEnvVar = "MICROSOFT_CONTAINER"
    MicrosoftIDEnvVar        = "MICROSOFT_ID"
    MicrosoftSecretEnvVar    = "MICROSOFT_SECRET"
)

const (
    MinioBucketEnvVar    = "MINIO_BUCKET"
    MinioEndpointEnvVar  = "MINIO_ENDPOINT"
    MinioIDEnvVar        = "MINIO_ID"
    MinioSecretEnvVar    = "MINIO_SECRET"
    MinioSecureEnvVar    = "MINIO_SECURE"
    MinioSignatureEnvVar = "MINIO_SIGNATURE"
)

const (
    AmazonRegionEnvVar       = "AMAZON_REGION"
    AmazonBucketEnvVar       = "AMAZON_BUCKET"
    AmazonIDEnvVar           = "AMAZON_ID"
    AmazonSecretEnvVar       = "AMAZON_SECRET"
    AmazonTokenEnvVar        = "AMAZON_TOKEN"
    AmazonVaultAddrEnvVar    = "AMAZON_VAULT_ADDR"
    AmazonVaultRoleEnvVar    = "AMAZON_VAULT_ROLE"
    AmazonVaultTokenEnvVar   = "AMAZON_VAULT_TOKEN"
    AmazonDistributionEnvVar = "AMAZON_DISTRIBUTION"
    CustomEndpointEnvVar     = "CUSTOM_ENDPOINT"
)

const (
    RetriesEnvVar        = "RETRIES"
    TimeoutEnvVar        = "TIMEOUT"
    UploadACLEnvVar      = "UPLOAD_ACL"
    ReverseEnvVar        = "REVERSE"
    PartSizeEnvVar       = "PART_SIZE"
    MaxUploadPartsEnvVar = "MAX_UPLOAD_PARTS"
)

const (
    // DefaultRetries is the default number of retries for object storage requests.
    DefaultRetries = 10
    // DefaultTimeout is the default timeout for object storage requests.
    DefaultTimeout = "5m"
    // DefaultUploadACL is the default upload ACL for object storage uploads.
    DefaultUploadACL = "bucket-owner-full-control"
    // DefaultReverse is the default for whether to reverse object storage paths or not.
    DefaultReverse = true
    // DefaultPartSize is the default part size for object storage uploads.
    DefaultPartSize = 5242880
    // DefaultMaxUploadParts is the default maximum number of upload parts.
    DefaultMaxUploadParts = 10000
)

var EnvVarToSecretKey = map[string]string{
    GoogleBucketEnvVar:       "google-bucket",
    GoogleCredEnvVar:         "google-cred",
    MicrosoftContainerEnvVar: "microsoft-container",
    MicrosoftIDEnvVar:        "microsoft-id",
    MicrosoftSecretEnvVar:    "microsoft-secret",
    MinioBucketEnvVar:        "minio-bucket",
    MinioEndpointEnvVar:      "minio-endpoint",
    MinioIDEnvVar:            "minio-id",
    MinioSecretEnvVar:        "minio-secret",
    MinioSecureEnvVar:        "minio-secure",
    MinioSignatureEnvVar:     "minio-signature",
    AmazonRegionEnvVar:       "amazon-region",
    AmazonBucketEnvVar:       "amazon-bucket",
    AmazonIDEnvVar:           "amazon-id",
    AmazonSecretEnvVar:       "amazon-secret",
    AmazonTokenEnvVar:        "amazon-token",
    AmazonVaultAddrEnvVar:    "amazon-vault-addr",
    AmazonVaultRoleEnvVar:    "amazon-vault-role",
    AmazonVaultTokenEnvVar:   "amazon-vault-token",
    AmazonDistributionEnvVar: "amazon-distribution",
    CustomEndpointEnvVar:     "custom-endpoint",
    RetriesEnvVar:            "retries",
    TimeoutEnvVar:            "timeout",
    UploadACLEnvVar:          "upload-acl",
    ReverseEnvVar:            "reverse",
    PartSizeEnvVar:           "part-size",
    MaxUploadPartsEnvVar:     "max-upload-parts",
}

type AmazonAdvancedConfiguration struct {
    Retries int    `env:"RETRIES, default=10"`
    Timeout string `env:"TIMEOUT, default=5m"`
    // By default, objects uploaded to a bucket are only accessible to the
    // uploader, and not the owner of the bucket. Using the default ensures that
    // the owner of the bucket can access the objects as well.
    UploadACL      string `env:"UPLOAD_ACL, default=bucket-owner-full-control"`
    Reverse        bool   `env:"REVERSE, default=true"`
    PartSize       int64  `env:"PART_SIZE, default=5242880"`
    MaxUploadParts int    `env:"MAX_UPLOAD_PARTS, default=10000"`
}

type AmazonCreds struct {
    // Direct credentials. Only applicable if Pachyderm is given its own permanent
    // AWS credentials
    ID     string // Access Key ID
    Secret string // Secret Access Key
    Token  string // Access token (if using temporary security credentials

    // Vault options (if getting AWS credentials from Vault)
    VaultAddress string // normally addresses come from env, but don't have vault service name
    VaultRole    string
    VaultToken   string
}

type BackoffReadCloser struct {
    // contains filtered or unexported fields
}

type BackoffWriteCloser struct {
    // contains filtered or unexported fields
}

type Client interface {
    // Writer returns a writer which writes to an object.
    // It should error if the object already exists or we don't have sufficient
    // permissions to write it.
    Writer(ctx context.Context, name string) (io.WriteCloser, error)
    // Reader returns a reader which reads from an object.
    // If `size == 0`, the reader should read from the offset till the end of the object.
    // It should error if the object doesn't exist or we don't have sufficient
    // permission to read it.
    Reader(ctx context.Context, name string, offset uint64, size uint64) (io.ReadCloser, error)
    // Delete deletes an object.
    // It should error if the object doesn't exist or we don't have sufficient
    // permission to delete it.
    Delete(ctx context.Context, name string) error
    // Walk calls `fn` with the names of objects which can be found under `prefix`.
    Walk(ctx context.Context, prefix string, fn func(name string) error) error
    // Exsits checks if a given object already exists
    Exists(ctx context.Context, name string) bool
    // IsRetryable determines if an operation should be retried given an error
    IsRetryable(err error) bool
    // IsNotExist returns true if err is a non existence error
    IsNotExist(err error) bool
    // IsIgnorable returns true if the error can be ignored
    IsIgnorable(err error) bool
}

type ObjectStoreURL struct {
    // The object store, e.g. s3, gcs, as...
    Store string
    // The "bucket" (in AWS parlance) or the "container" (in Azure parlance).
    Bucket string
    // The object itself.
    Object string
}

type RetryError struct {
    Err               string
    TimeTillNextRetry string
    BytesProcessed    int
}