org.finra.herd.sdk.api

Class StoragePolicyApi

java.lang.Object

org.finra.herd.sdk.api.StoragePolicyApi

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

Constructor Summary

Constructors

Constructor and Description
StoragePolicyApi()
StoragePolicyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
StoragePolicy	storagePolicyCreateStoragePolicy(StoragePolicyCreateRequest storagePolicyCreateRequest) createStoragePolicy Creates a new storage policy.
StoragePolicy	storagePolicyGetStoragePolicy(String namespace, String storagePolicyName) getStoragePolicy Gets an existing storage policy by key.
StoragePolicy	storagePolicyUpdateStoragePolicy(String namespace, String storagePolicyName, StoragePolicyUpdateRequest storagePolicyUpdateRequest) updateStoragePolicy Updates an existing storage policy by key.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoragePolicyApi

public StoragePolicyApi()

StoragePolicyApi

public StoragePolicyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

storagePolicyCreateStoragePolicy

public StoragePolicy storagePolicyCreateStoragePolicy(StoragePolicyCreateRequest storagePolicyCreateRequest)
                                               throws ApiException

createStoragePolicy Creates a new storage policy. <p>Requires WRITE permission on namespace and READ permission on filter namespace</p>

Parameters:

storagePolicyCreateRequest - the information needed to create the storage policy

Returns:

StoragePolicy

Throws:

ApiException

storagePolicyGetStoragePolicy

public StoragePolicy storagePolicyGetStoragePolicy(String namespace,
                                                   String storagePolicyName)
                                            throws ApiException

getStoragePolicy Gets an existing storage policy by key. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace

storagePolicyName - the storage policy name

Returns:

StoragePolicy

Throws:

ApiException

storagePolicyUpdateStoragePolicy

public StoragePolicy storagePolicyUpdateStoragePolicy(String namespace,
                                                      String storagePolicyName,
                                                      StoragePolicyUpdateRequest storagePolicyUpdateRequest)
                                               throws ApiException

updateStoragePolicy Updates an existing storage policy by key. <p>Requires WRITE permission on namespace and READ permission on filter namespace</p>

Parameters:

namespace - the namespace

storagePolicyName - the storage policy name

storagePolicyUpdateRequest - the information needed to update the storage policy

Returns:

StoragePolicy

Throws:

ApiException