net.troja.eve.esi.api

Class SearchApi

java.lang.Object

net.troja.eve.esi.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchApi()
SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
CharacterSearchResponse	getCharactersCharacterIdSearch(List<String> categories, Integer characterId, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, String token) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
com.squareup.okhttp.Call	getCharactersCharacterIdSearchAsync(List<String> categories, Integer characterId, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, String token, ApiCallback<CharacterSearchResponse> callback) Search on a string (asynchronously) Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
com.squareup.okhttp.Call	getCharactersCharacterIdSearchCall(List<String> categories, Integer characterId, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, String token, ApiCallback callback) Build call for getCharactersCharacterIdSearch
ApiResponse<CharacterSearchResponse>	getCharactersCharacterIdSearchWithHttpInfo(List<String> categories, Integer characterId, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, String token) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
SearchResponse	getSearch(List<String> categories, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
com.squareup.okhttp.Call	getSearchAsync(List<String> categories, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, ApiCallback<SearchResponse> callback) Search on a string (asynchronously) Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
com.squareup.okhttp.Call	getSearchCall(List<String> categories, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict, ApiCallback callback) Build call for getSearch
ApiResponse<SearchResponse>	getSearchWithHttpInfo(List<String> categories, String search, String acceptLanguage, String datasource, String ifNoneMatch, String language, Boolean strict) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchApi

public SearchApi()

SearchApi

public SearchApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdSearchCall

public com.squareup.okhttp.Call getCharactersCharacterIdSearchCall(List<String> categories,
                                                                   Integer characterId,
                                                                   String search,
                                                                   String acceptLanguage,
                                                                   String datasource,
                                                                   String ifNoneMatch,
                                                                   String language,
                                                                   Boolean strict,
                                                                   String token,
                                                                   ApiCallback callback)
                                                            throws ApiException

Build call for getCharactersCharacterIdSearch

Parameters:

categories - Type of entities to search for (required)

characterId - An EVE character ID (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

token - Access token to use if unable to set a header (optional)

callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCharactersCharacterIdSearch

public CharacterSearchResponse getCharactersCharacterIdSearch(List<String> categories,
                                                              Integer characterId,
                                                              String search,
                                                              String acceptLanguage,
                                                              String datasource,
                                                              String ifNoneMatch,
                                                              String language,
                                                              Boolean strict,
                                                              String token)
                                                       throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

characterId - An EVE character ID (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

token - Access token to use if unable to set a header (optional)

Returns:

CharacterSearchResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdSearchWithHttpInfo

public ApiResponse<CharacterSearchResponse> getCharactersCharacterIdSearchWithHttpInfo(List<String> categories,
                                                                                       Integer characterId,
                                                                                       String search,
                                                                                       String acceptLanguage,
                                                                                       String datasource,
                                                                                       String ifNoneMatch,
                                                                                       String language,
                                                                                       Boolean strict,
                                                                                       String token)
                                                                                throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

characterId - An EVE character ID (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

token - Access token to use if unable to set a header (optional)

Returns:

ApiResponse<CharacterSearchResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdSearchAsync

public com.squareup.okhttp.Call getCharactersCharacterIdSearchAsync(List<String> categories,
                                                                    Integer characterId,
                                                                    String search,
                                                                    String acceptLanguage,
                                                                    String datasource,
                                                                    String ifNoneMatch,
                                                                    String language,
                                                                    Boolean strict,
                                                                    String token,
                                                                    ApiCallback<CharacterSearchResponse> callback)
                                                             throws ApiException

Search on a string (asynchronously) Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

characterId - An EVE character ID (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

token - Access token to use if unable to set a header (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

getSearchCall

public com.squareup.okhttp.Call getSearchCall(List<String> categories,
                                              String search,
                                              String acceptLanguage,
                                              String datasource,
                                              String ifNoneMatch,
                                              String language,
                                              Boolean strict,
                                              ApiCallback callback)
                                       throws ApiException

Build call for getSearch

Parameters:

categories - Type of entities to search for (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSearch

public SearchResponse getSearch(List<String> categories,
                                String search,
                                String acceptLanguage,
                                String datasource,
                                String ifNoneMatch,
                                String language,
                                Boolean strict)
                         throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

Returns:

SearchResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchWithHttpInfo

public ApiResponse<SearchResponse> getSearchWithHttpInfo(List<String> categories,
                                                         String search,
                                                         String acceptLanguage,
                                                         String datasource,
                                                         String ifNoneMatch,
                                                         String language,
                                                         Boolean strict)
                                                  throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

Returns:

ApiResponse<SearchResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchAsync

public com.squareup.okhttp.Call getSearchAsync(List<String> categories,
                                               String search,
                                               String acceptLanguage,
                                               String datasource,
                                               String ifNoneMatch,
                                               String language,
                                               Boolean strict,
                                               ApiCallback<SearchResponse> callback)
                                        throws ApiException

Search on a string (asynchronously) Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

search - The string to search on (required)

acceptLanguage - Language to use in the response (optional, default to en-us)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

language - Language to use in the response, takes precedence over Accept-Language (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

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