Skip to content

CloudOptions ​

Namespace: Polars.FSharp

Properties & Indexers ​

PropertyTypeDescription
CacheTTLuint64-
CredentialsMap<string, string>-
DefaultCloudOptions-
ProviderCloudProvider-
Retriesuint32-
RetryInitBackoffMsuint64-
RetryMaxBackoffMsuint64-
RetryTimeoutMsuint64-

Constructors & Static Methods ​

new ​

fsharp
new(
    provider: CloudProvider,
    credentials: Map<string, string>,
    retries: uint32,
    retryTimeoutMs: uint64,
    retryInitBackoffMs: uint64,
    retryMaxBackoffMs: uint64,
    cacheTTL: uint64
) : CloudOptions

Parameters

NameTypeDescription
providerCloudProvider-
credentialsMap<string, string>-
retriesuint32-
retryTimeoutMsuint64-
retryInitBackoffMsuint64-
retryMaxBackoffMsuint64-
cacheTTLuint64-

Aws ​

AWS S3

fsharp
static member Aws(
    bucket: string,
    region: string,
    ?accessKey: string,
    ?secretKey: string,
    ?sessionToken: string,
    ?endpoint: string,
    ?allowHttp: bool
) : CloudOptions

Parameters

NameTypeDescription
bucketstring-
regionstring-
accessKeystring (optional)-
secretKeystring (optional)-
sessionTokenstring (optional)-
endpointstring (optional)-
allowHttpbool (optional)-

Azure ​

Azure Blob Storage

fsharp
static member Azure(
    accountName: string,
    ?accessKey: string,
    ?container: string,
    ?endpoint: string,
    ?allowHttp: bool
) : CloudOptions

Parameters

NameTypeDescription
accountNamestring-
accessKeystring (optional)-
containerstring (optional)-
endpointstring (optional)-
allowHttpbool (optional)-

Gcp ​

Google Cloud Storage

fsharp
static member Gcp(?serviceAccountPath: string, ?bucket: string) : CloudOptions

Parameters

NameTypeDescription
serviceAccountPathstring (optional)-
bucketstring (optional)-

Http ​

HTTP

fsharp
static member Http(?headers: Map<string, string>) : CloudOptions

Parameters

NameTypeDescription
headersMap<string, string> (optional)-

HuggingFace ​

Hugging Face

fsharp
static member HuggingFace(?token: string) : CloudOptions

Parameters

NameTypeDescription
tokenstring (optional)-

ParseCloudOptions ​

Internal helper to parse CloudOptions into native FFI primitives.

fsharp
static member ParseCloudOptions(cloudOptions: CloudOptions option) : (PlCloudProvider * UIntPtr * uint64 * uint64 * uint64 * uint64 * string[] * string[])

Parameters

NameTypeDescription
cloudOptionsCloudOptions option-

Instance Methods ​

CompareTo ​

fsharp
member CompareTo(obj: CloudOptions) : int
member CompareTo(obj: obj) : int
member CompareTo(obj: obj, comp: IComparer) : int

Parameters

NameTypeDescription
objCloudOptions / obj-
compIComparer-

Released under the MIT License. Powered by the Polars Rust core & Apache Arrow.