org.jclouds.cloudstack.domain
Class Account

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingCollection<E>
          com.google.common.collect.ForwardingSet<User>
              org.jclouds.cloudstack.domain.Account

All Implemented Interfaces:

Comparable<Account>, Iterable<User>, Collection<User>, Set<User>

public class Account
extends com.google.common.collect.ForwardingSet<User>
implements Comparable<Account>

Author:

Adrian Cole

Nested Class Summary

static class	Account.Builder
static class	Account.State
static class	Account.Type

Constructor Summary

Account(long id, Account.Type type, String networkDomain, String domain, long domainId, Long IPsAvailable, Long IPLimit, long iPs, boolean cleanupRequired, String name, long receivedBytes, long sentBytes, Long snapshotsAvailable, Long snapshotLimit, long snapshots, Account.State state, Long templatesAvailable, Long templateLimit, long templates, Long VMsAvailable, Long VMLimit, long vMsRunning, long vMsStopped, long vMs, Long volumesAvailable, Long volumeLimit, long volumes, Set<User> users)

Method Summary

static Account.Builder	builder()
int	compareTo(Account arg0)
protected Set<User>	delegate()
boolean	equals(Object obj)
String	getDomain()
long	getDomainId()
long	getId()
Long	getIPLimit()
long	getIPs()
Long	getIPsAvailable()
String	getName()
String	getNetworkDomain()
long	getReceivedBytes()
long	getSentBytes()
Long	getSnapshotLimit()
long	getSnapshots()
Long	getSnapshotsAvailable()
Account.State	getState()
Long	getTemplateLimit()
long	getTemplates()
Long	getTemplatesAvailable()
Account.Type	getType()
Set<User>	getUsers()
Long	getVMLimit()
long	getVMs()
Long	getVMsAvailable()
long	getVMsRunning()
long	getVMsStopped()
Long	getVolumeLimit()
long	getVolumes()
Long	getVolumesAvailable()
int	hashCode()
boolean	isCleanupRequired()
String	toString()

Methods inherited from class com.google.common.collect.ForwardingSet

standardEquals, standardHashCode

Methods inherited from class com.google.common.collect.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

Account

public Account(long id,
               Account.Type type,
               String networkDomain,
               String domain,
               long domainId,
               Long IPsAvailable,
               Long IPLimit,
               long iPs,
               boolean cleanupRequired,
               String name,
               long receivedBytes,
               long sentBytes,
               Long snapshotsAvailable,
               Long snapshotLimit,
               long snapshots,
               Account.State state,
               Long templatesAvailable,
               Long templateLimit,
               long templates,
               Long VMsAvailable,
               Long VMLimit,
               long vMsRunning,
               long vMsStopped,
               long vMs,
               Long volumesAvailable,
               Long volumeLimit,
               long volumes,
               Set<User> users)

Method Detail

builder

public static Account.Builder builder()

getId

public long getId()

Returns:

the id of the account

getName

public String getName()

Returns:

the name of the account

getType

public Account.Type getType()

Returns:

account type (admin, domain-admin, user)

getNetworkDomain

public String getNetworkDomain()

Returns:

the network domain

getDomain

public String getDomain()

Returns:

name of the Domain the account belongs to

getDomainId

public long getDomainId()

Returns:

id of the Domain the account belongs to

isCleanupRequired

public boolean isCleanupRequired()

Returns:

true if the account requires cleanup

getUsers

public Set<User> getUsers()

Returns:

the list of users associated with account

getIPsAvailable

@Nullable
public Long getIPsAvailable()

Returns:

the total number of public ip addresses available for this account to acquire, or null if unlimited

getIPLimit

@Nullable
public Long getIPLimit()

Returns:

the total number of public ip addresses this account can acquire, or null if unlimited

getIPs

public long getIPs()

Returns:

the total number of public ip addresses allocated for this account

getReceivedBytes

public long getReceivedBytes()

Returns:

the total number of network traffic bytes received

getSentBytes

public long getSentBytes()

Returns:

the total number of network traffic bytes sent

getSnapshotsAvailable

@Nullable
public Long getSnapshotsAvailable()

Returns:

the total number of snapshots available for this account, or null if unlimited

getSnapshotLimit

@Nullable
public Long getSnapshotLimit()

Returns:

the total number of snapshots which can be stored by this account, or null if unlimited

getSnapshots

public long getSnapshots()

Returns:

the total number of snapshots stored by this account

getState

public Account.State getState()

Returns:

the state of the account

getTemplatesAvailable

@Nullable
public Long getTemplatesAvailable()

Returns:

the total number of templates available to be created by this account, or null if unlimited

getTemplateLimit

@Nullable
public Long getTemplateLimit()

Returns:

the total number of templates which can be created by this account, or null if unlimited

getTemplates

public long getTemplates()

Returns:

the total number of templates which have been created by this account

getVMsAvailable

@Nullable
public Long getVMsAvailable()

Returns:

the total number of virtual machines available for this account to acquire, or null if unlimited

getVMLimit

@Nullable
public Long getVMLimit()

Returns:

the total number of virtual machines that can be deployed by this account, or null if unlimited

getVMsRunning

public long getVMsRunning()

Returns:

the total number of virtual machines running for this account

getVMsStopped

public long getVMsStopped()

Returns:

the total number of virtual machines stopped for this account

getVMs

public long getVMs()

Returns:

the total number of virtual machines deployed by this account

getVolumesAvailable

@Nullable
public Long getVolumesAvailable()

Returns:

the total volume available for this account, or null if unlimited

getVolumeLimit

@Nullable
public Long getVolumeLimit()

Returns:

the total volume which can be used by this account, or null if unlimited

getVolumes

public long getVolumes()

Returns:

the total volume being used by this account

compareTo

public int compareTo(Account arg0)

Specified by:

compareTo in interface Comparable<Account>

toString

public String toString()

Overrides:

toString in class com.google.common.collect.ForwardingObject

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<User>

Specified by:

hashCode in interface Set<User>

Overrides:

hashCode in class com.google.common.collect.ForwardingSet<User>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<User>

Specified by:

equals in interface Set<User>

Overrides:

equals in class com.google.common.collect.ForwardingSet<User>

delegate

protected Set<User> delegate()

Overrides:

delegate in class com.google.common.collect.ForwardingSet<User>