@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2017-02-24T15:10:39.441-05:00") public class BusinessObjectDataApi extends Object
| Constructor and Description |
|---|
BusinessObjectDataApi() |
BusinessObjectDataApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
BusinessObjectDataAvailability |
businessObjectDataCheckBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest)
checkBusinessObjectDataAvailability
Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.
|
BusinessObjectDataAvailabilityCollectionResponse |
businessObjectDataCheckBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest)
checkBusinessObjectDataAvailabilityCollection
Performs an availability check for a collection of business object data.
|
BusinessObjectData |
businessObjectDataCreateBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest)
createBusinessObjectData
Creates (i.e.
|
BusinessObjectData |
businessObjectDataDeleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
Boolean deleteFiles)
deleteBusinessObjectData
Deletes an existing business object data without subpartition values with namespace.
|
BusinessObjectData |
businessObjectDataDeleteBusinessObjectData1(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
deleteBusinessObjectData
Deletes an existing business object data with 1 subpartition value with namespace.
|
BusinessObjectData |
businessObjectDataDeleteBusinessObjectData2(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
String subPartition4Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
deleteBusinessObjectData
Deletes an existing business object data with 4 subpartition values with namespace.
|
BusinessObjectData |
businessObjectDataDeleteBusinessObjectData3(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
deleteBusinessObjectData
Deletes an existing business object data with 3 subpartition values with namespace <p> Requires WRITE permission on namespace </p>
|
BusinessObjectData |
businessObjectDataDeleteBusinessObjectData4(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
deleteBusinessObjectData
Deletes an existing business object data with 2 subpartition values with namespace.
|
BusinessObjectDataDdl |
businessObjectDataGenerateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest)
generateBusinessObjectDataDdl
Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage.
|
BusinessObjectDataDdlCollectionResponse |
businessObjectDataGenerateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest)
generateBusinessObjectDataDdlCollection
Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storage.
|
BusinessObjectData |
businessObjectDataGetBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
String partitionKey,
String partitionValue,
String subPartitionValues,
Integer businessObjectFormatVersion,
Integer businessObjectDataVersion,
String businessObjectDataStatus,
Boolean includeBusinessObjectDataStatusHistory)
getBusinessObjectData
Retrieves existing business object data entry information.
|
BusinessObjectDataVersions |
businessObjectDataGetBusinessObjectDataVersions(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
String partitionValue,
String subPartitionValues,
Integer businessObjectFormatVersion,
Integer businessObjectDataVersion)
getBusinessObjectDataVersions
Retrieves a list of existing business object data versions.
|
S3KeyPrefixInformation |
businessObjectDataGetS3KeyPrefix(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionKey,
String partitionValue,
String subPartitionValues,
Integer businessObjectDataVersion,
String storageName,
Boolean createNewVersion)
Gets the S3 key prefix information for a specified namespace
<p> Gets the S3 key prefix for writing or accessing business object data.
|
BusinessObjectDataInvalidateUnregisteredResponse |
businessObjectDataInvalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)
invalidateUnregisteredBusinessObjectData
Registers data as INVALID for objects which exist in S3 but are not registered in herd.
|
BusinessObjectData |
businessObjectDataRestoreBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String subPartitionValues)
restoreBusinessObjectData
Initiates a restore request for a currently archived business object data.
|
BusinessObjectData |
businessObjectDataRetryStoragePolicyTransition(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
BusinessObjectDataRetryStoragePolicyTransitionRequest businessObjectDataRetryStoragePolicyTransitionRequest,
String subPartitionValues)
retryStoragePolicyTransition
Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation.
|
BusinessObjectDataSearchResult |
businessObjectDataSearchBusinessObjectData(BusinessObjectDataSearchRequest businessObjectDataSearchRequest)
searchBusinessObjectData
Searches business object data based on namespace, definition name, format usage, file type, and format version.
|
ApiClient |
getApiClient() |
void |
setApiClient(ApiClient apiClient) |
public BusinessObjectDataApi()
public BusinessObjectDataApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public BusinessObjectData businessObjectDataCreateBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest) throws ApiException
businessObjectDataCreateRequest - the information needed to create the business object dataApiExceptionpublic BusinessObjectDataAvailability businessObjectDataCheckBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest) throws ApiException
businessObjectDataAvailabilityRequest - the business object data availability requestApiExceptionpublic BusinessObjectDataAvailabilityCollectionResponse businessObjectDataCheckBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest) throws ApiException
businessObjectDataAvailabilityCollectionRequest - the business object data availability collection requestApiExceptionpublic BusinessObjectDataDdl businessObjectDataGenerateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest) throws ApiException
businessObjectDataDdlRequest - the business object data DDL requestApiExceptionpublic BusinessObjectDataDdlCollectionResponse businessObjectDataGenerateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest) throws ApiException
businessObjectDataDdlCollectionRequest - the business object data DDL collection requestApiExceptionpublic BusinessObjectData businessObjectDataGetBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String partitionKey, String partitionValue, String subPartitionValues, Integer businessObjectFormatVersion, Integer businessObjectDataVersion, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typepartitionKey - the partition key of the business object format. When specified, the partition key is validated against the partition key associated with the relative business object formatpartitionValue - the partition value of the business object datasubPartitionValues - the list of sub-partition values delimited by \"|\" (delimiter can be escaped by \"\\")businessObjectFormatVersion - the version of the business object format. When the business object format version is not specified, the business object data with the latest business format version available for the specified partition values is returnedbusinessObjectDataVersion - the version of the business object data. When business object data version is not specified, the latest version of business object data of the specified business object data status is returnedbusinessObjectDataStatus - the status of the business object data. When business object data version is specified, this parameter is ignored. Default value is \"VALID\"includeBusinessObjectDataStatusHistory - specifies to include business object data status history in the responseApiExceptionpublic BusinessObjectData businessObjectDataDeleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, Boolean deleteFiles) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuebusinessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deletedApiExceptionpublic BusinessObjectData businessObjectDataDeleteBusinessObjectData1(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, Integer businessObjectDataVersion, Boolean deleteFiles) throws ApiException
namespace - the namespace.businessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deletedApiExceptionpublic BusinessObjectData businessObjectDataDeleteBusinessObjectData4(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, Integer businessObjectDataVersion, Boolean deleteFiles) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deletedApiExceptionpublic BusinessObjectData businessObjectDataDeleteBusinessObjectData3(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, Integer businessObjectDataVersion, Boolean deleteFiles) throws ApiException
namespace - the namespace.businessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2subPartition3Value - sub-partition value 3businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deletedApiExceptionpublic BusinessObjectData businessObjectDataDeleteBusinessObjectData2(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, String subPartition4Value, Integer businessObjectDataVersion, Boolean deleteFiles) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2subPartition3Value - sub-partition value 3subPartition4Value - sub-partition value 4businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deletedApiExceptionpublic S3KeyPrefixInformation businessObjectDataGetS3KeyPrefix(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionKey, String partitionValue, String subPartitionValues, Integer businessObjectDataVersion, String storageName, Boolean createNewVersion) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionKey - the partition keypartitionValue - the partition valuesubPartitionValues - the list of sub-partition valuesbusinessObjectDataVersion - the business object data versionstorageName - the storage namecreateNewVersion - Whether a new business object data can be createdApiExceptionpublic BusinessObjectDataVersions businessObjectDataGetBusinessObjectDataVersions(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String partitionValue, String subPartitionValues, Integer businessObjectFormatVersion, Integer businessObjectDataVersion) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typepartitionValue - the partition valuesubPartitionValues - the list of sub-partition valuesbusinessObjectFormatVersion - the business object format versionbusinessObjectDataVersion - the business object data versionApiExceptionpublic BusinessObjectData businessObjectDataRestoreBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String subPartitionValues) throws ApiException
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition value of the business object databusinessObjectDataVersion - the version of the business object datasubPartitionValues - the list of sub-partition values delimited by \"|\" (delimiter can be escaped by \"\\")ApiExceptionpublic BusinessObjectData businessObjectDataRetryStoragePolicyTransition(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, BusinessObjectDataRetryStoragePolicyTransitionRequest businessObjectDataRetryStoragePolicyTransitionRequest, String subPartitionValues) throws ApiException
namespace - the namespace of the business object definitionbusinessObjectDefinitionName - the name of the business object definitionbusinessObjectFormatUsage - the usage of the business object formatbusinessObjectFormatFileType - the file type of the business object formatbusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition value of the business object databusinessObjectDataVersion - the version of the business object databusinessObjectDataRetryStoragePolicyTransitionRequest - the information needed to retry a storage policy transitionsubPartitionValues - the optional list of sub-partition values delimited by \"|\" (delimiter can be escaped by \"\\")ApiExceptionpublic BusinessObjectDataSearchResult businessObjectDataSearchBusinessObjectData(BusinessObjectDataSearchRequest businessObjectDataSearchRequest) throws ApiException
businessObjectDataSearchRequest - search requestApiExceptionpublic BusinessObjectDataInvalidateUnregisteredResponse businessObjectDataInvalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest) throws ApiException
businessObjectDataInvalidateUnregisteredRequest - the business object data invalidate un-register requestApiExceptionCopyright © 2017. All rights reserved.