Table of Contents
openeo_fastapi.client.core
Class and model to define the framework and partial application logic for interacting with Jobs.
Classes: - OpenEOCore: Framework for defining the application logic that will passed onto the OpenEO Api.
OpenEOCore Objects
@define
class OpenEOCore()
Client for defining the application logic for the OpenEO Api.
__attrs_post_init__
def __attrs_post_init__()
Post init hook to set the client registers, if none where provided by the user set to the defaults!
get_capabilities
def get_capabilities() -> Capabilities
Get the capabilities of the api.
Returns:
Capabilities- The capabilities of the api based off what the user provided.
get_conformance
def get_conformance() -> ConformanceGetResponse
Get the capabilities of the api.
Returns:
ConformanceGetResponse- The conformance classes that this Api wil of the api based off what the user provided.
get_file_formats
def get_file_formats() -> FileFormatsGetResponse
Get the supported file formats for processing input and output.
Returns:
FileFormatsGetResponse- The response defining the input and output formats.
get_health
def get_health()
Basic health endpoint expected to return status code 200.
Returns:
Response- Status code 200.
get_user_info
def get_user_info(user: User = Depends(
Authenticator.validate)) -> MeGetResponse
Get the supported file formats for processing input and output.
Returns:
MeGetResponse- The user information for the validated user.
get_well_known
def get_well_known() -> WellKnownOpeneoGetResponse
Get the supported file formats for processing input and output.
Returns:
WellKnownOpeneoGetResponse- The api/s which are exposed at this server.
get_udf_runtimes
def get_udf_runtimes() -> UdfRuntimesGetResponse
Get the supported file formats for processing input and output.
Raises:
HTTPException- Raises an exception with relevant status code and descriptive message of failure.
Returns:
UdfRuntimesGetResponse- The metadata for the requested BatchJob.