Module python_odpt.api.default.data_search_operations_search

Functions

async def asyncio(rdf_type: str,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
predicate: Dict[str, Any] = {}) ‑> Any | List[Calendar | Operator | Station | StationTimetable | TrainTimetable | TrainType | RailDirection | Railway | RailwayFare | PassengerSurvey | BusTimetable | BusroutePattern | BusroutePatternFare | BusstopPole | BusstopPoleTimetable | Airport | AirportTerminal | FlightSchedule | FlightStatus] | None

Expand source code

async def asyncio(
    rdf_type: str,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    predicate: Dict[str, Any] = {},
) -> Optional[Union[Any, List[OUTPUT_TYPES]]]:
    """データ検索API

    Args:
        rdf_type (str): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        aclconsumer_key (str): アクセストークン
        predicate (Dict[str, Any]): フィルター条件

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Union[Any, List[OUTPUT_TYPES]]
    """

    return (
        await asyncio_detailed(
            rdf_type=rdf_type,
            client=client,
            aclconsumer_key=aclconsumer_key,
            predicate=predicate,
        )
    ).parsed

データ検索API

Args

rdf_type : str

固有識別子の別名 多くがodpt.hoge:fuga形式

aclconsumer_key : str

アクセストークン

predicate : Dict[str, Any]

フィルター条件

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Union[Any, List[OUTPUT_TYPES]]

async def asyncio_detailed(rdf_type: str,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
predicate: Dict[str, Any] = {}) ‑> Response[Any | List[Calendar | Operator | Station | StationTimetable | TrainTimetable | TrainType | RailDirection | Railway | RailwayFare | PassengerSurvey | BusTimetable | BusroutePattern | BusroutePatternFare | BusstopPole | BusstopPoleTimetable | Airport | AirportTerminal | FlightSchedule | FlightStatus]]

Expand source code

async def asyncio_detailed(
    rdf_type: str,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    predicate: Dict[str, Any] = {},
) -> Response[Union[Any, List[OUTPUT_TYPES]]]:
    """データ検索API

    Args:
        rdf_type (str): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        aclconsumer_key (str): アクセストークン
        predicate (Dict[str, Any]): フィルター条件

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[Union[Any, List[OUTPUT_TYPES]]]
    """

    kwargs = _get_kwargs(
        rdf_type=rdf_type,
        aclconsumer_key=aclconsumer_key,
        predicate=predicate,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

データ検索API

Args

rdf_type : str

固有識別子の別名 多くがodpt.hoge:fuga形式

aclconsumer_key : str

アクセストークン

predicate : Dict[str, Any]

フィルター条件

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Response[Union[Any, List[OUTPUT_TYPES]]]

def sync(rdf_type: str,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
predicate: Dict[str, Any] = {}) ‑> Any | List[Calendar | Operator | Station | StationTimetable | TrainTimetable | TrainType | RailDirection | Railway | RailwayFare | PassengerSurvey | BusTimetable | BusroutePattern | BusroutePatternFare | BusstopPole | BusstopPoleTimetable | Airport | AirportTerminal | FlightSchedule | FlightStatus] | None

Expand source code

def sync(
    rdf_type: str,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    predicate: Dict[str, Any] = {},
) -> Optional[Union[Any, List[OUTPUT_TYPES]]]:
    """データ検索API

    Args:
        rdf_type (str): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        aclconsumer_key (str): アクセストークン
        predicate (Dict[str, Any]): フィルター条件

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Union[Any, List[OUTPUT_TYPES]]
    """

    return sync_detailed(
        rdf_type=rdf_type,
        client=client,
        aclconsumer_key=aclconsumer_key,
        predicate=predicate,
    ).parsed

データ検索API

Args

rdf_type : str

固有識別子の別名 多くがodpt.hoge:fuga形式

aclconsumer_key : str

アクセストークン

predicate : Dict[str, Any]

フィルター条件

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Union[Any, List[OUTPUT_TYPES]]

def sync_detailed(rdf_type: str,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
predicate: Dict[str, Any] = {}) ‑> Response[Any | List[Calendar | Operator | Station | StationTimetable | TrainTimetable | TrainType | RailDirection | Railway | RailwayFare | PassengerSurvey | BusTimetable | BusroutePattern | BusroutePatternFare | BusstopPole | BusstopPoleTimetable | Airport | AirportTerminal | FlightSchedule | FlightStatus]]

Expand source code

def sync_detailed(
    rdf_type: str,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    predicate: Dict[str, Any] = {},
) -> Response[Union[Any, List[OUTPUT_TYPES]]]:
    """データ検索API

    Args:
        rdf_type (str): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        aclconsumer_key (str): アクセストークン
        predicate (Dict[str, Any]): フィルター条件

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[Union[Any, List[OUTPUT_TYPES]]]
    """

    kwargs = _get_kwargs(
        rdf_type=rdf_type,
        aclconsumer_key=aclconsumer_key,
        predicate=predicate,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)

データ検索API

Args

rdf_type : str

固有識別子の別名 多くがodpt.hoge:fuga形式

aclconsumer_key : str

アクセストークン

predicate : Dict[str, Any]

フィルター条件

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Response[Union[Any, List[OUTPUT_TYPES]]]