Package ai.reveng.api

Class SearchApi

java.lang.Object
ai.reveng.api.SearchApi

public class SearchApi extends Object
  • Constructor Details

    • SearchApi

      public SearchApi()
    • SearchApi

      public SearchApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • getHostIndex

      public int getHostIndex()
    • setHostIndex

      public void setHostIndex(int hostIndex)
    • getCustomBaseUrl

      public String getCustomBaseUrl()
    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)
    • searchBinariesCall

      public okhttp3.Call searchBinariesCall(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String partialSha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable Boolean userFilesOnly, @Nullable Integer excludeBinaryId, ApiCallback _callback) throws ApiException
      Build call for searchBinaries
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the binary being searched (optional)
      partialSha256 - The partial or full sha256 of the binary being searched (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      userFilesOnly - Whether to only search user's uploaded files (optional, default to false)
      excludeBinaryId - A binary ID to exclude from the results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, partial_sha256, tags or model_name to search -
    • searchBinaries

      public BaseResponseBinarySearchResponse searchBinaries(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String partialSha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable Boolean userFilesOnly, @Nullable Integer excludeBinaryId) throws ApiException
      Binaries search Searches for a specific binary
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the binary being searched (optional)
      partialSha256 - The partial or full sha256 of the binary being searched (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      userFilesOnly - Whether to only search user's uploaded files (optional, default to false)
      excludeBinaryId - A binary ID to exclude from the results (optional)
      Returns:
      BaseResponseBinarySearchResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, partial_sha256, tags or model_name to search -
    • searchBinariesWithHttpInfo

      public ApiResponse<BaseResponseBinarySearchResponse> searchBinariesWithHttpInfo(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String partialSha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable Boolean userFilesOnly, @Nullable Integer excludeBinaryId) throws ApiException
      Binaries search Searches for a specific binary
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the binary being searched (optional)
      partialSha256 - The partial or full sha256 of the binary being searched (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      userFilesOnly - Whether to only search user's uploaded files (optional, default to false)
      excludeBinaryId - A binary ID to exclude from the results (optional)
      Returns:
      ApiResponse<BaseResponseBinarySearchResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, partial_sha256, tags or model_name to search -
    • searchBinariesAsync

      public okhttp3.Call searchBinariesAsync(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String partialSha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable Boolean userFilesOnly, @Nullable Integer excludeBinaryId, ApiCallback<BaseResponseBinarySearchResponse> _callback) throws ApiException
      Binaries search (asynchronously) Searches for a specific binary
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the binary being searched (optional)
      partialSha256 - The partial or full sha256 of the binary being searched (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      userFilesOnly - Whether to only search user's uploaded files (optional, default to false)
      excludeBinaryId - A binary ID to exclude from the results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, partial_sha256, tags or model_name to search -
    • searchCollectionsCall

      public okhttp3.Call searchCollectionsCall(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialCollectionName, @Nullable String partialBinaryName, @Nullable String partialBinarySha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable List<Filters> filters, @Nullable AppApiRestV2CollectionsEnumsOrderBy orderBy, @Nullable Order orderByDirection, ApiCallback _callback) throws ApiException
      Build call for searchCollections
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialCollectionName - The partial or full name of the collection being searched (optional)
      partialBinaryName - The partial or full name of the binary belonging to the collection (optional)
      partialBinarySha256 - The partial or full sha256 of the binary belonging to the collection (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      filters - The filters to be used for the search (optional)
      orderBy - The field to sort the order by in the results (optional, default to created)
      orderByDirection - The order direction in which to return results (optional, default to DESC)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_collection_name, partial_binary_name, partial_binary_sha256, tags or model_name to search -
      404 The model name provided does not exist -
    • searchCollections

      public BaseResponseCollectionSearchResponse searchCollections(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialCollectionName, @Nullable String partialBinaryName, @Nullable String partialBinarySha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable List<Filters> filters, @Nullable AppApiRestV2CollectionsEnumsOrderBy orderBy, @Nullable Order orderByDirection) throws ApiException
      Collections search Searches for a specific collection
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialCollectionName - The partial or full name of the collection being searched (optional)
      partialBinaryName - The partial or full name of the binary belonging to the collection (optional)
      partialBinarySha256 - The partial or full sha256 of the binary belonging to the collection (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      filters - The filters to be used for the search (optional)
      orderBy - The field to sort the order by in the results (optional, default to created)
      orderByDirection - The order direction in which to return results (optional, default to DESC)
      Returns:
      BaseResponseCollectionSearchResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_collection_name, partial_binary_name, partial_binary_sha256, tags or model_name to search -
      404 The model name provided does not exist -
    • searchCollectionsWithHttpInfo

      public ApiResponse<BaseResponseCollectionSearchResponse> searchCollectionsWithHttpInfo(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialCollectionName, @Nullable String partialBinaryName, @Nullable String partialBinarySha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable List<Filters> filters, @Nullable AppApiRestV2CollectionsEnumsOrderBy orderBy, @Nullable Order orderByDirection) throws ApiException
      Collections search Searches for a specific collection
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialCollectionName - The partial or full name of the collection being searched (optional)
      partialBinaryName - The partial or full name of the binary belonging to the collection (optional)
      partialBinarySha256 - The partial or full sha256 of the binary belonging to the collection (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      filters - The filters to be used for the search (optional)
      orderBy - The field to sort the order by in the results (optional, default to created)
      orderByDirection - The order direction in which to return results (optional, default to DESC)
      Returns:
      ApiResponse<BaseResponseCollectionSearchResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_collection_name, partial_binary_name, partial_binary_sha256, tags or model_name to search -
      404 The model name provided does not exist -
    • searchCollectionsAsync

      public okhttp3.Call searchCollectionsAsync(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialCollectionName, @Nullable String partialBinaryName, @Nullable String partialBinarySha256, @Nullable List<String> tags, @Nullable String modelName, @Nullable List<Filters> filters, @Nullable AppApiRestV2CollectionsEnumsOrderBy orderBy, @Nullable Order orderByDirection, ApiCallback<BaseResponseCollectionSearchResponse> _callback) throws ApiException
      Collections search (asynchronously) Searches for a specific collection
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialCollectionName - The partial or full name of the collection being searched (optional)
      partialBinaryName - The partial or full name of the binary belonging to the collection (optional)
      partialBinarySha256 - The partial or full sha256 of the binary belonging to the collection (optional)
      tags - The tags to be searched for (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      filters - The filters to be used for the search (optional)
      orderBy - The field to sort the order by in the results (optional, default to created)
      orderByDirection - The order direction in which to return results (optional, default to DESC)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_collection_name, partial_binary_name, partial_binary_sha256, tags or model_name to search -
      404 The model name provided does not exist -
    • searchFunctionsCall

      public okhttp3.Call searchFunctionsCall(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String modelName, ApiCallback _callback) throws ApiException
      Build call for searchFunctions
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the function being searched (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, or model_name to search -
    • searchFunctions

      public BaseResponseFunctionSearchResponse searchFunctions(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String modelName) throws ApiException
      Functions search Searches for a specific function
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the function being searched (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      Returns:
      BaseResponseFunctionSearchResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, or model_name to search -
    • searchFunctionsWithHttpInfo

      public ApiResponse<BaseResponseFunctionSearchResponse> searchFunctionsWithHttpInfo(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String modelName) throws ApiException
      Functions search Searches for a specific function
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the function being searched (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      Returns:
      ApiResponse<BaseResponseFunctionSearchResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, or model_name to search -
    • searchFunctionsAsync

      public okhttp3.Call searchFunctionsAsync(@Nullable Integer page, @Nullable Integer pageSize, @Nullable String partialName, @Nullable String modelName, ApiCallback<BaseResponseFunctionSearchResponse> _callback) throws ApiException
      Functions search (asynchronously) Searches for a specific function
      Parameters:
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      partialName - The partial or full name of the function being searched (optional)
      modelName - The name of the model used to analyze the binary the function belongs to (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide at least one of the filters; partial_name, or model_name to search -
    • searchTagsCall

      public okhttp3.Call searchTagsCall(@Nonnull String partialName, @Nullable Integer page, @Nullable Integer pageSize, ApiCallback _callback) throws ApiException
      Build call for searchTags
      Parameters:
      partialName - The partial or full name of the tag to search for (required)
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide a partial_name to search and it must be greater than 3 characters -
    • searchTags

      public BaseResponseTagSearchResponse searchTags(@Nonnull String partialName, @Nullable Integer page, @Nullable Integer pageSize) throws ApiException
      Tags search Searches for tags by there name
      Parameters:
      partialName - The partial or full name of the tag to search for (required)
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      Returns:
      BaseResponseTagSearchResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide a partial_name to search and it must be greater than 3 characters -
    • searchTagsWithHttpInfo

      public ApiResponse<BaseResponseTagSearchResponse> searchTagsWithHttpInfo(@Nonnull String partialName, @Nullable Integer page, @Nullable Integer pageSize) throws ApiException
      Tags search Searches for tags by there name
      Parameters:
      partialName - The partial or full name of the tag to search for (required)
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      Returns:
      ApiResponse<BaseResponseTagSearchResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide a partial_name to search and it must be greater than 3 characters -
    • searchTagsAsync

      public okhttp3.Call searchTagsAsync(@Nonnull String partialName, @Nullable Integer page, @Nullable Integer pageSize, ApiCallback<BaseResponseTagSearchResponse> _callback) throws ApiException
      Tags search (asynchronously) Searches for tags by there name
      Parameters:
      partialName - The partial or full name of the tag to search for (required)
      page - The page number to retrieve. (optional, default to 1)
      pageSize - Number of items per page. (optional, default to 10)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Successful Response -
      422 You must provide a partial_name to search and it must be greater than 3 characters -