Skip to content

CUAHSI/argo-workflow-python-client

BranchesTags

Repository files navigation

generated with docker image swaggerapi/swagger-codegen-cli

 docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \
    -i https://workflows.argo.cuahsi.io/assets/openapi-spec/swagger.json \
    -l python \
    -o /local/out/python

swagger-client

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/release-3.5/

This Python package is automatically generated by the Swagger Codegen project:

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/CUAHSI/argo-workflow-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ArchivedWorkflowServiceApi(swagger_client.ApiClient(configuration))
uid = 'uid_example' # str | 
namespace = 'namespace_example' # str |  (optional)

try:
    api_response = api_instance.archived_workflow_service_delete_archived_workflow(uid, namespace=namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArchivedWorkflowServiceApi->archived_workflow_service_delete_archived_workflow: %s\n" % e)

Documentation for API Endpoints

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

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

Author

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

5 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages