org.finra.herd.sdk.api

Class BusinessObjectFormatApi

java.lang.Object

org.finra.herd.sdk.api.BusinessObjectFormatApi

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

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatApi()
BusinessObjectFormatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormat	businessObjectFormatCreateBusinessObjectFormat(BusinessObjectFormatCreateRequest businessObjectFormatCreateRequest) createBusinessObjectFormat Creates a new business object format.
BusinessObjectFormat	businessObjectFormatDeleteBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) deleteBusinessObjectFormat Deletes an existing business format.
BusinessObjectFormatDdl	businessObjectFormatGenerateBusinessObjectFormatDdl(BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest) generateBusinessObjectFormatDdl Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormatDdlCollectionResponse	businessObjectFormatGenerateBusinessObjectFormatDdlCollection(BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest) generateBusinessObjectFormatDdlCollection Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormat	businessObjectFormatGetBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) getBusinessObjectFormat Gets an existing business object format by alternate key.
BusinessObjectFormatKeys	businessObjectFormatGetBusinessObjectFormats(String namespace, String businessObjectDefinitionName, Boolean latestBusinessObjectFormatVersion) getBusinessObjectFormats Gets a list of business object formats for the specified business object definition name.
BusinessObjectFormat	businessObjectFormatUpdateBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, BusinessObjectFormatUpdateRequest businessObjectFormatUpdateRequest) updateBusinessObjectFormat Updates an existing business object format by alternate key.
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

BusinessObjectFormatApi

public BusinessObjectFormatApi()

BusinessObjectFormatApi

public BusinessObjectFormatApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

businessObjectFormatCreateBusinessObjectFormat

public BusinessObjectFormat businessObjectFormatCreateBusinessObjectFormat(BusinessObjectFormatCreateRequest businessObjectFormatCreateRequest)
                                                                    throws ApiException

createBusinessObjectFormat Creates a new business object format. <p>Requires WRITE permission on namespace</p>

Parameters:

businessObjectFormatCreateRequest - the information needed to create the business object format.

Returns:

BusinessObjectFormat

Throws:

ApiException

businessObjectFormatGenerateBusinessObjectFormatDdl

public BusinessObjectFormatDdl businessObjectFormatGenerateBusinessObjectFormatDdl(BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest)
                                                                            throws ApiException

generateBusinessObjectFormatDdl Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format. <p>Requires READ permission on namespace</p>

Parameters:

businessObjectFormatDdlRequest - the business object data DDL request

Returns:

BusinessObjectFormatDdl

Throws:

ApiException

businessObjectFormatGenerateBusinessObjectFormatDdlCollection

public BusinessObjectFormatDdlCollectionResponse businessObjectFormatGenerateBusinessObjectFormatDdlCollection(BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest)
                                                                                                        throws ApiException

generateBusinessObjectFormatDdlCollection Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating tables for a collection of business object formats. <p>Requires READ permission on ALL namespaces</p>

Parameters:

businessObjectFormatDdlCollectionRequest - the business object format DDL collection request

Returns:

BusinessObjectFormatDdlCollectionResponse

Throws:

ApiException

businessObjectFormatGetBusinessObjectFormats

public BusinessObjectFormatKeys businessObjectFormatGetBusinessObjectFormats(String namespace,
                                                                             String businessObjectDefinitionName,
                                                                             Boolean latestBusinessObjectFormatVersion)
                                                                      throws ApiException

getBusinessObjectFormats Gets a list of business object formats for the specified business object definition name.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

latestBusinessObjectFormatVersion -

Returns:

BusinessObjectFormatKeys

Throws:

ApiException

businessObjectFormatGetBusinessObjectFormat

public BusinessObjectFormat businessObjectFormatGetBusinessObjectFormat(String namespace,
                                                                        String businessObjectDefinitionName,
                                                                        String businessObjectFormatUsage,
                                                                        String businessObjectFormatFileType,
                                                                        Integer businessObjectFormatVersion)
                                                                 throws ApiException

getBusinessObjectFormat Gets an existing business object format by alternate key.

Parameters:

namespace - the namespace code

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

Returns:

BusinessObjectFormat

Throws:

ApiException

businessObjectFormatUpdateBusinessObjectFormat

public BusinessObjectFormat businessObjectFormatUpdateBusinessObjectFormat(String namespace,
                                                                           String businessObjectDefinitionName,
                                                                           String businessObjectFormatUsage,
                                                                           String businessObjectFormatFileType,
                                                                           Integer businessObjectFormatVersion,
                                                                           BusinessObjectFormatUpdateRequest businessObjectFormatUpdateRequest)
                                                                    throws ApiException

updateBusinessObjectFormat Updates an existing business object format by alternate key. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace code

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

businessObjectFormatUpdateRequest - the information needed to update the business object format

Returns:

BusinessObjectFormat

Throws:

ApiException

businessObjectFormatDeleteBusinessObjectFormat

public BusinessObjectFormat businessObjectFormatDeleteBusinessObjectFormat(String namespace,
                                                                           String businessObjectDefinitionName,
                                                                           String businessObjectFormatUsage,
                                                                           String businessObjectFormatFileType,
                                                                           Integer businessObjectFormatVersion)
                                                                    throws ApiException

deleteBusinessObjectFormat Deletes an existing business format. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace code

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

Returns:

BusinessObjectFormat

Throws:

ApiException