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

flywheel/api/dataexplorer_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -36,10 +29,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param DeleteBySearchQuery body: (required)
-        :param ContainerDeleteReason delete_reason:
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -62,10 +58,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param DeleteBySearchQuery body: (required)
-        :param ContainerDeleteReason delete_reason:
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :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
         """
 
         all_params = ['body','delete_reason',]  # noqa: E501
@@ -146,9 +145,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str search_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param search_id:
+        :type search_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -171,9 +172,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str search_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param search_id:
+        :type search_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
 
         all_params = ['search_id',]  # noqa: E501
@@ -241,16 +244,25 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -273,16 +285,25 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
 
         all_params = ['exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -361,9 +382,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str path: Dot-separated subfield to drill down to
-        :param bool async_: Perform the request asynchronously
-        :return: object
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -386,9 +409,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str path: Dot-separated subfield to drill down to
-        :param bool async_: Perform the request asynchronously
-        :return: object
+        :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
         """
 
         all_params = ['path',]  # noqa: E501
@@ -452,9 +477,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str sid: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SaveSearch
+        :param sid:
+        :type sid: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SaveSearch
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -477,9 +504,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str sid: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SaveSearch
+        :param sid:
+        :type sid: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SaveSearch
         """
 
         all_params = ['sid',]  # noqa: E501
@@ -548,9 +577,11 @@ 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 StructuredQuery body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StructuredQuerySuggestions
+        :param body:
+        :type body: StructuredQuery
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StructuredQuerySuggestions
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -574,9 +605,11 @@ 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 StructuredQuery body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StructuredQuerySuggestions
+        :param body:
+        :type body: StructuredQuery
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StructuredQuerySuggestions
         """
 
         all_params = ['body',]  # noqa: E501
@@ -655,8 +688,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: SearchStatus
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SearchStatus
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -679,8 +713,9 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: SearchStatus
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SearchStatus
         """
 
         all_params = []  # noqa: E501
@@ -743,9 +778,11 @@ 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 StructuredQuery body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ParsedQueryResponse
+        :param body:
+        :type body: StructuredQuery
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ParsedQueryResponse
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -769,9 +806,11 @@ 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 StructuredQuery body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ParsedQueryResponse
+        :param body:
+        :type body: StructuredQuery
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ParsedQueryResponse
         """
 
         all_params = ['body',]  # noqa: E501
@@ -850,10 +889,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str sid: (required)
-        :param SaveSearchUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SaveSearch
+        :param sid:
+        :type sid: str
+        :param body:
+        :type body: SaveSearchUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SaveSearch
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -876,10 +918,13 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str sid: (required)
-        :param SaveSearchUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SaveSearch
+        :param sid:
+        :type sid: str
+        :param body:
+        :type body: SaveSearchUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SaveSearch
         """
 
         all_params = ['sid','body',]  # noqa: E501
@@ -964,9 +1009,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SaveSearchInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: InsertedId
+        :param body:
+        :type body: SaveSearchInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: InsertedId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -989,9 +1036,11 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SaveSearchInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: InsertedId
+        :param body:
+        :type body: SaveSearchInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: InsertedId
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1070,13 +1119,19 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SearchQuery body: (required)
-        :param bool simple: Unwrap result documents into a list.
-        :param int size: The maximum number of results to return.
-        :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]
+        :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]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1099,13 +1154,19 @@ class DataexplorerApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param SearchQuery body: (required)
-        :param bool simple: Unwrap result documents into a list.
-        :param int size: The maximum number of results to return.
-        :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]
+        :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]
         """
 
         all_params = ['body','simple','size','facets','csv',]  # noqa: E501
@@ -1141,8 +1202,6 @@ class DataexplorerApi(object):
             query_params.append(('simple', 'true'))
         if 'size' in params:
             query_params.append(('size', params['size']))  # noqa: E501
-        else:
-            query_params.append(('size', '100'))
         if 'facets' in params:
             query_params.append(('facets', params['facets']))  # noqa: E501
         if 'csv' in params: