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.

class documentation

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]'.

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

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate the types of the GCS entity attributes.

Returns
NoneThis method does not return a value.
Raises
TypeErrorIf any attribute is of the wrong type.

The GCS bucket name.

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

The filesystem driver name. Built-in names are "gcs" and "google".

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

Path to the service-account JSON key file. When omitted, Application Default Credentials are used.

project_id: str = (source)

Google Cloud project identifier.

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

Public base URL used to build file URLs.