org.finra.herd.sdk.api

Class StorageUnitApi

java.lang.Object

org.finra.herd.sdk.api.StorageUnitApi

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

Constructor Summary

Constructors

Constructor and Description
StorageUnitApi()
StorageUnitApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
StorageUnitDownloadCredential	storageUnitGetStorageUnitDownloadCredential(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String storageName, String subPartitionValues) getStorageUnitDownloadCredential Gets the AWS credential to download to the specified storage unit.
StorageUnitUploadCredential	storageUnitGetStorageUnitUploadCredential(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String storageName, String subPartitionValues) getStorageUnitUploadCredential Gets the AWS credential to upload to the specified storage unit.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageUnitApi

public StorageUnitApi()

StorageUnitApi

public StorageUnitApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

storageUnitGetStorageUnitDownloadCredential

public StorageUnitDownloadCredential storageUnitGetStorageUnitDownloadCredential(String namespace,
                                                                                 String businessObjectDefinitionName,
                                                                                 String businessObjectFormatUsage,
                                                                                 String businessObjectFormatFileType,
                                                                                 Integer businessObjectFormatVersion,
                                                                                 String partitionValue,
                                                                                 Integer businessObjectDataVersion,
                                                                                 String storageName,
                                                                                 String subPartitionValues)
                                                                          throws ApiException

getStorageUnitDownloadCredential Gets the AWS credential to download to the specified storage unit. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

partitionValue - the partition value

businessObjectDataVersion - the business object data version

storageName - the storage name

subPartitionValues - the sub-partition values

Returns:

StorageUnitDownloadCredential

Throws:

ApiException

storageUnitGetStorageUnitUploadCredential

public StorageUnitUploadCredential storageUnitGetStorageUnitUploadCredential(String namespace,
                                                                             String businessObjectDefinitionName,
                                                                             String businessObjectFormatUsage,
                                                                             String businessObjectFormatFileType,
                                                                             Integer businessObjectFormatVersion,
                                                                             String partitionValue,
                                                                             Integer businessObjectDataVersion,
                                                                             String storageName,
                                                                             String subPartitionValues)
                                                                      throws ApiException

getStorageUnitUploadCredential Gets the AWS credential to upload to the specified storage unit. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

partitionValue - the partition value

businessObjectDataVersion - the business object data version

storageName - the storage name

subPartitionValues - the sub-partition values

Returns:

StorageUnitUploadCredential

Throws:

ApiException