Configuration
APROC Configuration
ProcessSettings
pydantic-model
Bases: BaseModel
Fields:
-
name(str | None) -
class_name(str | None) -
configuration(dict | None)
class_name
pydantic-field
Name of the process class
configuration
pydantic-field
Configuration that is specific the process (dictionary key/value)
name
pydantic-field
Name of the process
Settings
pydantic-model
Bases: BaseModel
Fields:
-
celery_broker_url(str | None) -
celery_result_backend(str | None) -
processes(list[ProcessSettings]) -
airs_endpoint(str | None) -
access_manager(AccessManagerSettings)
access_manager
pydantic-field
Configuration for the AccessManager
airs_endpoint
pydantic-field
ARLAS Item Registration Service endpoint
celery_broker_url
pydantic-field
Celery's broker url of the form of transport://userid:password@hostname:port/virtual_host
celery_result_backend
pydantic-field
Celery's backend used to store task results
processes
pydantic-field
List of APROC processes
AccessManager Configuration
AccessManagerSettings
pydantic-model
FileStorageConfiguration
pydantic-model
Bases: StorageConfiguration
Fields:
-
type(Literal['file']) -
is_local(Literal[True]) -
writable_paths(list[str]) -
readable_paths(list[str])
is_local = True
pydantic-field
Whether the storage is local or remote
readable_paths = []
pydantic-field
List of paths from which files can be read
type = 'file'
pydantic-field
Indicates the storage type, fixed to 'file'
writable_paths = []
pydantic-field
List of paths where files can be written
GoogleStorageApiKey
pydantic-model
Bases: BaseModel
Fields:
-
type(Literal['service_account']) -
project_id(str) -
private_key_id(str) -
private_key(str) -
client_email(str) -
client_id(str | None) -
auth_uri(Literal[AUTH_URI]) -
token_uri(Literal[TOKEN_URI]) -
auth_provider_x509_cert_url(Literal[AUTH_PROVIDER_CERT_URL]) -
universe_domain(Literal[UNIVERSE_DOMAIN])
auth_provider_x509_cert_url = GoogleStorageConstants.AUTH_PROVIDER_CERT_URL.value
pydantic-field
URL for the provider's X.509 certificate
auth_uri = GoogleStorageConstants.AUTH_URI.value
pydantic-field
OAuth2 auth endpoint URI
client_email
pydantic-field
Service account email address
client_id = None
pydantic-field
Optional client ID of the service account
private_key
pydantic-field
The private key content in PEM format
private_key_id
pydantic-field
ID of the private key used for authentication
project_id
pydantic-field
Google Cloud project identifier
token_uri = GoogleStorageConstants.TOKEN_URI.value
pydantic-field
OAuth2 token endpoint URI
type = 'service_account'
pydantic-field
Must be 'service_account'.
universe_domain = GoogleStorageConstants.UNIVERSE_DOMAIN.value
pydantic-field
Domain of the target universe (typically 'googleapis.com')
GoogleStorageConfiguration
pydantic-model
Bases: StorageConfiguration
Fields:
-
type(Literal['gs']) -
is_local(Literal[False]) -
bucket(str) -
api_key(GoogleStorageApiKey | None)
api_key = None
pydantic-field
API key for storage authentication
bucket
pydantic-field
Name of the Google Cloud Storage bucket
is_local = False
pydantic-field
Whether the storage is local or remote
type = 'gs'
pydantic-field
Indicates the storage type, fixed to 'gs'
HttpStorageConfiguration
pydantic-model
Bases: StorageConfiguration
Fields:
-
type(Literal['http']) -
is_local(Literal[False]) -
headers(dict[str, str]) -
domain(str) -
force_download(bool)
domain
pydantic-field
Domain used for HTTP storage endpoint, e.g. 'example.com'
force_download = False
pydantic-field
If true, always download the file instead of caching.
headers = {}
pydantic-field
Additional HTTP headers to include in each request
is_local = False
pydantic-field
Whether the storage is local or remote
type = 'http'
pydantic-field
Indicates the storage type, fixed to 'http'
S3ApiKey
pydantic-model
Bases: BaseModel
Fields:
-
access_key(str) -
secret_key(str)
access_key
pydantic-field
Access api key for S3 storage authentication
secret_key
pydantic-field
Secret api key for S3 storage authentication
S3StorageConfiguration
pydantic-model
Bases: StorageConfiguration
Fields:
-
type(Literal['s3']) -
is_local(Literal[False]) -
bucket(str) -
endpoint(str) -
api_key(S3ApiKey | None) -
max_objects(int)
api_key = None
pydantic-field
API key for storage authentication
bucket
pydantic-field
Name of the S3 bucket
endpoint
pydantic-field
Endpoint to access S3 storage
is_local = False
pydantic-field
Whether the storage is local or remote
max_objects = 1000
pydantic-field
Maximum number of objects to fetch when listing elements in a directory
type = 's3'
pydantic-field
Indicates the storage type, fixed to 's3'