Class QProject

Represents a Qarnot project. Projects group tasks and pools for quota and billing purposes. Assign a project to a task or pool via ProjectUuid or ProjectUuid before submission.

Inheritance

object

QProject

Inherited Members

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 QProject

Properties

Description

The description of the project.

Declaration

public string Description { get; }

Property Value

Type	Description
string

IsDefault

State if this project is the default one of the organization A default project is automatically selected at task or pool creation if none is provided

Declaration

public bool IsDefault { get; }

Property Value

Type	Description
bool

Name

The display name of the project.

Declaration

public string Name { get; }

Property Value

Type	Description
string

OrganizationUuid

The UUID of the organization this project belongs to.

Declaration

public Guid OrganizationUuid { get; }

Property Value

Type	Description
Guid

Slug

The URL-friendly slug of the project.

Declaration

public string Slug { get; }

Property Value

Type	Description
string

Uuid

The unique identifier of the project.

Declaration

public Guid Uuid { get; }

Property Value

Type	Description
Guid

Methods

RetrieveActiveBudgetsAsync(Connection, CancellationToken)

Retrieve the active budgets for this project.

Declaration

public Task<List<Budget>> RetrieveActiveBudgetsAsync(Connection connection, CancellationToken ct = default)

Parameters

Type	Name	Description
Connection	connection	The connection to use for the API call.
CancellationToken	ct	Cancellation token.

Returns

Type	Description
Task<List<Budget>>	A list of active budgets.

RetrieveAllBudgetsAsync(Connection, CancellationToken)

Retrieve all budgets for this project, including archived ones.

Declaration

public Task<List<Budget>> RetrieveAllBudgetsAsync(Connection connection, CancellationToken ct = default)

Parameters

Type	Name	Description
Connection	connection	The connection to use for the API call.
CancellationToken	ct	Cancellation token.

Returns

Type	Description
Task<List<Budget>>	A list of all budgets.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()