ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

orionis.foundation.config.filesystems.GCS

class documentation

class GCS(BaseEntity): (source)

View In Hierarchy

Represent a Google Cloud Storage configuration.

Using this disk requires the official Google Cloud client library, which is an optional dependency: install it with uv add 'orionis[gcs]'.

Parameters
driverThe filesystem driver name. Built-in names are "gcs" and "google".
project_idGoogle Cloud project identifier.
key_filePath to the service-account JSON key file. When omitted, Application Default Credentials are used.
bucketThe GCS bucket name.
urlPublic base URL used to build file URLs.
Returns
NoneThis class does not return a value.
Method __post_init__ Validate the types of the GCS entity attributes.
Class Variable bucket Undocumented
Class Variable driver Undocumented
Class Variable key_file Undocumented
Class Variable project_id Undocumented
Class Variable url Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
def __post_init__(self): (source)
overrides orionis.support.entities.BaseEntity.__post_init__

Validate the types of the GCS entity attributes.

Parameters
None
Returns
NoneThis method does not return a value.
Raises
TypeErrorIf any attribute is of the wrong type.
bucket: str = (source)

Undocumented

driver: str, default "gcs" = (source)

Undocumented

key_file: str | None, default None = (source)

Undocumented

project_id: str = (source)

Undocumented

url: str | None, default None = (source)

Undocumented