Module: ncbi.datasets.openapi.api.version_api

Python API: ncbi.datasets.openapi.api.version_api

Module: ncbi.datasets.openapi.api.version_api

Python API: ncbi.datasets.openapi.api.version_api
class ncbi.datasets.openapi.api.version_api.VersionApi(api_client=None)

Bases: object

version(**kwargs)

Retrieve service version

Retrieve the latest version of the Datasets services. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True:

thread = api.version(async_req=True)
result = thread.get()
Parameters
  • bool (async_req) – execute request asynchronously

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns

V1alpha1VersionReply If the method is called asynchronously, returns the request thread.

version_with_http_info(**kwargs)

Retrieve service version

Retrieve the latest version of the Datasets services. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True:

thread = api.version_with_http_info(async_req=True)
result = thread.get()
Parameters
  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns

tuple(V1alpha1VersionReply, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

Generated April 23, 2021