org.finra.herd.sdk.api

Class UploadAndDownloadApi

java.lang.Object

org.finra.herd.sdk.api.UploadAndDownloadApi

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

Constructor Summary

Constructors

Constructor and Description
UploadAndDownloadApi()
UploadAndDownloadApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
UploadSingleCredentialExtensionResponse	uploadandDownloadExtendUploadSingleCredentials(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) extendUploadSingleCredentials Extends the credentials for a previously initiated upload.
DownloadSingleInitiationResponse	uploadandDownloadInitiateDownloadSingle(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) initiateDownloadSingle Initiates a download of a single file.
DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse	uploadandDownloadInitiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest) initiateDownloadSingleSampleFile Download a single business object definition sample file
UploadBusinessObjectDefinitionSampleDataFileInitiationResponse	uploadandDownloadInitiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest) initiateUploadSampleFile Provide the location and credentials prior to upload a Sample Data file
UploadSingleInitiationResponse	uploadandDownloadInitiateUploadSingle(UploadSingleInitiationRequest uploadSingleInitiationRequest) initiateUploadSingle Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadAndDownloadApi

public UploadAndDownloadApi()

UploadAndDownloadApi

public UploadAndDownloadApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

uploadandDownloadInitiateDownloadSingleSampleFile

public DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse uploadandDownloadInitiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest)
                                                                                                                         throws ApiException

initiateDownloadSingleSampleFile Download a single business object definition sample file

Parameters:

downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest -

Returns:

DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse

Throws:

ApiException

uploadandDownloadInitiateDownloadSingle

public DownloadSingleInitiationResponse uploadandDownloadInitiateDownloadSingle(String namespace,
                                                                                String businessObjectDefinitionName,
                                                                                String businessObjectFormatUsage,
                                                                                String businessObjectFormatFileType,
                                                                                Integer businessObjectFormatVersion,
                                                                                String partitionValue,
                                                                                Integer businessObjectDataVersion)
                                                                         throws ApiException

initiateDownloadSingle Initiates a download of a single file. <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.

Returns:

DownloadSingleInitiationResponse

Throws:

ApiException

uploadandDownloadInitiateUploadSampleFile

public UploadBusinessObjectDefinitionSampleDataFileInitiationResponse uploadandDownloadInitiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest)
                                                                                                         throws ApiException

initiateUploadSampleFile Provide the location and credentials prior to upload a Sample Data file

Parameters:

uploadBusinessObjectDefinitionSampleDataFileInitiationRequest - request to upload

Returns:

UploadBusinessObjectDefinitionSampleDataFileInitiationResponse

Throws:

ApiException

uploadandDownloadExtendUploadSingleCredentials

public UploadSingleCredentialExtensionResponse uploadandDownloadExtendUploadSingleCredentials(String namespace,
                                                                                              String businessObjectDefinitionName,
                                                                                              String businessObjectFormatUsage,
                                                                                              String businessObjectFormatFileType,
                                                                                              Integer businessObjectFormatVersion,
                                                                                              String partitionValue,
                                                                                              Integer businessObjectDataVersion)
                                                                                       throws ApiException

extendUploadSingleCredentials Extends the credentials for a previously initiated upload. <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.

Returns:

UploadSingleCredentialExtensionResponse

Throws:

ApiException

uploadandDownloadInitiateUploadSingle

public UploadSingleInitiationResponse uploadandDownloadInitiateUploadSingle(UploadSingleInitiationRequest uploadSingleInitiationRequest)
                                                                     throws ApiException

initiateUploadSingle Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage. <p>Requires WRITE permission on namespace</p>

Parameters:

uploadSingleInitiationRequest - the information needed to initiate a file upload

Returns:

UploadSingleInitiationResponse

Throws:

ApiException