Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* herd-external
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* OpenAPI spec version: 0.125.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.finra.herd.sdk.api;
import com.sun.jersey.api.client.GenericType;
import org.finra.herd.sdk.invoker.ApiException;
import org.finra.herd.sdk.invoker.ApiClient;
import org.finra.herd.sdk.invoker.Configuration;
import org.finra.herd.sdk.model.*;
import org.finra.herd.sdk.invoker.Pair;
import org.finra.herd.sdk.model.BusinessObjectData;
import org.finra.herd.sdk.model.BusinessObjectDataAvailability;
import org.finra.herd.sdk.model.BusinessObjectDataAvailabilityRequest;
import org.finra.herd.sdk.model.BusinessObjectDataDdl;
import org.finra.herd.sdk.model.BusinessObjectDataDdlRequest;
import org.finra.herd.sdk.model.BusinessObjectDataSearchRequest;
import org.finra.herd.sdk.model.BusinessObjectDataSearchResult;
import org.finra.herd.sdk.model.BusinessObjectDataVersions;
import org.finra.herd.sdk.model.ErrorInformation;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2020-07-16T17:44:47.669-04:00[America/New_York]")
public class BusinessObjectDataApi {
private ApiClient apiClient;
public BusinessObjectDataApi() {
this(Configuration.getDefaultApiClient());
}
public BusinessObjectDataApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* 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. <p> Requires READ permission on namespace </p>
* @param businessObjectDataAvailabilityRequest the business object data availability request (required)
* @return BusinessObjectDataAvailability
* @throws ApiException if fails to make API call
*/
public BusinessObjectDataAvailability businessObjectDataCheckBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest) throws ApiException {
Object localVarPostBody = businessObjectDataAvailabilityRequest;
// verify the required parameter 'businessObjectDataAvailabilityRequest' is set
if (businessObjectDataAvailabilityRequest == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectDataAvailabilityRequest' when calling businessObjectDataCheckBusinessObjectDataAvailability");
}
// create path and map variables
String localVarPath = "/businessObjectData/availability";
// query params
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/xml", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/xml", "application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* 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. <p> Requires READ permission on namespace </p>
* @param businessObjectDataDdlRequest the business object data DDL request (required)
* @return BusinessObjectDataDdl
* @throws ApiException if fails to make API call
*/
public BusinessObjectDataDdl businessObjectDataGenerateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest) throws ApiException {
Object localVarPostBody = businessObjectDataDdlRequest;
// verify the required parameter 'businessObjectDataDdlRequest' is set
if (businessObjectDataDdlRequest == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectDataDdlRequest' when calling businessObjectDataGenerateBusinessObjectDataDdl");
}
// create path and map variables
String localVarPath = "/businessObjectData/generateDdl";
// query params
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/xml", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/xml", "application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* getBusinessObjectData
* Retrieves existing business object data entry information. <p/> NOTE: When both business object format version and business object data version are not specified, the business object format version has the precedence. The latest business object format version is determined by a sub-query, which does the following: <p> <ul> <li>selects all available data for the specified business object format (disregarding business object format version), partition values, and business object data status (default is \"VALID\") <li>gets the latest business object format version from the records selected in the previous step </ul> <p> <p> Requires READ permission on namespace </p>
* @param namespace the namespace (required)
* @param businessObjectDefinitionName the business object definition name (required)
* @param businessObjectFormatUsage the business object format usage (required)
* @param businessObjectFormatFileType the business object format file type (required)
* @param partitionKey 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 format (optional)
* @param partitionValue the partition value of the business object data (optional)
* @param subPartitionValues the list of sub-partition values delimited by \"|\" (delimiter can be escaped by \"\\\") (optional)
* @param 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 returned (optional)
* @param businessObjectDataVersion 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 returned (optional)
* @param businessObjectDataStatus the status of the business object data. When business object data version is specified, this parameter is ignored. Default value is \"VALID\" (optional)
* @param includeBusinessObjectDataStatusHistory specifies to include business object data status history in the response (optional)
* @param includeStorageUnitStatusHistory specifies to include storage unit status history for each storage unit in the response (optional)
* @param excludeBusinessObjectDataStorageFiles specifies to exclude storage files in the response (optional)
* @return BusinessObjectData
* @throws ApiException if fails to make API call
*/
public BusinessObjectData businessObjectDataGetBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String partitionKey, String partitionValue, String subPartitionValues, Integer businessObjectFormatVersion, Integer businessObjectDataVersion, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory, Boolean excludeBusinessObjectDataStorageFiles) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'namespace' is set
if (namespace == null) {
throw new ApiException(400, "Missing the required parameter 'namespace' when calling businessObjectDataGetBusinessObjectData");
}
// verify the required parameter 'businessObjectDefinitionName' is set
if (businessObjectDefinitionName == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectDefinitionName' when calling businessObjectDataGetBusinessObjectData");
}
// verify the required parameter 'businessObjectFormatUsage' is set
if (businessObjectFormatUsage == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectFormatUsage' when calling businessObjectDataGetBusinessObjectData");
}
// verify the required parameter 'businessObjectFormatFileType' is set
if (businessObjectFormatFileType == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectFormatFileType' when calling businessObjectDataGetBusinessObjectData");
}
// create path and map variables
String localVarPath = "/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}"
.replaceAll("\\{" + "namespace" + "\\}", apiClient.escapeString(namespace.toString()))
.replaceAll("\\{" + "businessObjectDefinitionName" + "\\}", apiClient.escapeString(businessObjectDefinitionName.toString()))
.replaceAll("\\{" + "businessObjectFormatUsage" + "\\}", apiClient.escapeString(businessObjectFormatUsage.toString()))
.replaceAll("\\{" + "businessObjectFormatFileType" + "\\}", apiClient.escapeString(businessObjectFormatFileType.toString()));
// query params
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("partitionKey", partitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("partitionValue", partitionValue));
localVarQueryParams.addAll(apiClient.parameterToPair("subPartitionValues", subPartitionValues));
localVarQueryParams.addAll(apiClient.parameterToPair("businessObjectFormatVersion", businessObjectFormatVersion));
localVarQueryParams.addAll(apiClient.parameterToPair("businessObjectDataVersion", businessObjectDataVersion));
localVarQueryParams.addAll(apiClient.parameterToPair("businessObjectDataStatus", businessObjectDataStatus));
localVarQueryParams.addAll(apiClient.parameterToPair("includeBusinessObjectDataStatusHistory", includeBusinessObjectDataStatusHistory));
localVarQueryParams.addAll(apiClient.parameterToPair("includeStorageUnitStatusHistory", includeStorageUnitStatusHistory));
localVarQueryParams.addAll(apiClient.parameterToPair("excludeBusinessObjectDataStorageFiles", excludeBusinessObjectDataStorageFiles));
final String[] localVarAccepts = {
"application/xml", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* getBusinessObjectDataVersions
* Retrieves a list of existing business object data versions. <p> Requires READ permission on namespace </p>
* @param namespace the namespace (required)
* @param businessObjectDefinitionName the business object definition name (required)
* @param businessObjectFormatUsage the business object format usage (required)
* @param businessObjectFormatFileType the business object format file type (required)
* @param partitionValue the partition value (optional)
* @param subPartitionValues the list of sub-partition values (optional)
* @param businessObjectFormatVersion the business object format version (optional)
* @param businessObjectDataVersion the business object data version (optional)
* @return BusinessObjectDataVersions
* @throws ApiException if fails to make API call
*/
public BusinessObjectDataVersions businessObjectDataGetBusinessObjectDataVersions(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String partitionValue, String subPartitionValues, Integer businessObjectFormatVersion, Integer businessObjectDataVersion) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'namespace' is set
if (namespace == null) {
throw new ApiException(400, "Missing the required parameter 'namespace' when calling businessObjectDataGetBusinessObjectDataVersions");
}
// verify the required parameter 'businessObjectDefinitionName' is set
if (businessObjectDefinitionName == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectDefinitionName' when calling businessObjectDataGetBusinessObjectDataVersions");
}
// verify the required parameter 'businessObjectFormatUsage' is set
if (businessObjectFormatUsage == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectFormatUsage' when calling businessObjectDataGetBusinessObjectDataVersions");
}
// verify the required parameter 'businessObjectFormatFileType' is set
if (businessObjectFormatFileType == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectFormatFileType' when calling businessObjectDataGetBusinessObjectDataVersions");
}
// create path and map variables
String localVarPath = "/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/versions"
.replaceAll("\\{" + "namespace" + "\\}", apiClient.escapeString(namespace.toString()))
.replaceAll("\\{" + "businessObjectDefinitionName" + "\\}", apiClient.escapeString(businessObjectDefinitionName.toString()))
.replaceAll("\\{" + "businessObjectFormatUsage" + "\\}", apiClient.escapeString(businessObjectFormatUsage.toString()))
.replaceAll("\\{" + "businessObjectFormatFileType" + "\\}", apiClient.escapeString(businessObjectFormatFileType.toString()));
// query params
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("partitionValue", partitionValue));
localVarQueryParams.addAll(apiClient.parameterToPair("subPartitionValues", subPartitionValues));
localVarQueryParams.addAll(apiClient.parameterToPair("businessObjectFormatVersion", businessObjectFormatVersion));
localVarQueryParams.addAll(apiClient.parameterToPair("businessObjectDataVersion", businessObjectDataVersion));
final String[] localVarAccepts = {
"application/xml", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* searchBusinessObjectData
* Searches business object data based on namespace, definition name, format usage, file type, and format version. <p> Namespace and definition name are required. </p> <p> Requires READ permission on namespace </p> <p> The response contains the following HTTP headers: <ul> <li>Paging-MaxResultsPerPage - the HTTP header for the maximum number of results that will be returned on any page of data. The \"pageSize\" query parameter should not be greater than this value or an HTTP status of 400 (Bad Request) error would be returned</li> <li>Paging-PageCount - the HTTP header for the total number of pages that exist assuming a page size limit and the total records returned in the query</li> <li>Paging-PageNum - the HTTP header for the current page number being returned. For the first page, this value would be \"1\"</li> <li>Paging-PageSize - the HTTP header for the current page size limit. This is based on what is specified in the request \"pageSize\" query parameter</li> <li>Paging-TotalRecordsOnPage - the HTTP header for the total number of records returned on the current page. This could be less than the \"pageSize\" query parameter on the last page of data</li> <li>Paging-TotalRecordCount - the HTTP header for the total number of records that would be returned across all pages. This is basically a \"select count\" query</li> </ul> </p>
* @param businessObjectDataSearchRequest the business object data search request (required)
* @param pageNum the page number. If this parameter is specified, results contain the appropriate page that is specified. Page numbers are one-based - that is the first page number is one. Default value is 1 (optional)
* @param pageSize the page size. If pageSize parameter is specified, results contain that number of business object data (unless it is the end of the result set). Default value is 1000 (optional)
* @return BusinessObjectDataSearchResult
* @throws ApiException if fails to make API call
*/
public BusinessObjectDataSearchResult businessObjectDataSearchBusinessObjectData(BusinessObjectDataSearchRequest businessObjectDataSearchRequest, Integer pageNum, Integer pageSize) throws ApiException {
Object localVarPostBody = businessObjectDataSearchRequest;
// verify the required parameter 'businessObjectDataSearchRequest' is set
if (businessObjectDataSearchRequest == null) {
throw new ApiException(400, "Missing the required parameter 'businessObjectDataSearchRequest' when calling businessObjectDataSearchBusinessObjectData");
}
// create path and map variables
String localVarPath = "/businessObjectData/search";
// query params
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("pageNum", pageNum));
localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize));
final String[] localVarAccepts = {
"application/xml", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/xml", "application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
}
