Package co.cloudcraft.api

Class BudgetApi

java.lang.Object

co.cloudcraft.api.ApiBase

co.cloudcraft.api.BudgetApi

public class BudgetApi
extends ApiBase

Nested Class Summary

Nested classes/interfaces inherited from class co.cloudcraft.api.ApiBase

ApiBase.BlueprintExportFormat, ApiBase.BudgetExportFormat

Field Summary

Fields inherited from class co.cloudcraft.api.ApiBase

CONTENT_TYPE_HEADER_MAP, restClient

Constructor Summary

Constructors

Constructor	Description
BudgetApi(RestClient restClient)

Method Summary

Modifier and Type	Method	Description
CloudcraftResponse	export(@NonNull String blueprintId, @NonNull ApiBase.BudgetExportFormat format, ExportBudgetQueryParams requestParams)	Export budget for blueprint in CSV or XLSX format.

Methods inherited from class java.lang.Object

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

Constructor Details

BudgetApi

public BudgetApi(RestClient restClient)

Method Details

export

public CloudcraftResponse export(@NonNull
 @NonNull String blueprintId,
 @NonNull
 @NonNull ApiBase.BudgetExportFormat format,
 ExportBudgetQueryParams requestParams)
                          throws CloudcraftException

Export budget for blueprint in CSV or XLSX format. Consumer of this API can extract the response using the convenience APIs in CloudcraftResponse either in String or byte[] format.

Parameters:

blueprintId - blueprint identifier

format - one of CSV or XLSX format

requestParams - Optional query parameters for the configuring the response

Returns:

Response object

Throws:

CloudcraftException - when any error occurs exercising this API