Package org.openstack4j.api.compute

Interface QuotaSetService

All Superinterfaces:

RestService

All Known Implementing Classes:

QuotaSetServiceImpl

public interface QuotaSetService
extends RestService

OpenStack Quota-Set Operation API

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method	Description
QuotaSet	get(String tenantId)	Gets the QuotaSet for the given tenant ID
QuotaSet	get(String tenantId, String userId)	Gets the QuotaSet for the given tenant and user ID
ComputeQuotaDetail	getDetail(String tenantId)	Gets the QuotaSetDetail for the given tenant ID
SimpleTenantUsage	getTenantUsage(String tenantId)	Gets the usage information for the specified tenant (os-simple-tenant-usage)
SimpleTenantUsage	getTenantUsage(String tenantId, String startTime, String endTime)	Gets the usage information for the specified tenant in a period of time (os-simple-tenant-usage)
Limits	limits()	Accounts may be pre-configured with a set of thresholds (or limits) to manage capacity and prevent system abuse.
List<? extends SimpleTenantUsage>	listTenantUsages()	Gets tenant usage information for all tenants (os-simple-tenant-usage)
List<? extends SimpleTenantUsage>	listTenantUsages(String startTime, String endTime)	Gets tenant usage information for all tenants in a period of time (os-simple-tenant-usage)
QuotaSet	updateForClass(String classId, QuotaSetUpdate qs)	Updates quota for a specified class
QuotaSet	updateForTenant(String tenantId, QuotaSetUpdate qs)	Updates quota for a specified tenant

Method Detail

get

QuotaSet get(String tenantId)

Gets the QuotaSet for the given tenant ID

Parameters:

tenantId - the tenant id

Returns:

the quota set

get

QuotaSet get(String tenantId,
             String userId)

Gets the QuotaSet for the given tenant and user ID

Parameters:

tenantId - the identifier for the tenant

userId - the identifier of the user

Returns:

the quota set

getDetail

ComputeQuotaDetail getDetail(String tenantId)

Gets the QuotaSetDetail for the given tenant ID

Parameters:

tenantId - the tenant id

Returns:

the quota set detail

updateForClass

QuotaSet updateForClass(String classId,
                        QuotaSetUpdate qs)

Updates quota for a specified class

Parameters:

classId - the class identifier

qs - the quota set - see Builders.quotaSet()

Returns:

the newly reflected QuotaSet

updateForTenant

QuotaSet updateForTenant(String tenantId,
                         QuotaSetUpdate qs)

Updates quota for a specified tenant

Parameters:

tenantId - the tenant identifier

qs - the quota set - see Builders.quotaSet()

Returns:

the newly reflected QuotaSet

limits

Limits limits()

Accounts may be pre-configured with a set of thresholds (or limits) to manage capacity and prevent system abuse. This call will return the current Rate and Absolute Limits.

Returns:

the system limits

listTenantUsages

List<? extends SimpleTenantUsage> listTenantUsages()

Gets tenant usage information for all tenants (os-simple-tenant-usage)

Returns:

list of usage information for all tenants

getTenantUsage

SimpleTenantUsage getTenantUsage(String tenantId)

Gets the usage information for the specified tenant (os-simple-tenant-usage)

Parameters:

tenantId - the tenant identifier

Returns:

Tenant Usage or null if not found

listTenantUsages

List<? extends SimpleTenantUsage> listTenantUsages(String startTime,
                                                   String endTime)

Gets tenant usage information for all tenants in a period of time (os-simple-tenant-usage)

Parameters:

startTime - eg:2015-05-05T23:59:59

Returns:

list of usage information for all tenants

getTenantUsage

SimpleTenantUsage getTenantUsage(String tenantId,
                                 String startTime,
                                 String endTime)

Gets the usage information for the specified tenant in a period of time (os-simple-tenant-usage)

Parameters:

tenantId - the tenant identifier

startTime - eg:2015-05-05T23:59:59

Returns:

Tenant Usage or null if not found