Package uk.ac.manchester.spinnaker.alloc

Class SpallocProperties.QuotaProperties

java.lang.Object

uk.ac.manchester.spinnaker.alloc.SpallocProperties.QuotaProperties

Enclosing class:

SpallocProperties

public static class SpallocProperties.QuotaProperties
extends Object

Quota management.

Constructor Summary

Constructors

Constructor	Description
QuotaProperties(int defaultQuota, long defaultOrgQuota, long defaultCollabQuota, String consolidationSchedule, String nmpiUrl, String nmpiApiKey, String nmpiPlatform)

Method Summary

Modifier and Type	Method	Description
@NotBlank String	getConsolidationSchedule()
long	getDefaultCollabQuota()	Default quota for collabratories.
long	getDefaultOrgQuota()	Default quota for organisations.
@jakarta.validation.constraints.PositiveOrZero int	getDefaultQuota()	Default user quota in board-seconds.
String	getNMPIApiKey()
String	getNMPIPlaform()
String	getNMPIUrl()

Methods inherited from class java.lang.Object

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

Constructor Details

QuotaProperties

@ConstructorBinding
public QuotaProperties(@DefaultValue("100")
 int defaultQuota,
 @DefaultValue("0")
 long defaultOrgQuota,
 @DefaultValue("3600000")
 long defaultCollabQuota,
 @DefaultValue("0 0 * * * *")
 String consolidationSchedule,
 @DefaultValue("")
 String nmpiUrl,
 @DefaultValue("")
 String nmpiApiKey,
 @DefaultValue("SpiNNaker")
 String nmpiPlatform)

Parameters:

defaultQuota - Default user quota in board-seconds.

defaultOrgQuota - Default quota for organisations inflated from OpenID, in board-seconds.

defaultCollabQuota - Default quota for collabratories inflated from OpenID, in board-seconds.

consolidationSchedule - Cron expression that says when we consolidate job quotas into the main quota table.

nmpiUrl - The NMPI service URL to communicate with for quotas.

nmpiApiKey - The API key to use to authenticate with the NMPI service.

nmpiPlatform - The platform to use when creating session on the NMPI service.

Method Details

getDefaultQuota

@PositiveOrZero
public @jakarta.validation.constraints.PositiveOrZero int getDefaultQuota()

Default user quota in board-seconds.

Returns:

Default user quota in board-seconds.

getDefaultOrgQuota

public long getDefaultOrgQuota()

Default quota for organisations.

Returns:

Default quota for organisations inflated from OpenID, in board-seconds.

getDefaultCollabQuota

public long getDefaultCollabQuota()

Default quota for collabratories.

Returns:

Default quota for collabratories inflated from OpenID, in board-seconds.

getConsolidationSchedule

@NotBlank
public @NotBlank String getConsolidationSchedule()

Returns:

Cron expression that says when we consolidate job quotas into the main quota table.

getNMPIUrl

public String getNMPIUrl()

Returns:

The URL of an NMPI server that deals with quota. May be blank, meaning there isn't one.

getNMPIApiKey

public String getNMPIApiKey()

Returns:

The API Key to use to access the NMPI server. May be blank if @linkplain(#nmpiUrl) is blank.

getNMPIPlaform

public String getNMPIPlaform()

Returns:

The platform to look for on the NMPI server.