ArmoniK.Api

Getting Started

  • Get started
  • Releases
  • Compilation steps for cpp API

Installation

  • Releases

Packages

  • Find your package
  • C# packages
  • Web package
  • Angular package

Usage

  • Use ArmoniK API in an Angular App
  • Connecting to ArmoniK Securely using gRPC in Python
  • Environment Variables

API Proto

  • V1

API C#

  • API Reference
    • Namespace ArmoniK
    • Namespace ArmoniK.Api
      • Namespaces
    • Namespace ArmoniK.Api.Client
    • Class EventsClientExt
    • Namespace ArmoniK.Api.Client.Options
    • Class GrpcClient
    • Class ResultsClientExt
    • Namespace ArmoniK.Api.Client.Submitter
    • Class GrpcChannelFactory
    • Class SubmitterClientExt
    • Namespace ArmoniK.Api.Client.Utils
    • Class ServiceConfigExt
    • Namespace ArmoniK.Api.Common
    • Namespace ArmoniK.Api.Common.Channel
    • Namespace ArmoniK.Api.Common.Channel.Utils
    • Class GrpcChannelProvider
    • Namespace ArmoniK.Api.Common.Exceptions
    • Class ResultAbortedException
    • Namespace ArmoniK.Api.Common.Options
    • Class ComputePlane
    • Class GrpcChannel
    • Enum GrpcSocketType
    • Namespace ArmoniK.Api.Common.Utils
    • Class ConfigurationExt
    • Class LoggerExt
    • Namespace ArmoniK.Api.Mock
    • Class CountAttribute
    • Class CountingAttribute
    • Class CountingService
    • Namespace ArmoniK.Api.Mock.Services
    • Class Agent
    • Class Applications
    • Class Authentication
    • Class Events
    • Class HealthChecks
    • Class Partitions
    • Class Results
    • Class Sessions
    • Class Submitter
    • Class Tasks
    • Class Versions
    • Namespace ArmoniK.Api.Worker
    • Namespace ArmoniK.Api.Worker.Utils
    • Class ApplicationLifeTimeManager
    • Class WorkerServer
    • Namespace ArmoniK.Api.Worker.Worker
    • Interface ITaskHandler
    • Class TaskHandler
    • Class WorkerStreamWrapper
    • Namespace ArmoniK.Api.gRPC
    • Namespace ArmoniK.Api.gRPC.V1
    • Namespace ArmoniK.Api.gRPC.V1.Agent
    • Class Agent
    • Class Agent.AgentBase
    • Class Agent.AgentClient
    • Class AgentCommonReflection
    • Class AgentServiceReflection
    • Class CreateResultsMetaDataRequest
    • Class CreateResultsMetaDataRequest.Types
    • Class CreateResultsMetaDataRequest.Types.ResultCreate
    • Class CreateResultsMetaDataResponse
    • Class CreateResultsRequest
    • Class CreateResultsRequest.Types
    • Class CreateResultsRequest.Types.ResultCreate
    • Class CreateResultsResponse
    • Class CreateTaskReply
    • Enum CreateTaskReply.ResponseOneofCase
    • Class CreateTaskReply.Types
    • Class CreateTaskReply.Types.CreationStatus
    • Enum CreateTaskReply.Types.CreationStatus.StatusOneofCase
    • Class CreateTaskReply.Types.CreationStatusList
    • Class CreateTaskReply.Types.TaskInfo
    • Class CreateTaskRequest
    • Enum CreateTaskRequest.TypeOneofCase
    • Class CreateTaskRequest.Types
    • Class CreateTaskRequest.Types.InitRequest
    • Class DataRequest
    • Class DataResponse
    • Class NotifyResultDataRequest
    • Class NotifyResultDataRequest.Types
    • Class NotifyResultDataRequest.Types.ResultIdentifier
    • Class NotifyResultDataResponse
    • Class ResultMetaData
    • Class SubmitTasksRequest
    • Class SubmitTasksRequest.Types
    • Class SubmitTasksRequest.Types.TaskCreation
    • Class SubmitTasksResponse
    • Class SubmitTasksResponse.Types
    • Class SubmitTasksResponse.Types.TaskInfo
    • Namespace ArmoniK.Api.gRPC.V1.Applications
    • Class ApplicationField
    • Enum ApplicationField.FieldOneofCase
    • Class ApplicationRaw
    • Enum ApplicationRawEnumField
    • Class ApplicationRawField
    • Class Applications
    • Class Applications.ApplicationsBase
    • Class Applications.ApplicationsClient
    • Class ApplicationsCommonReflection
    • Class ApplicationsFieldsReflection
    • Class ApplicationsFiltersReflection
    • Class ApplicationsServiceReflection
    • Class FilterField
    • Enum FilterField.ValueConditionOneofCase
    • Class Filters
    • Class FiltersAnd
    • Class ListApplicationsRequest
    • Class ListApplicationsRequest.Types
    • Class ListApplicationsRequest.Types.Sort
    • Class ListApplicationsResponse
    • Namespace ArmoniK.Api.gRPC.V1.Auth
    • Class AuthCommonReflection
    • Class AuthServiceReflection
    • Class Authentication
    • Class Authentication.AuthenticationBase
    • Class Authentication.AuthenticationClient
    • Class GetCurrentUserRequest
    • Class GetCurrentUserResponse
    • Class User
    • Class Configuration
    • Class Count
    • Class DataChunk
    • Enum DataChunk.TypeOneofCase
    • Class Empty
    • Class Error
    • Namespace ArmoniK.Api.gRPC.V1.Events
    • Class EventSubscriptionRequest
    • Class EventSubscriptionResponse
    • Class EventSubscriptionResponse.Types
    • Class EventSubscriptionResponse.Types.NewResult
    • Class EventSubscriptionResponse.Types.NewTask
    • Class EventSubscriptionResponse.Types.ResultOwnerUpdate
    • Class EventSubscriptionResponse.Types.ResultStatusUpdate
    • Class EventSubscriptionResponse.Types.TaskStatusUpdate
    • Enum EventSubscriptionResponse.UpdateOneofCase
    • Class Events
    • Class Events.EventsBase
    • Class Events.EventsClient
    • Class EventsCommonReflection
    • Enum EventsEnum
    • Class EventsServiceReflection
    • Class FilterArray
    • Enum FilterArrayOperator
    • Class FilterBoolean
    • Enum FilterBooleanOperator
    • Class FilterDate
    • Enum FilterDateOperator
    • Class FilterDuration
    • Enum FilterDurationOperator
    • Class FilterNumber
    • Enum FilterNumberOperator
    • Enum FilterStatusOperator
    • Class FilterString
    • Enum FilterStringOperator
    • Class FiltersCommonReflection
    • Namespace ArmoniK.Api.gRPC.V1.HealthChecks
    • Class CheckHealthRequest
    • Class CheckHealthResponse
    • Class CheckHealthResponse.Types
    • Class CheckHealthResponse.Types.ServiceHealth
    • Class HealthChecksCommonReflection
    • Class HealthChecksService
    • Class HealthChecksService.HealthChecksServiceBase
    • Class HealthChecksService.HealthChecksServiceClient
    • Class HealthChecksServiceReflection
    • Enum HealthStatusEnum
    • Class InitKeyedDataStream
    • Enum InitKeyedDataStream.TypeOneofCase
    • Class InitTaskRequest
    • Enum InitTaskRequest.TypeOneofCase
    • Class ObjectsReflection
    • Class Output
    • Enum Output.TypeOneofCase
    • Class Output.Types
    • Class Output.Types.Error
    • Namespace ArmoniK.Api.gRPC.V1.Partitions
    • Class FilterField
    • Enum FilterField.ValueConditionOneofCase
    • Class Filters
    • Class FiltersAnd
    • Class GetPartitionRequest
    • Class GetPartitionResponse
    • Class ListPartitionsRequest
    • Class ListPartitionsRequest.Types
    • Class ListPartitionsRequest.Types.Sort
    • Class ListPartitionsResponse
    • Class PartitionField
    • Enum PartitionField.FieldOneofCase
    • Class PartitionRaw
    • Enum PartitionRawEnumField
    • Class PartitionRawField
    • Class Partitions
    • Class Partitions.PartitionsBase
    • Class Partitions.PartitionsClient
    • Class PartitionsCommonReflection
    • Class PartitionsFieldsReflection
    • Class PartitionsFiltersReflection
    • Class PartitionsServiceReflection
    • Class ResultRequest
    • Enum ResultStatus
    • Class ResultStatusReflection
    • Namespace ArmoniK.Api.gRPC.V1.Results
    • Class CreateResultsMetaDataRequest
    • Class CreateResultsMetaDataRequest.Types
    • Class CreateResultsMetaDataRequest.Types.ResultCreate
    • Class CreateResultsMetaDataResponse
    • Class CreateResultsRequest
    • Class CreateResultsRequest.Types
    • Class CreateResultsRequest.Types.ResultCreate
    • Class CreateResultsResponse
    • Class DeleteResultsDataRequest
    • Class DeleteResultsDataResponse
    • Class DownloadResultDataRequest
    • Class DownloadResultDataResponse
    • Class FilterField
    • Enum FilterField.ValueConditionOneofCase
    • Class FilterStatus
    • Class Filters
    • Class FiltersAnd
    • Class GetOwnerTaskIdRequest
    • Class GetOwnerTaskIdResponse
    • Class GetOwnerTaskIdResponse.Types
    • Class GetOwnerTaskIdResponse.Types.MapResultTask
    • Class GetResultRequest
    • Class GetResultResponse
    • Class ImportResultsDataRequest
    • Class ImportResultsDataRequest.Types
    • Class ImportResultsDataRequest.Types.ResultOpaqueId
    • Class ImportResultsDataResponse
    • Class ListResultsRequest
    • Class ListResultsRequest.Types
    • Class ListResultsRequest.Types.Sort
    • Class ListResultsResponse
    • Class ResultField
    • Enum ResultField.FieldOneofCase
    • Class ResultRaw
    • Enum ResultRawEnumField
    • Class ResultRawField
    • Class Results
    • Class Results.ResultsBase
    • Class Results.ResultsClient
    • Class ResultsCommonReflection
    • Class ResultsFieldsReflection
    • Class ResultsFiltersReflection
    • Class ResultsServiceConfigurationResponse
    • Class ResultsServiceReflection
    • Class UploadResultDataRequest
    • Enum UploadResultDataRequest.TypeOneofCase
    • Class UploadResultDataRequest.Types
    • Class UploadResultDataRequest.Types.ResultIdentifier
    • Class UploadResultDataResponse
    • Class WatchResultRequest
    • Class WatchResultResponse
    • Class Session
    • Enum SessionStatus
    • Class SessionStatusReflection
    • Namespace ArmoniK.Api.gRPC.V1.Sessions
    • Class CancelSessionRequest
    • Class CancelSessionResponse
    • Class CloseSessionRequest
    • Class CloseSessionResponse
    • Class CreateSessionReply
    • Class CreateSessionRequest
    • Class DeleteSessionRequest
    • Class DeleteSessionResponse
    • Class FilterField
    • Enum FilterField.ValueConditionOneofCase
    • Class FilterStatus
    • Class Filters
    • Class FiltersAnd
    • Class GetSessionRequest
    • Class GetSessionResponse
    • Class ListSessionsRequest
    • Class ListSessionsRequest.Types
    • Class ListSessionsRequest.Types.Sort
    • Class ListSessionsResponse
    • Class PauseSessionRequest
    • Class PauseSessionResponse
    • Class PurgeSessionRequest
    • Class PurgeSessionResponse
    • Class ResumeSessionRequest
    • Class ResumeSessionResponse
    • Class SessionField
    • Enum SessionField.FieldOneofCase
    • Class SessionRaw
    • Enum SessionRawEnumField
    • Class SessionRawField
    • Class Sessions
    • Class Sessions.SessionsBase
    • Class Sessions.SessionsClient
    • Class SessionsCommonReflection
    • Class SessionsFieldsReflection
    • Class SessionsFiltersReflection
    • Class SessionsServiceReflection
    • Class StopSubmissionRequest
    • Class StopSubmissionResponse
    • Enum TaskOptionEnumField
    • Class TaskOptionField
    • Class TaskOptionGenericField
    • Namespace ArmoniK.Api.gRPC.V1.SortDirection
    • Enum SortDirection
    • Class SortDirectionReflection
    • Class StatusCount
    • Namespace ArmoniK.Api.gRPC.V1.Submitter
    • Class AvailabilityReply
    • Enum AvailabilityReply.TypeOneofCase
    • Class CreateLargeTaskRequest
    • Enum CreateLargeTaskRequest.TypeOneofCase
    • Class CreateLargeTaskRequest.Types
    • Class CreateLargeTaskRequest.Types.InitRequest
    • Class CreateSessionReply
    • Class CreateSessionRequest
    • Class CreateSmallTaskRequest
    • Class CreateTaskReply
    • Enum CreateTaskReply.ResponseOneofCase
    • Class CreateTaskReply.Types
    • Class CreateTaskReply.Types.CreationStatus
    • Enum CreateTaskReply.Types.CreationStatus.StatusOneofCase
    • Class CreateTaskReply.Types.CreationStatusList
    • Class CreateTaskReply.Types.TaskInfo
    • Class GetResultStatusReply
    • Class GetResultStatusReply.Types
    • Class GetResultStatusReply.Types.IdStatus
    • Class GetResultStatusRequest
    • Class GetTaskStatusReply
    • Class GetTaskStatusReply.Types
    • Class GetTaskStatusReply.Types.IdStatus
    • Class GetTaskStatusRequest
    • Class ResultReply
    • Enum ResultReply.TypeOneofCase
    • Class SessionFilter
    • Enum SessionFilter.StatusesOneofCase
    • Class SessionFilter.Types
    • Class SessionFilter.Types.StatusesRequest
    • Class SessionIdList
    • Class SessionList
    • Class Submitter
    • Class Submitter.SubmitterBase
    • Class Submitter.SubmitterClient
    • Class SubmitterCommonReflection
    • Class SubmitterServiceReflection
    • Class TaskFilter
    • Enum TaskFilter.IdsOneofCase
    • Enum TaskFilter.StatusesOneofCase
    • Class TaskFilter.Types
    • Class TaskFilter.Types.IdsRequest
    • Class TaskFilter.Types.StatusesRequest
    • Class WaitRequest
    • Class WatchResultRequest
    • Class WatchResultStream
    • Class TaskError
    • Class TaskId
    • Class TaskIdList
    • Class TaskIdWithStatus
    • Class TaskList
    • Class TaskOptions
    • Class TaskOutputRequest
    • Class TaskRequest
    • Class TaskRequestHeader
    • Enum TaskStatus
    • Class TaskStatusReflection
    • Namespace ArmoniK.Api.gRPC.V1.Tasks
    • Class CancelTasksRequest
    • Class CancelTasksResponse
    • Class CountTasksByStatusRequest
    • Class CountTasksByStatusResponse
    • Class FilterField
    • Enum FilterField.ValueConditionOneofCase
    • Class FilterStatus
    • Class Filters
    • Class FiltersAnd
    • Class GetResultIdsRequest
    • Class GetResultIdsResponse
    • Class GetResultIdsResponse.Types
    • Class GetResultIdsResponse.Types.MapTaskResult
    • Class GetTaskRequest
    • Class GetTaskResponse
    • Class ListTasksDetailedResponse
    • Class ListTasksRequest
    • Class ListTasksRequest.Types
    • Class ListTasksRequest.Types.Sort
    • Class ListTasksResponse
    • Class SubmitTasksRequest
    • Class SubmitTasksRequest.Types
    • Class SubmitTasksRequest.Types.TaskCreation
    • Class SubmitTasksResponse
    • Class SubmitTasksResponse.Types
    • Class SubmitTasksResponse.Types.TaskInfo
    • Class TaskDetailed
    • Class TaskDetailed.Types
    • Class TaskDetailed.Types.Output
    • Class TaskField
    • Enum TaskField.FieldOneofCase
    • Enum TaskOptionEnumField
    • Class TaskOptionField
    • Class TaskOptionGenericField
    • Class TaskSummary
    • Enum TaskSummaryEnumField
    • Class TaskSummaryField
    • Class Tasks
    • Class Tasks.TasksBase
    • Class Tasks.TasksClient
    • Class TasksCommonReflection
    • Class TasksFieldsReflection
    • Class TasksFiltersReflection
    • Class TasksServiceReflection
    • Namespace ArmoniK.Api.gRPC.V1.Versions
    • Class ListVersionsRequest
    • Class ListVersionsResponse
    • Class Versions
    • Class Versions.VersionsBase
    • Class Versions.VersionsClient
    • Class VersionsCommonReflection
    • Class VersionsServiceReflection
    • Namespace ArmoniK.Api.gRPC.V1.Worker
    • Class HealthCheckReply
    • Class HealthCheckReply.Types
    • Enum HealthCheckReply.Types.ServingStatus
    • Class ProcessReply
    • Class ProcessRequest
    • Class Worker
    • Class Worker.WorkerBase
    • Class Worker.WorkerClient
    • Class WorkerCommonReflection
    • Class WorkerServiceReflection

API Python

  • API Reference

API C++

  • API Reference
ArmoniK.Api
  • API Reference
  • Namespace ArmoniK.Api
  • Edit on GitHub

Namespace ArmoniK.Api

Namespaces

ArmoniK.Api.Client

ArmoniK.Api.Common

ArmoniK.Api.Mock

ArmoniK.Api.Worker

ArmoniK.Api.gRPC

Previous Next

© Copyright 2021-2026, ANEO.

Built with Sphinx using a theme provided by Read the Docs.