Module ogc_api_processes_client.api.conformance_declaration_api

A sample API conforming to the OGC API - Processes - Part 1 standard

This document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application.

The version of the OpenAPI document: 1.0.0 Contact: standards-team@ogc.org Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Classes

ConformanceDeclarationApi

class ConformanceDeclarationApi(
    api_client=None
)

NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

get_conformance_classes

def get_conformance_classes(
    self,
    _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None,
    _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _content_type: Annotated[str, Strict(strict=True)] | None = None,
    _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0
) -> ogc_api_processes_client.models.conf_classes.ConfClasses

information about standards that this API conforms to

A list of all conformance classes, specified in a standard, that the server conforms to. | Conformance class | URI | |-----------|-------| |Core|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core| |OGC Process Description|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description| |JSON|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json| |HTML|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html| |OpenAPI Specification 3.0|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30| |Job list|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list| |Callback|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback| |Dismiss|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss| For more information, see Section 7.4.

Parameters:

Name	Type	Description	Default
_request_timeout	int, tuple(int, int), optional	timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.	None
_request_auth	dict, optional	set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.	None
_content_type	str, Optional	force content-type for the request.	None
_headers	dict, optional	set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.	None
_host_index	int, optional	set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.	None

Returns:

Type	Description
None	Returns the result object.

get_conformance_classes_with_http_info

def get_conformance_classes_with_http_info(
    self,
    _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None,
    _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _content_type: Annotated[str, Strict(strict=True)] | None = None,
    _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0
) -> ogc_api_processes_client.api_response.ApiResponse[ConfClasses]

information about standards that this API conforms to

A list of all conformance classes, specified in a standard, that the server conforms to. | Conformance class | URI | |-----------|-------| |Core|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core| |OGC Process Description|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description| |JSON|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json| |HTML|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html| |OpenAPI Specification 3.0|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30| |Job list|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list| |Callback|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback| |Dismiss|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss| For more information, see Section 7.4.

Parameters:

Name	Type	Description	Default
_request_timeout	int, tuple(int, int), optional	timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.	None
_request_auth	dict, optional	set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.	None
_content_type	str, Optional	force content-type for the request.	None
_headers	dict, optional	set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.	None
_host_index	int, optional	set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.	None

Returns:

Type	Description
None	Returns the result object.

get_conformance_classes_without_preload_content

def get_conformance_classes_without_preload_content(
    self,
    _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None,
    _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _content_type: Annotated[str, Strict(strict=True)] | None = None,
    _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None,
    _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0
) -> urllib3.response.HTTPResponse

information about standards that this API conforms to

A list of all conformance classes, specified in a standard, that the server conforms to. | Conformance class | URI | |-----------|-------| |Core|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core| |OGC Process Description|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description| |JSON|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json| |HTML|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html| |OpenAPI Specification 3.0|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30| |Job list|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list| |Callback|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback| |Dismiss|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss| For more information, see Section 7.4.

Parameters:

Name	Type	Description	Default
_request_timeout	int, tuple(int, int), optional	timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.	None
_request_auth	dict, optional	set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.	None
_content_type	str, Optional	force content-type for the request.	None
_headers	dict, optional	set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.	None
_host_index	int, optional	set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.	None

Returns:

Type	Description
None	Returns the result object.