com.sap.cloud.sdk.cloudplatform.metering

Class MeteringStats

java.lang.Object

com.sap.cloud.sdk.cloudplatform.metering.MeteringStats

public class MeteringStats
extends Object

Stores access numbers to the different APIs.

Constructor Summary

Constructors

Constructor and Description
MeteringStats(String serviceId, Role meteringRole, String meteringServiceDestinationName) Initializes a new MeteringStats with the given service id, role and metering service destination name.

Method Summary

Modifier and Type	Method and Description
long	getApiCountsFor(TenantMetricKeyPair key) Getter for the current number of API accesses.
long	getDistinctApiCounts() Number of metric key stored.
long	getSumOfApiCounts() Aggregates the number of API accesses over all entries.
long	record(TenantMetricKeyPair key) Record a single access by the tenant to the API specified by the key.
long	record(TenantMetricKeyPair key, long increment) Record a specified number accesses by a the tenant to the API specified by the key.
void	sendToMeteringService() Sends the stored data to the metering service.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeteringStats

public MeteringStats(String serviceId,
                     Role meteringRole,
                     String meteringServiceDestinationName)

Initializes a new MeteringStats with the given service id, role and metering service destination name.

Parameters:

serviceId - The id needed for the metering service.

meteringRole - The role needed to obtain tenant information.

meteringServiceDestinationName - The name of the metering destination.

Method Detail

record

public long record(TenantMetricKeyPair key)

Record a single access by the tenant to the API specified by the key.

Parameters:

key - The metric key.

Returns:

The updated number of accesses.

record

public long record(TenantMetricKeyPair key,
                   long increment)

Record a specified number accesses by a the tenant to the API specified by the key.

Parameters:

key - The metric key.

increment - The number of API accesses to record.

Returns:

The updated number of accesses.

getApiCountsFor

public long getApiCountsFor(TenantMetricKeyPair key)

Getter for the current number of API accesses.

Parameters:

key - The metric key to get the number of accesses for.

Returns:

The number of accesses of the tenant to the API specified by the key.

getSumOfApiCounts

public long getSumOfApiCounts()

Aggregates the number of API accesses over all entries.

Returns:

The number of overall API accesses.

getDistinctApiCounts

public long getDistinctApiCounts()

Number of metric key stored.

Returns:

The number of stored metric keys.

sendToMeteringService

public void sendToMeteringService()
                           throws TenantNotAvailableException,
                                  TenantAccessException

Sends the stored data to the metering service.

Throws:

TenantNotAvailableException - If there is currently no Tenant available. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

TenantAccessException - If there is an issue while accessing the Tenant.