Show / Hide Table of Contents

Class UserInformation

Represents the quotas and buckets information.

Inheritance
object
UserInformation
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class UserInformation

Fields

BucketCount

Number of buckets owned by the user.

Declaration
public int BucketCount
Field Value
Type Description
int

Email

User email address.

Declaration
public string Email
Field Value
Type Description
string

MaxBucket

Maximum number of buckets the user is allowed to create.

Declaration
public int MaxBucket
Field Value
Type Description
int

MaxInstances

Maximum number of concurrent allowed instances.

Declaration
public int MaxInstances
Field Value
Type Description
int

MaxPool

Maximum number of pools the user is allowed to create.

Declaration
public int MaxPool
Field Value
Type Description
int

MaxRunningPool

Maximum number of running pools the user is allowed to create.

Declaration
public int MaxRunningPool
Field Value
Type Description
int

MaxRunningTask

Maximum number of running tasks the user is allowed to create.

Declaration
public int MaxRunningTask
Field Value
Type Description
int

MaxTask

Maximum number of tasks the user is allowed to create.

Declaration
public int MaxTask
Field Value
Type Description
int

PoolCount

Total number of pools belonging to the user.

Declaration
public int PoolCount
Field Value
Type Description
int

QuotaBytesBucket

Allowed quota in bytes for the user.

Declaration
public long QuotaBytesBucket
Field Value
Type Description
long

RunningPoolCount

Number of pools currently submitted or running.

Declaration
public int RunningPoolCount
Field Value
Type Description
int

RunningTaskCount

Number of tasks currently submitted or running.

Declaration
public int RunningTaskCount
Field Value
Type Description
int

TaskCount

Total number of tasks belonging to the user.

Declaration
public int TaskCount
Field Value
Type Description
int

UsedQuotaBytesBucket

Currently used quota in bytes.

Declaration
public long UsedQuotaBytesBucket
Field Value
Type Description
long

Properties

ComputingQuotas

Computing quotas of the user and their organization

Declaration
public ComputingQuotas ComputingQuotas { get; set; }
Property Value
Type Description
ComputingQuotas

Projects

Projects available to this user. Use GetProjectByName(string) or GetProjectBySlug(string) for convenient lookup before assigning to a task or pool.

Declaration
[JsonIgnore]
public List<QProject> Projects { get; }
Property Value
Type Description
List<QProject>

RunningCoreCount

Number of cores currently submitted or running.

Declaration
public int RunningCoreCount { get; set; }
Property Value
Type Description
int

RunningInstanceCount

Number of Instances currently submitted or running.

Declaration
public int RunningInstanceCount { get; set; }
Property Value
Type Description
int

Methods

GetDefaultProject()

Returns the default project or null if not found. The default project is the one automatically selected at task or pool creation if none is provided

Declaration
public QProject GetDefaultProject()
Returns
Type Description
QProject

GetProjectByName(string)

Returns the first project whose name matches name (case-insensitive), or null if not found.

Declaration
public QProject GetProjectByName(string name)
Parameters
Type Name Description
string name
Returns
Type Description
QProject

GetProjectBySlug(string)

Returns the first project whose slug matches slug (case-insensitive), or null if not found.

Declaration
public QProject GetProjectBySlug(string slug)
Parameters
Type Name Description
string slug
Returns
Type Description
QProject

GetProjectByUuid(Guid)

Returns the first project whose uuid matches uuid, or null if not found.

Declaration
public QProject GetProjectByUuid(Guid uuid)
Parameters
Type Name Description
Guid uuid
Returns
Type Description
QProject
In this article
Back to top Generated by DocFX