flywheel-sdk 21.4.0__py3-none-any.whl → 21.4.0rc0__py3-none-any.whl

flywheel/api/dataexplorer_api.py

@@ -29,13 +29,10 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeleteBySearchQuery
-        :param delete_reason:
-        :type delete_reason: ContainerDeleteReason, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param DeleteBySearchQuery body: (required)
+        :param ContainerDeleteReason delete_reason:
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,13 +55,10 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeleteBySearchQuery
-        :param delete_reason:
-        :type delete_reason: ContainerDeleteReason, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param DeleteBySearchQuery body: (required)
+        :param ContainerDeleteReason delete_reason:
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
 
         all_params = ['body','delete_reason',]  # noqa: E501
@@ -145,11 +139,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param search_id:
-        :type search_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param str search_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -172,11 +164,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param search_id:
-        :type search_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: DeletedResult
+        :param str search_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
         """
 
         all_params = ['search_id',]  # noqa: E501
@@ -244,25 +234,16 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param exhaustive: Return all queries, Admin only, defaults to false
-        :type exhaustive: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[SaveSearchOutput],SaveSearchPage]
+        :param bool exhaustive: Return all queries, Admin only
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[SaveSearchOutput],SaveSearchPage]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -285,25 +266,16 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param exhaustive: Return all queries, Admin only, defaults to false
-        :type exhaustive: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[SaveSearchOutput],SaveSearchPage]
+        :param bool exhaustive: Return all queries, Admin only
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[SaveSearchOutput],SaveSearchPage]
         """
 
         all_params = ['exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -382,11 +354,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param path: Dot-separated subfield to drill down to
-        :type path: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param str path: Dot-separated subfield to drill down to
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -409,11 +379,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param path: Dot-separated subfield to drill down to
-        :type path: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param str path: Dot-separated subfield to drill down to
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
 
         all_params = ['path',]  # noqa: E501
@@ -477,11 +445,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param sid:
-        :type sid: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SaveSearch
+        :param str sid: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SaveSearch
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -504,11 +470,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param sid:
-        :type sid: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SaveSearch
+        :param str sid: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SaveSearch
         """
 
         all_params = ['sid',]  # noqa: E501
@@ -577,11 +541,9 @@ class DataexplorerApi(object):
         Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the \"from\" field to the end of the string with the provided \"value\".
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: StructuredQuery
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: StructuredQuerySuggestions
+        :param StructuredQuery body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: StructuredQuerySuggestions
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -605,11 +567,9 @@ class DataexplorerApi(object):
         Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the \"from\" field to the end of the string with the provided \"value\".
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: StructuredQuery
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: StructuredQuerySuggestions
+        :param StructuredQuery body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: StructuredQuerySuggestions
         """
 
         all_params = ['body',]  # noqa: E501
@@ -688,9 +648,8 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SearchStatus
+        :param bool async_: Perform the request asynchronously
+        :return: SearchStatus
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -713,9 +672,8 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SearchStatus
+        :param bool async_: Perform the request asynchronously
+        :return: SearchStatus
         """
 
         all_params = []  # noqa: E501
@@ -778,11 +736,9 @@ class DataexplorerApi(object):
         Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: StructuredQuery
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ParsedQueryResponse
+        :param StructuredQuery body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ParsedQueryResponse
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -806,11 +762,9 @@ class DataexplorerApi(object):
         Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: StructuredQuery
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ParsedQueryResponse
+        :param StructuredQuery body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ParsedQueryResponse
         """
 
         all_params = ['body',]  # noqa: E501
@@ -889,13 +843,10 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param sid:
-        :type sid: str
-        :param body:
-        :type body: SaveSearchUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SaveSearch
+        :param str sid: (required)
+        :param SaveSearchUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SaveSearch
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -918,13 +869,10 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param sid:
-        :type sid: str
-        :param body:
-        :type body: SaveSearchUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SaveSearch
+        :param str sid: (required)
+        :param SaveSearchUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SaveSearch
         """
 
         all_params = ['sid','body',]  # noqa: E501
@@ -1009,11 +957,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: SaveSearchInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param SaveSearchInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1036,11 +982,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: SaveSearchInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param SaveSearchInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1119,19 +1063,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: SearchQuery
-        :param simple: Unwrap result documents into a list.
-        :type simple: bool, optional
-        :param size: The maximum number of results to return. DEPRECATED: use body parameter instead.
-        :type size: int, optional
-        :param facets: Include additional statistics about the search results. Internal use only., defaults to false
-        :type facets: bool, optional
-        :param csv: Format the response as a CSV file, defaults to false
-        :type csv: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[SearchResponse],object]
+        :param SearchQuery body: (required)
+        :param bool simple: Unwrap result documents into a list.
+        :param int size: The maximum number of results to return. DEPRECATED: use body parameter instead.
+        :param bool facets: Include additional statistics about the search results. Internal use only.
+        :param bool csv: Format the response as a CSV file
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[SearchResponse],object]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1154,19 +1092,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: SearchQuery
-        :param simple: Unwrap result documents into a list.
-        :type simple: bool, optional
-        :param size: The maximum number of results to return. DEPRECATED: use body parameter instead.
-        :type size: int, optional
-        :param facets: Include additional statistics about the search results. Internal use only., defaults to false
-        :type facets: bool, optional
-        :param csv: Format the response as a CSV file, defaults to false
-        :type csv: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[SearchResponse],object]
+        :param SearchQuery body: (required)
+        :param bool simple: Unwrap result documents into a list.
+        :param int size: The maximum number of results to return. DEPRECATED: use body parameter instead.
+        :param bool facets: Include additional statistics about the search results. Internal use only.
+        :param bool csv: Format the response as a CSV file
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[SearchResponse],object]
         """
 
         all_params = ['body','simple','size','facets','csv',]  # noqa: E501