ArmoniK.Api documentation

Getting Started

• Get started
• Releases
  • Create a release
  • Edge Release Channel
• Compilation steps for cpp API
  • Compilation of ArmoniK.Api.cpp Client and Server on Linux using Docker
  • Compilation of the Worker ArmoniK.Api.cpp Image for Deployment in ArmoniK Infrastructure

Installation

• Releases
  • Create a release
  • Edge Release Channel

Packages

• Find your package
  • C# packages
  • Python package
  • JavaScript packages
• C# packages
  • ArmoniK.Api.Client.Options
  • ArmoniK.Api.Client.Submitter
  • ArmoniK.Api.Common.Channel.Utils, ArmoniK.Api.Common.Options
  • ArmoniK.Api.Core
  • ArmoniK.Api.Common.Utils
  • ArmoniK.Api.Worker.Tests
  • ArmoniK.Api.Worker.Worker, ArmoniK.Api.Worker.Utils
• Web package
  • Update Web Package
• Angular package
  • Update Angular Package
  • Manual update

Usage

• Use ArmoniK API in an Angular App
  • Prerequisites
  • Create a new Angular App
  • Clean the project
  • Install ArmoniK API
  • Configure the Angular App
  • Call the gRPC services
  • Next steps
  • Conclusion
• Connecting to ArmoniK Securely using gRPC in Python
  • Overview
  • Prerequisites
  • Create Credentials for a Secure Channel
  • Launching the Python Script
• Environment Variables
  • Environment Variables exposed in ArmoniK.Api

API Proto

• V1
  • agent_common.proto
  • agent_service.proto
  • applications_common.proto
  • applications_fields.proto
  • applications_filters.proto
  • applications_service.proto
  • auth_common.proto
  • auth_service.proto
  • events_common.proto
  • events_service.proto
  • filters_common.proto
  • health_checks_common.proto
  • health_checks_service.proto
  • objects.proto
  • partitions_common.proto
  • partitions_fields.proto
  • partitions_filters.proto
  • partitions_service.proto
  • result_status.proto
  • results_common.proto
  • results_fields.proto
  • results_filters.proto
  • results_service.proto
  • session_status.proto
  • sessions_common.proto
  • sessions_fields.proto
  • sessions_filters.proto
  • sessions_service.proto
  • sort_direction.proto
  • submitter_common.proto
  • submitter_service.proto
  • task_status.proto
  • tasks_common.proto
  • tasks_fields.proto
  • tasks_filters.proto
  • tasks_service.proto
  • versions_common.proto
  • versions_service.proto
  • worker_common.proto
  • worker_service.proto
  • Scalar Value Types

API C#

• API Reference

API Python

• API Reference

API C++

• API Reference