com.appdirect.sdk.meteredusage.service

Interface MeteredUsageApiClientService

All Known Implementing Classes:

MeteredUsageApiClientServiceImpl

public interface MeteredUsageApiClientService

Method Summary

Modifier and Type	Method and Description
APIResult	reportUsage(String baseUrl, List<MeteredUsageItem> meteredUsageItems, boolean billable, String secretKey, String secret) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, MeteredUsageItem meteredUsageItem, boolean billable, String secretKey, String secret) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, MeteredUsageItem meteredUsageItem, boolean billable, String secretKey, String secret, String sourceType) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, List<MeteredUsageItem> meteredUsageItems, boolean billable) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String idempotentKey, List<MeteredUsageItem> meteredUsageItems, boolean billable, String secretKey, String secret, String sourceType) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, MeteredUsageItem meteredUsageItem, boolean billable) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, MeteredUsageItem meteredUsageItem, boolean billable, String sourceType) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String idempotentKey, MeteredUsageItem meteredUsageItem, boolean billable, String secretKey, String secret) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, String idempotentKey, List<MeteredUsageItem> meteredUsageItems, boolean billable) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, String idempotentKey, List<MeteredUsageItem> meteredUsageItems, boolean billable, String sourceType) Calls the Metered Usage API Endpoint to bill usages.
APIResult	reportUsage(String baseUrl, String secretKey, String idempotentKey, MeteredUsageItem meteredUsageItem, boolean billable) Calls the Metered Usage API Endpoint to bill usages.
APIResult	retryableReportUsage(String baseUrl, String idempotentKey, List<MeteredUsageItem> meteredUsageItems, String secretKey, boolean billable, String sourceType)

Method Detail

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      String idempotentKey,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

idempotentKey - to make unique calls

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      List<MeteredUsageItem> meteredUsageItems,
                      boolean billable)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItems - list of usages to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      String idempotentKey,
                      List<MeteredUsageItem> meteredUsageItems,
                      boolean billable)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

idempotentKey - to make unique calls

meteredUsageItems - list of usages to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      String idempotentKey,
                      List<MeteredUsageItem> meteredUsageItems,
                      boolean billable,
                      String sourceType)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

idempotentKey - to make unique calls

meteredUsageItems - list of usages to be reported

billable - specifies if the usage to be reported is billable or estimated

sourceType - specifies the type of source that generate the report (ex. aws, azure_csp, azure_modern)

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String idempotentKey,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable,
                      String secretKey,
                      String secret)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

idempotentKey - to make unique calls

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable,
                      String secretKey,
                      String secret)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable,
                      String secretKey,
                      String secret,
                      String sourceType)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

sourceType - specifies the type of source that generate the report (ex. aws, azure_csp, azure_modern)

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      List<MeteredUsageItem> meteredUsageItems,
                      boolean billable,
                      String secretKey,
                      String secret)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItems - list of usages to be reported

billable - specifies if the usage to be reported is billable or estimated

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String idempotentKey,
                      List<MeteredUsageItem> meteredUsageItems,
                      boolean billable,
                      String secretKey,
                      String secret,
                      String sourceType)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

idempotentKey - to make unique calls

meteredUsageItems - list of usages to be reported

billable - specifies if the usage to be reported is billable or estimated

sourceType - specifies the type of source that generate the report (ex. aws, azure_csp, azure_modern)

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

reportUsage

APIResult reportUsage(String baseUrl,
                      String secretKey,
                      MeteredUsageItem meteredUsageItem,
                      boolean billable,
                      String sourceType)

Calls the Metered Usage API Endpoint to bill usages. This should be used instead of AppmarketBillingClient as this replaces the old API version.

Parameters:

baseUrl - from the request

secretKey - to sign the request

meteredUsageItem - usage instance to be reported

billable - specifies if the usage to be reported is billable or estimated

sourceType - specifies the type of source that generate the report (ex. aws, azure_csp, azure_modern)

Returns:

an APIResult instance representing the marketplace response

throws an MeteredUsageApiException to the client with an error code and a status:

retryableReportUsage

@Retryable(value={ServiceException.class,MeteredUsageApiException.class,java.lang.RuntimeException.class},
           exclude=MeterUsageServiceException.class,
           maxAttemptsExpression="#{${usage.api.retry.maxAttempts:3}}",
           backoff=@Backoff(delayExpression="#{${usage.api.retry.backoff.delay:2000}}",multiplierExpression="#{${usage.api.retry.backoff.multiplier:2}}",maxDelayExpression="#{${usage.api.retry.backoff.maxDelay:30000}}"))
APIResult retryableReportUsage(String baseUrl,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    String idempotentKey,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List<MeteredUsageItem> meteredUsageItems,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    String secretKey,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean billable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    String sourceType)