Skip to content

announcements_api

OQTOPUS Cloud User API

OQTOPUS Cloud User API. This API is used to interact with the OQTOPUS Cloud service. The API provides endpoints to manage devices, jobs, and results.

The version of the OpenAPI document: 1.0 Contact: oqtopus-team[at]googlegroups.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Classes:

AnnouncementsApi 

AnnouncementsApi(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_announcement async 

get_announcement(
    announcement_id: StrictInt,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> AnnouncementsGetAnnouncementResponse

Get selected announcement

Get selected announcement

:param announcement_id: announcement ID (required) :type announcement_id: int :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_announcement_with_http_info async 

get_announcement_with_http_info(
    announcement_id: StrictInt,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[AnnouncementsGetAnnouncementResponse]

Get selected announcement

Get selected announcement

:param announcement_id: announcement ID (required) :type announcement_id: int :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_announcement_without_preload_content async 

get_announcement_without_preload_content(
    announcement_id: StrictInt,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Get selected announcement

Get selected announcement

:param announcement_id: announcement ID (required) :type announcement_id: int :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_announcements_list async 

get_announcements_list(
    offset: Optional[StrictStr] = None,
    limit: Optional[StrictStr] = None,
    order: Optional[StrictStr] = None,
    current_time: Optional[datetime] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> AnnouncementsGetAnnouncementsListResponse

Get announcements list from backend

Get announcements list from backend

:param offset: offset information :type offset: str :param limit: Limit information :type limit: str :param order: Specify order according to start time :type order: str :param current_time: Allows to filter the list of announcements to fetch by provided time. If specified only announcements with start_time <= current_time and end_time >= current_time are returned. :type current_time: datetime :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_announcements_list_with_http_info async 

get_announcements_list_with_http_info(
    offset: Optional[StrictStr] = None,
    limit: Optional[StrictStr] = None,
    order: Optional[StrictStr] = None,
    current_time: Optional[datetime] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[AnnouncementsGetAnnouncementsListResponse]

Get announcements list from backend

Get announcements list from backend

:param offset: offset information :type offset: str :param limit: Limit information :type limit: str :param order: Specify order according to start time :type order: str :param current_time: Allows to filter the list of announcements to fetch by provided time. If specified only announcements with start_time <= current_time and end_time >= current_time are returned. :type current_time: datetime :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_announcements_list_without_preload_content async 

get_announcements_list_without_preload_content(
    offset: Optional[StrictStr] = None,
    limit: Optional[StrictStr] = None,
    order: Optional[StrictStr] = None,
    current_time: Optional[datetime] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Get announcements list from backend

Get announcements list from backend

:param offset: offset information :type offset: str :param limit: Limit information :type limit: str :param order: Specify order according to start time :type order: str :param current_time: Allows to filter the list of announcements to fetch by provided time. If specified only announcements with start_time <= current_time and end_time >= current_time are returned. :type current_time: datetime :param _request_timeout: 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. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.