Show / Hide Table of Contents

Namespace QarnotSDK

Classes

ABucketFiltering

Abstract base class for bucket filtering

ACustomCAClientHandler

public CustomCertificateAutorisationClientHandler compatibility constructor

AQPool

This class manages pools life cycle: submission, monitor, delete.

AQTask

This class manges tasks life cycle: submission, monitor, delete.

AResourcesTransformation

Abstract base class for resources transformation

AdvancedRanges

Represents a complex range (non continuous, with an offset...) of instances to execute.

ApiSettings

Represents the Api settings.

BucketFilteringPrefix

Filter a bucket by prefix

CarbonCalculator

Client used to interact with the Qarnot carbon API.

Connection

This class allows you to access the Qarnot compute API and construct other objects: QTask, QPool

Constant

Represents a Constant in a profile.

CpuModelHardware

Constraint to request a specific CPU

CustomCAClientHandler

public CustomCertificateAutorisationClientHandler constructor

CustomCAS3HttpClientFactory

Crete a S3 Http Client Handler Factory that can accept custom SSL certificate given.

ExponentialRetryHandler

ExponentialRetryHandler is an IRetryHandler implementation, with an exponentially growing interval between retries

FixedScalingPolicy

Details for a fixed, non-dynamic scaling policy

ForcedConstant

Describe a constant to be overriden when running the task.
This is meant to be used for development only and require specific permissions.

ForcedNetworkRule

Describe a network rule to be overridden for traffic to and from a running instance.

GpuHardware

Constraint to limit the execution to hardwares with GPU

HardwareConstraint

Base class of the Hardware contraints

HardwareConstraints

Constraints (core number, ram, gpu, etc.) that the hardware should satisfy for the execution of the tasks.

IRetryHandler

Interface for retry handler

LinearRetryHandler

LinearRetryHandler is an IRetryHandler implementation, with a linearly growing interval between retries.

ManagedTasksQueueScalingPolicy

Details for a scaling policy based on the tasks in queue on the pool

MaximumCoreHardware

Constraint to limit the maximum number of cores

MaximumRamCoreRatioHardware

Constraint to limit the maximum ram core ratio

MaximumRamHardware

Constraint to limit the maximum ram memory

MinimumCoreHardware

Constraint to limit the minimum number of cores

MinimumRamCoreRatioHardware

Constraint to limit the minimum ram core ratio

MinimumRamHardware

Constraint to limit the minimum ram memory

NoGpuHardware

Constraint to limit the execution to hardwares without GPU

NoRetryHandler

No retry handler, is an IRetryHandler implementation without retry

NoSSDHardware

Constraint to limit the execution to hardwares without SSD

OffsetPageRequest

Create an API request with a limited page in response

OffsetPageResponse<TSdk>

API limited page response with an offset

PaginatedRequest<T>

This class manage the Api request pages list for a specified class

PaginatedResponse<TSdk>

This class manages the Api Response pages list PaginatedResponseAPI for a specified class.

PoolPreparationTask

Represents the preparation commands and environment of each task running by this pool.

Privileges

List of privileges the task or pool is granted by the user

QAbstractStorage

Represents an abstract class to a resource or result storage class. One classe implement this interface: QBucket

QAbstractStorageEntry

Represents an entry (file or folder) in a storage. This class is abstract, use one of the final implementations: QBucketEntry.

QBucket

This class manages the Qarnot Ceph buckets (S3 compatible).

QBucketEntry

Represents an entry (file or folder) in a bucket.

QBulkTaskResponse

Represents an error that occur during a task execution.

QDataDetail<T>

Object holding selections and filtering for a specified class

QFilter<T>

Filtering applied to the class T

QJob

This class manages Jobs life cycle: logical group of tasks.

QJobStates

Job states.

QPool

This class manages pools life cycle: start, monitor, stop.

QPoolError

Represents an error that occur during a pool execution.

QPoolNodeStatus

Represents an unified an simplified version of a pool node status.

QPoolStates

Pool states.

QPoolStatus

Represents the status of a running pool.

QPoolStatusActiveForwards

Represents a public TCP port of a pool.

QPoolStatusExecutionTimeByCpuModel

Represents the execution time by cpu infos.

QPoolStatusExecutionTimeGhzByCpuModel

Represents the execution cpu ratio for each task.

QPoolStatusPerRunningInstanceInfo

Represents the status and the statistics of a running pool node.

QPoolStatusRunningInstancesInfo

Represents the statistics of a running pool.

QPoolSummary

This class manages pools life cycle: submission, monitor, delete.

QSecretAccessRightByPrefix

Secrets to be made available to a task, by prefix match on its Prefix property.

QSecretAccessRightBySecret

Secret to be made available to a task, by exact match on its Key property.

QSecretAccessRights

Description of all the secrets a task will have access to when running.

QSelect<T>

Select applied to the class T Only the choosen propertier are going to be retrieved

QTask

This class manges tasks life cycle: submission, monitor, delete.

QTaskCompletedInstance

Represents the status and the statistics of a completed task instance.

QTaskError

Represents an error that occur during a task execution.

QTaskInstanceStatus

Represents an unified an simplified version of a task instance status.

QTaskStates

Task states.

QTaskStatus

Represents the status of a running task.

QTaskStatusActiveForwards

Represents a public TCP port of a task.

QTaskStatusExecutionTimeByCpuModel

Represents the execution time by cpu infos.

QTaskStatusExecutionTimeGhzByCpuModel

Represents the execution cpu ratio for each task.

QTaskStatusPerRunningInstanceInfo

Represents the status and the statistics of a running task instance.

QTaskStatusRunningInstancesInfo

Represents the statistics of a running task.

QTaskSummary

This class manages tasks life cycle: submission, monitor, delete.

QTaskVpnConnection

Represents the Vpn Connection information used form the Connection.

QarnotApiException

Represents errors that occur during an Api request.

QarnotApiResourceAlreadyExistsException

Represents errors that occur when a shortname is not unique.

QarnotApiResourceNotFoundException

Represents errors 404 that occur during an Api request.

QarnotDnsLoadBalancerHandlerFactory

QarnotDnsLoadBalancerHandlerFactory class Factory of the DnsServiceBalancingMessageHandler.

ResourcesTransformationStripPrefix

Transform resources by stripping a prefix from the object name in the bucket

RetrySettings

Retry configuration for the failed instance. If neither MaxTotalRetries nor MaxPerInstanceRetries are set (or if they are equal to 0), the instances will not retry. If both MaxTotalRetries and MaxPerInstanceRetries are set, then the most restrictive applies.

S3HttpClientFactory

An Http client Factory example to use or surcharge if a custom S3 connection handler or a custom http client is needed.

SSDHardware

Constraint to limit the execution to hardwares with SSD

Scaling

How a pool will be scaled dynamically

ScalingPolicy

Abstract base class for scaling policies

Secrets

Client used to interact with the Qarnot secrets API.

SpecificHardware

Constraint to limit the execution to specific hardware

TimePeriodAlways

Describing a time period we are always in

TimePeriodSpecification

Abstract base class for time period specifications

TimePeriodWeeklyRecurring

Describing times that are recurring every week

UnsafeClientHandler

unsafe handler, it is an HttpClientHandler implementation without ssl certification verification It is not recommended to use it outside tests an debbugs implementations

UnsafeS3HttpClientFactory

Crete a S3 Http Factory that will not check the SSL certificate.

UserInformation

Represents the quotas and buckets information.

Enums

FileFlags

Represents the type of an entry (file, executable or folder) in a QBucket.

ForcedConstant.ForcedConstantAccess

Possible values for the Access property of a ForcedConstant object.

SchedulingType

Available scheduling Types for a compute item.

In this article
Back to top Generated by DocFX