org.finra.herd.sdk.api

Class SearchIndexApi

java.lang.Object

org.finra.herd.sdk.api.SearchIndexApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class SearchIndexApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchIndexApi()
SearchIndexApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
SearchIndex	searchIndexCreateSearchIndex(SearchIndexCreateRequest searchIndexCreateRequest) createSearchIndex Creates a new search index.
SearchIndex	searchIndexDeleteSearchIndex(String searchIndexName) deleteSearchIndex Deletes an existing search index by its name.
SearchIndex	searchIndexGetSearchIndex(String searchIndexName) getSearchIndex Gets an existing search index by its name.
SearchIndexKeys	searchIndexGetSearchIndexes() getSearchIndexes Gets a list of search index keys for all search indexes defined in the system.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchIndexApi

public SearchIndexApi()

SearchIndexApi

public SearchIndexApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

searchIndexGetSearchIndexes

public SearchIndexKeys searchIndexGetSearchIndexes()
                                            throws ApiException

getSearchIndexes Gets a list of search index keys for all search indexes defined in the system.

Returns:

SearchIndexKeys

Throws:

ApiException

searchIndexCreateSearchIndex

public SearchIndex searchIndexCreateSearchIndex(SearchIndexCreateRequest searchIndexCreateRequest)
                                         throws ApiException

createSearchIndex Creates a new search index.

Parameters:

searchIndexCreateRequest - the information needed to create a search index

Returns:

SearchIndex

Throws:

ApiException

searchIndexGetSearchIndex

public SearchIndex searchIndexGetSearchIndex(String searchIndexName)
                                      throws ApiException

getSearchIndex Gets an existing search index by its name.

Parameters:

searchIndexName - the name of the search index

Returns:

SearchIndex

Throws:

ApiException

searchIndexDeleteSearchIndex

public SearchIndex searchIndexDeleteSearchIndex(String searchIndexName)
                                         throws ApiException

deleteSearchIndex Deletes an existing search index by its name.

Parameters:

searchIndexName - the search index name

Returns:

SearchIndex

Throws:

ApiException