tracdap.api¶

Services¶

`TracAdminApi`	Public API for performing admin functions, such as managing tenants and configuration.
`TracDataApi`	Public API for creating, updating, reading and querying primary data stored in the TRAC platform.
`TracMetadataApi`	Public API for creating, updating, reading and searching for objects in the TRAC metadata store.
`TracOrchestratorApi`	Public API for submitting, querying and managing jobs in the TRAC platform
`TracStorageApi`	Low-level API for reading and writing content directly in TRAC-managed storage.

Messages¶

`ConfigListRequest`	List config entries available in the TRAC metadata store.
`ConfigListResponse`	Result of listing config entries available in the TRAC metadata store.
`ConfigReadBatchRequest`	Request to read a batch of config entries from the TRAC metadata store.
`ConfigReadBatchResponse`	Result of reading a batch of config entries from the TRAC metadata store.
`ConfigReadRequest`	Request to read a config entry from the TRAC metadata store.
`ConfigReadResponse`	Result of reading a config entry from the TRAC metadata store.
`ConfigWriteRequest`	Request to create or update a config entry in the TRAC metadata store.
`ConfigWriteResponse`	Result of creating or updating a config entry in the TRAC metadata store.
`DataDownloadRequest`	Request DATA object for an HTTP download
`DataReadRequest`	Request to read a dataset stored in the TRAC platform.
`DataReadResponse`	Response to a request to read a dataset stored in the TRAC platform.
`DataWriteRequest`	Request to create of update a dataset stored in the TRAC platform.
`DownloadResponse`	Response object for an HTTP download
`FileDownloadRequest`	Request FILE object for an HTTP download
`FileReadRequest`	Request to read a FILE, i.e. retrieve its content from the platform.
`FileReadResponse`	Response to a request to read a FILE, i.e. retrieve its content from the platform.
`FileStat`	Metadata for a file or directory in TRAC storage.
`FileType`	Distinguishes files from directories in FileStat.
`FileWriteRequest`	Request to create or update a FILE and store content to the platform.
`JobRequest`	Request to submit (or validate) a new job
`JobStatus`	Provides the status of a new or existing job in the platform
`JobStatusRequest`	Request to check the status or results of an existing job
`ListTenantsRequest`	Request object for the listTenants() API call.
`ListTenantsResponse`	Response object for the listTenants() API call.
`MetadataBatchRequest`	Request to read a batch of objects from the TRAC metadata store.
`MetadataBatchResponse`	Response to reading a batch of objects from the TRAC metadata store.
`MetadataGetRequest`	Request to get an object from the TRAC metadata store.
`MetadataReadRequest`	Request to read an object from the TRAC metadata store.
`MetadataSearchRequest`	Request for a search against the TRAC metadata store.
`MetadataSearchResponse`	Response to a search against the TRAC metadata store.
`MetadataWriteBatchRequest`	Request to create or update a batch of objects in the TRAC metadata store.
`MetadataWriteBatchResponse`	Response to a batch write operation.
`MetadataWriteRequest`	Request to create or update an object in the TRAC metadata store.
`PlatformInfoRequest`	Request object for the platformInfo() API call.
`PlatformInfoResponse`	Response object for the platformInfo() API call.
`StorageExistsResponse`	Result of an exists() call, indicating whether the given path was found.
`StorageLsResponse`	Result of an ls() call, listing the metadata for each entry in a directory.
`StorageOkResponse`	Result of a storage operation that does not return file content, such as
`StorageReadRequest`	Identifies a file to read from TRAC storage, for readFile() and readSmallFile().
`StorageReadResponse`	The content of a file read from TRAC storage, together with its metadata.
`StorageRequest`	Identifies a file or directory in TRAC storage, for calls that do not send or
`StorageSizeResponse`	Result of a size() call, giving the size of a file in bytes.
`StorageStatResponse`	Result of a stat() call, giving metadata for a file or directory.
`StorageWriteRequest`	Identifies a file to write in TRAC storage, together with its content.
`TracErrorDetails`	Detailed error information, available if an API call fails for any reason
`TracErrorItem`	Individual error items in a detailed error response