Google Cloud Storage

rustac.store.GCSStore

Interface to Google Cloud Storage.

All constructors will check for environment variables. Refer to GCSConfig for valid environment variables.

If no credentials are explicitly provided, they will be sourced from the environment as documented here.

client_options property

client_options: ClientConfig | None

Get the store's client configuration.

config property

config: GCSConfig

Get the underlying GCS config parameters.

credential_provider property

credential_provider: GCSCredentialProvider | None

Get the store's credential provider.

prefix property

prefix: str | None

Get the prefix applied to all operations in this store, if any.

retry_config property

retry_config: RetryConfig | None

Get the store's retry configuration.

__init__

__init__(
    bucket: str | None = None,
    *,
    prefix: str | None = None,
    config: GCSConfig | None = None,
    client_options: ClientConfig | None = None,
    retry_config: RetryConfig | None = None,
    credential_provider: GCSCredentialProvider | None = None,
    **kwargs: Unpack[GCSConfig],
) -> None

Construct a new GCSStore.

Parameters:

• bucket (str | None, default: None ) –

  The GCS bucket to use.

Other Parameters:

• prefix (str | None) –

  A prefix within the bucket to use for all operations.

• config (GCSConfig | None) –

  GCS Configuration. Values in this config will override values inferred from the environment. Defaults to None.

• client_options (ClientConfig | None) –

  HTTP Client options. Defaults to None.

• retry_config (RetryConfig | None) –

  Retry configuration. Defaults to None.

• credential_provider (GCSCredentialProvider | None) –

  A callback to provide custom Google credentials.

• kwargs (Unpack[GCSConfig]) –

  GCS configuration values. Supports the same values as config, but as named keyword args.

Returns:

• None –

  GCSStore

from_url classmethod

from_url(
    url: str,
    *,
    prefix: str | None = None,
    config: GCSConfig | None = None,
    client_options: ClientConfig | None = None,
    retry_config: RetryConfig | None = None,
    credential_provider: GCSCredentialProvider | None = None,
    **kwargs: Unpack[GCSConfig],
) -> Self

Construct a new GCSStore with values populated from a well-known storage URL.

Any path on the URL will be assigned as the prefix for the store. So if you pass gs://<bucket>/path/to/directory, the store will be created with a prefix of path/to/directory, and all further operations will use paths relative to that prefix.

The supported url schemes are:

• gs://<bucket>/<path>

Parameters:

• url (str) –

  well-known storage URL.

Other Parameters:

• prefix (str | None) –

  A prefix within the bucket to use for all operations.

• config (GCSConfig | None) –

  GCS Configuration. Values in this config will override values inferred from the url. Defaults to None.

• client_options (ClientConfig | None) –

  HTTP Client options. Defaults to None.

• retry_config (RetryConfig | None) –

  Retry configuration. Defaults to None.

• credential_provider (GCSCredentialProvider | None) –

  A callback to provide custom Google credentials.

• kwargs (Unpack[GCSConfig]) –

  GCS configuration values. Supports the same values as config, but as named keyword args.

Returns:

• Self –

  GCSStore

rustac.store.GCSConfig

Bases: TypedDict

Configuration parameters for GCSStore.

Not importable at runtime

To use this type hint in your code, import it within a TYPE_CHECKING block:

from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from obstore.store import GCSConfig

application_credentials instance-attribute

application_credentials: str

Application credentials path.

See https://cloud.google.com/docs/authentication/provide-credentials-adc.

Environment variable: GOOGLE_APPLICATION_CREDENTIALS.

bucket instance-attribute

bucket: str

Bucket name. (required)

Environment variables:

• GOOGLE_BUCKET
• GOOGLE_BUCKET_NAME

service_account instance-attribute

service_account: str

Path to the service account file.

This or service_account_key must be set.

Example value "/tmp/gcs.json". Example contents of gcs.json:

{
   "gcs_base_url": "https://localhost:4443",
   "disable_oauth": true,
   "client_email": "",
   "private_key": ""
}

Environment variables:

• GOOGLE_SERVICE_ACCOUNT
• GOOGLE_SERVICE_ACCOUNT_PATH

service_account_key instance-attribute

service_account_key: str

The serialized service account key.

The service account must be in the JSON format. This or with_service_account_path must be set.

Environment variable: GOOGLE_SERVICE_ACCOUNT_KEY.

skip_signature instance-attribute

skip_signature: bool

If True, GCSStore will not fetch credentials and will not sign requests.

This can be useful when interacting with public GCS buckets that deny authorized requests.

Environment variable: GOOGLE_SKIP_SIGNATURE.

rustac.store.GCSCredential

Bases: TypedDict

A Google Cloud Storage Credential.

Not importable at runtime

To use this type hint in your code, import it within a TYPE_CHECKING block:

from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from obstore.store import GCSCredential

expires_at instance-attribute

expires_at: datetime | None

Expiry datetime of credential. The datetime should have time zone set.

If None, the credential will never expire.

token instance-attribute

token: str

An HTTP bearer token.

rustac.store.GCSCredentialProvider

Bases: Protocol

A type hint for a synchronous or asynchronous callback to provide custom Google Cloud Storage credentials.

This should be passed into the credential_provider parameter of GCSStore.

Not importable at runtime

To use this type hint in your code, import it within a TYPE_CHECKING block:

from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from obstore.store import GCSCredentialProvider

__call__

__call__() -> GCSCredential | Coroutine[Any, Any, GCSCredential]

Return a GCSCredential.