org.finra.herd.sdk.api

Class DataProviderApi

java.lang.Object

org.finra.herd.sdk.api.DataProviderApi

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

Constructor Summary

Constructors

Constructor and Description
DataProviderApi()
DataProviderApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DataProvider	dataProviderCreateDataProvider(DataProviderCreateRequest dataProviderCreateRequest) createDataProvider Creates a new data provider.
DataProvider	dataProviderDeleteDataProvider(String dataProviderName) deleteDataProvider Deletes an existing data provider by data provider name.
DataProvider	dataProviderGetDataProvider(String dataProviderName) getDataProvider Gets an existing data provider by data provider name.
DataProviderKeys	dataProviderGetDataProviders() getDataProviders Gets a list of data provider keys for all data providers defined in the system.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderApi

public DataProviderApi()

DataProviderApi

public DataProviderApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

dataProviderGetDataProviders

public DataProviderKeys dataProviderGetDataProviders()
                                              throws ApiException

getDataProviders Gets a list of data provider keys for all data providers defined in the system.

Returns:

DataProviderKeys

Throws:

ApiException

dataProviderCreateDataProvider

public DataProvider dataProviderCreateDataProvider(DataProviderCreateRequest dataProviderCreateRequest)
                                            throws ApiException

createDataProvider Creates a new data provider.

Parameters:

dataProviderCreateRequest - the information needed to create the data provider

Returns:

DataProvider

Throws:

ApiException

dataProviderGetDataProvider

public DataProvider dataProviderGetDataProvider(String dataProviderName)
                                         throws ApiException

getDataProvider Gets an existing data provider by data provider name.

Parameters:

dataProviderName - the data provider name

Returns:

DataProvider

Throws:

ApiException

dataProviderDeleteDataProvider

public DataProvider dataProviderDeleteDataProvider(String dataProviderName)
                                            throws ApiException

deleteDataProvider Deletes an existing data provider by data provider name.

Parameters:

dataProviderName - the data provider name

Returns:

DataProvider

Throws:

ApiException