argo_workflows

ArgoWorkflows - the Ruby gem for the Argo Workflows API

Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/latest/

This SDK is automatically generated by the Swagger Codegen project:

  • API version: VERSION
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build argo_workflows.gemspec

Then either install the gem locally:

gem install ./argo_workflows-1.0.0.gem

(for development, run gem install --dev ./argo_workflows-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'argo_workflows', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'argo_workflows', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'argo_workflows'

# Setup authorization
ArgoWorkflows.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = ArgoWorkflows::ArchivedWorkflowServiceApi.new

uid = 'uid_example' # String | 

opts = { 
  namespace: 'namespace_example' # String | 
}

begin
  result = api_instance.archived_workflow_service_delete_archived_workflow(uid, opts)
  p result
rescue ArgoWorkflows::ApiError => e
  puts "Exception when calling ArchivedWorkflowServiceApi->archived_workflow_service_delete_archived_workflow: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:2746

Class Method HTTP request Description
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_delete_archived_workflow DELETE /api/v1/archived-workflows/uid
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_get_archived_workflow GET /api/v1/archived-workflows/uid
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_list_archived_workflow_label_keys GET /api/v1/archived-workflows-label-keys
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_list_archived_workflow_label_values GET /api/v1/archived-workflows-label-values
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_list_archived_workflows GET /api/v1/archived-workflows
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_resubmit_archived_workflow PUT /api/v1/archived-workflows/uid/resubmit
ArgoWorkflows::ArchivedWorkflowServiceApi archived_workflow_service_retry_archived_workflow PUT /api/v1/archived-workflows/uid/retry
ArgoWorkflows::ArtifactServiceApi artifact_service_get_artifact_file GET /artifact-files/namespace/idDiscriminator/id/nodeId/artifactDiscriminator/artifactName Get an artifact.
ArgoWorkflows::ArtifactServiceApi artifact_service_get_input_artifact GET /input-artifacts/namespace/name/nodeId/artifactName Get an input artifact.
ArgoWorkflows::ArtifactServiceApi artifact_service_get_input_artifact_by_uid GET /input-artifacts-by-uid/uid/nodeId/artifactName Get an input artifact by UID.
ArgoWorkflows::ArtifactServiceApi artifact_service_get_output_artifact GET /artifacts/namespace/name/nodeId/artifactName Get an output artifact.
ArgoWorkflows::ArtifactServiceApi artifact_service_get_output_artifact_by_uid GET /artifacts-by-uid/uid/nodeId/artifactName Get an output artifact by UID.
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_create_cluster_workflow_template POST /api/v1/cluster-workflow-templates
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_delete_cluster_workflow_template DELETE /api/v1/cluster-workflow-templates/name
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_get_cluster_workflow_template GET /api/v1/cluster-workflow-templates/name
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_lint_cluster_workflow_template POST /api/v1/cluster-workflow-templates/lint
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_list_cluster_workflow_templates GET /api/v1/cluster-workflow-templates
ArgoWorkflows::ClusterWorkflowTemplateServiceApi cluster_workflow_template_service_update_cluster_workflow_template PUT /api/v1/cluster-workflow-templates/name
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_create_cron_workflow POST /api/v1/cron-workflows/namespace
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_delete_cron_workflow DELETE /api/v1/cron-workflows/namespace/name
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_get_cron_workflow GET /api/v1/cron-workflows/namespace/name
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_lint_cron_workflow POST /api/v1/cron-workflows/namespace/lint
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_list_cron_workflows GET /api/v1/cron-workflows/namespace
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_resume_cron_workflow PUT /api/v1/cron-workflows/namespace/name/resume
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_suspend_cron_workflow PUT /api/v1/cron-workflows/namespace/name/suspend
ArgoWorkflows::CronWorkflowServiceApi cron_workflow_service_update_cron_workflow PUT /api/v1/cron-workflows/namespace/name
ArgoWorkflows::EventServiceApi event_service_list_workflow_event_bindings GET /api/v1/workflow-event-bindings/namespace
ArgoWorkflows::EventServiceApi event_service_receive_event POST /api/v1/events/namespace/discriminator
ArgoWorkflows::EventSourceServiceApi event_source_service_create_event_source POST /api/v1/event-sources/namespace
ArgoWorkflows::EventSourceServiceApi event_source_service_delete_event_source DELETE /api/v1/event-sources/namespace/name
ArgoWorkflows::EventSourceServiceApi event_source_service_event_sources_logs GET /api/v1/stream/event-sources/namespace/logs
ArgoWorkflows::EventSourceServiceApi event_source_service_get_event_source GET /api/v1/event-sources/namespace/name
ArgoWorkflows::EventSourceServiceApi event_source_service_list_event_sources GET /api/v1/event-sources/namespace
ArgoWorkflows::EventSourceServiceApi event_source_service_update_event_source PUT /api/v1/event-sources/namespace/name
ArgoWorkflows::EventSourceServiceApi event_source_service_watch_event_sources GET /api/v1/stream/event-sources/namespace
ArgoWorkflows::InfoServiceApi info_service_collect_event POST /api/v1/tracking/event
ArgoWorkflows::InfoServiceApi info_service_get_info GET /api/v1/info
ArgoWorkflows::InfoServiceApi info_service_get_user_info GET /api/v1/userinfo
ArgoWorkflows::InfoServiceApi info_service_get_version GET /api/v1/version
ArgoWorkflows::SensorServiceApi sensor_service_create_sensor POST /api/v1/sensors/namespace
ArgoWorkflows::SensorServiceApi sensor_service_delete_sensor DELETE /api/v1/sensors/namespace/name
ArgoWorkflows::SensorServiceApi sensor_service_get_sensor GET /api/v1/sensors/namespace/name
ArgoWorkflows::SensorServiceApi sensor_service_list_sensors GET /api/v1/sensors/namespace
ArgoWorkflows::SensorServiceApi sensor_service_sensors_logs GET /api/v1/stream/sensors/namespace/logs
ArgoWorkflows::SensorServiceApi sensor_service_update_sensor PUT /api/v1/sensors/namespace/name
ArgoWorkflows::SensorServiceApi sensor_service_watch_sensors GET /api/v1/stream/sensors/namespace
ArgoWorkflows::WorkflowServiceApi workflow_service_create_workflow POST /api/v1/workflows/namespace
ArgoWorkflows::WorkflowServiceApi workflow_service_delete_workflow DELETE /api/v1/workflows/namespace/name
ArgoWorkflows::WorkflowServiceApi workflow_service_get_workflow GET /api/v1/workflows/namespace/name
ArgoWorkflows::WorkflowServiceApi workflow_service_lint_workflow POST /api/v1/workflows/namespace/lint
ArgoWorkflows::WorkflowServiceApi workflow_service_list_workflows GET /api/v1/workflows/namespace
ArgoWorkflows::WorkflowServiceApi workflow_service_pod_logs GET /api/v1/workflows/namespace/name/podName/log DEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.
ArgoWorkflows::WorkflowServiceApi workflow_service_resubmit_workflow PUT /api/v1/workflows/namespace/name/resubmit
ArgoWorkflows::WorkflowServiceApi workflow_service_resume_workflow PUT /api/v1/workflows/namespace/name/resume
ArgoWorkflows::WorkflowServiceApi workflow_service_retry_workflow PUT /api/v1/workflows/namespace/name/retry
ArgoWorkflows::WorkflowServiceApi workflow_service_set_workflow PUT /api/v1/workflows/namespace/name/set
ArgoWorkflows::WorkflowServiceApi workflow_service_stop_workflow PUT /api/v1/workflows/namespace/name/stop
ArgoWorkflows::WorkflowServiceApi workflow_service_submit_workflow POST /api/v1/workflows/namespace/submit
ArgoWorkflows::WorkflowServiceApi workflow_service_suspend_workflow PUT /api/v1/workflows/namespace/name/suspend
ArgoWorkflows::WorkflowServiceApi workflow_service_terminate_workflow PUT /api/v1/workflows/namespace/name/terminate
ArgoWorkflows::WorkflowServiceApi workflow_service_watch_events GET /api/v1/stream/events/namespace
ArgoWorkflows::WorkflowServiceApi workflow_service_watch_workflows GET /api/v1/workflow-events/namespace
ArgoWorkflows::WorkflowServiceApi workflow_service_workflow_logs GET /api/v1/workflows/namespace/name/log
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_create_workflow_template POST /api/v1/workflow-templates/namespace
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_delete_workflow_template DELETE /api/v1/workflow-templates/namespace/name
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_get_workflow_template GET /api/v1/workflow-templates/namespace/name
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_lint_workflow_template POST /api/v1/workflow-templates/namespace/lint
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_list_workflow_templates GET /api/v1/workflow-templates/namespace
ArgoWorkflows::WorkflowTemplateServiceApi workflow_template_service_update_workflow_template PUT /api/v1/workflow-templates/namespace/name

Documentation for Models

Documentation for Authorization

BearerToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header