rs_client/stac/cadip_client.md

<< Back to index

CadipClient class implementation.

CadipClient

Bases: StacBase

CadipClient class implementation.

Attributes: see class:RsClient

Source code in docs/rs-client-libraries/rs_client/stac/cadip_client.py

class CadipClient(StacBase):
    """
    CadipClient class implementation.

    Attributes: see :py:class:`RsClient`
    """

    def __init__(  # pylint: disable=too-many-arguments, too-many-positional-arguments
        self,
        rs_server_href: str | None,
        rs_server_api_key: str | None,
        logger: logging.Logger | None = None,
        **kwargs: dict[str, Any],
    ):
        """
        Initializes a CadipClient instance.

        Args:
            rs_server_href (str | None): The URL of the RS-Server. Pass None for local mode.
            rs_server_api_key (str | None): API key for authentication.
            logger (logging.Logger | None, optional): Logger instance (default: None).
            **kwargs: Arbitrary keyword arguments that may include:
                - `headers` (Optional[Dict[str, str]])
                - `parameters` (Optional[Dict[str, Any]])
                - `ignore_conformance` (Optional[bool])
                - `modifier` (Callable[[Collection | Item | ItemCollection | dict[Any, Any]], None] | None)
                - `request_modifier` (Optional[Callable[[Request], Union[Request, None]]])
                - `stac_io` (Optional[StacApiIO])
                - `timeout` (Optional[Timeout])
        """
        super().__init__(
            rs_server_href,
            rs_server_api_key,
            None,
            logger,
            get_href_service(rs_server_href, "RSPY_HOST_CADIP") + "/cadip/",
            **kwargs,
        )

    @property
    def href_service(self) -> str:
        """
        Return the RS-Server CADIP URL hostname.
        This URL can be overwritten using the RSPY_HOST_CADIP env variable (used e.g. for local mode).
        Otherwise it should just be the RS-Server URL.
        """
        return get_href_service(self.rs_server_href, "RSPY_HOST_CADIP") + "/cadip"

href_service property

Return the RS-Server CADIP URL hostname. This URL can be overwritten using the RSPY_HOST_CADIP env variable (used e.g. for local mode). Otherwise it should just be the RS-Server URL.

__init__(rs_server_href, rs_server_api_key, logger=None, **kwargs)

Initializes a CadipClient instance.

Parameters:

Name	Type	Description	Default
rs_server_href	str | None	The URL of the RS-Server. Pass None for local mode.	required
rs_server_api_key	str | None	API key for authentication.	required
logger	Logger | None	Logger instance (default: None).	None
**kwargs	dict[str, Any]	Arbitrary keyword arguments that may include: - headers (Optional[Dict[str, str]]) - parameters (Optional[Dict[str, Any]]) - ignore_conformance (Optional[bool]) - modifier (Callable[[Collection | Item | ItemCollection | dict[Any, Any]], None] | None) - request_modifier (Optional[Callable[[Request], Union[Request, None]]]) - stac_io (Optional[StacApiIO]) - timeout (Optional[Timeout])	{}

Source code in docs/rs-client-libraries/rs_client/stac/cadip_client.py

def __init__(  # pylint: disable=too-many-arguments, too-many-positional-arguments
    self,
    rs_server_href: str | None,
    rs_server_api_key: str | None,
    logger: logging.Logger | None = None,
    **kwargs: dict[str, Any],
):
    """
    Initializes a CadipClient instance.

    Args:
        rs_server_href (str | None): The URL of the RS-Server. Pass None for local mode.
        rs_server_api_key (str | None): API key for authentication.
        logger (logging.Logger | None, optional): Logger instance (default: None).
        **kwargs: Arbitrary keyword arguments that may include:
            - `headers` (Optional[Dict[str, str]])
            - `parameters` (Optional[Dict[str, Any]])
            - `ignore_conformance` (Optional[bool])
            - `modifier` (Callable[[Collection | Item | ItemCollection | dict[Any, Any]], None] | None)
            - `request_modifier` (Optional[Callable[[Request], Union[Request, None]]])
            - `stac_io` (Optional[StacApiIO])
            - `timeout` (Optional[Timeout])
    """
    super().__init__(
        rs_server_href,
        rs_server_api_key,
        None,
        logger,
        get_href_service(rs_server_href, "RSPY_HOST_CADIP") + "/cadip/",
        **kwargs,
    )