org.finra.herd.sdk.api

Class StorageApi

java.lang.Object

org.finra.herd.sdk.api.StorageApi

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

Constructor Summary

Constructors

Constructor and Description
StorageApi()
StorageApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Storage	storageCreateStorage(StorageCreateRequest storageCreateRequest) createStorage Creates a new storage.
Storage	storageDeleteStorage(String storageName) deleteStorage Deletes an existing storage by name.
Storage	storageGetStorage(String storageName) getStorage Gets an existing storage by name.
StorageKeys	storageGetStorages() getStorages Gets a list of namespace keys for all namespaces defined in the system.
Storage	storageUpdateStorage(String storageName, StorageUpdateRequest storageUpdateRequest) updateStorage Updates an existing storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageApi

public StorageApi()

StorageApi

public StorageApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

storageGetStorages

public StorageKeys storageGetStorages()
                               throws ApiException

getStorages Gets a list of namespace keys for all namespaces defined in the system.

Returns:

StorageKeys

Throws:

ApiException

storageCreateStorage

public Storage storageCreateStorage(StorageCreateRequest storageCreateRequest)
                             throws ApiException

createStorage Creates a new storage.

Parameters:

storageCreateRequest - the information needed to create the storage

Returns:

Storage

Throws:

ApiException

storageGetStorage

public Storage storageGetStorage(String storageName)
                          throws ApiException

getStorage Gets an existing storage by name.

Parameters:

storageName - the storage name

Returns:

Storage

Throws:

ApiException

storageUpdateStorage

public Storage storageUpdateStorage(String storageName,
                                    StorageUpdateRequest storageUpdateRequest)
                             throws ApiException

updateStorage Updates an existing storage.

Parameters:

storageName - the name of the storage to update

storageUpdateRequest - the information needed to update the storage

Returns:

Storage

Throws:

ApiException

storageDeleteStorage

public Storage storageDeleteStorage(String storageName)
                             throws ApiException

deleteStorage Deletes an existing storage by name.

Parameters:

storageName - the storage name

Returns:

Storage

Throws:

ApiException