Argo
- API version: latest
Argo
Automatically generated by the OpenAPI Generator
Building the API client library requires:
- Java 1.7+
- Maven/Gradle
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>io.argoproj.workflow</groupId>
<artifactId>argo-client-java</artifactId>
<version>1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
compile "io.argoproj.workflow:argo-client-java:1-SNAPSHOT"At first generate the JAR by executing:
mvn clean packageThen manually install the following JARs:
target/argo-client-java-1-SNAPSHOT.jartarget/lib/*.jar
Please follow the installation instruction and execute the following Java code:
// Import classes:
import io.argoproj.workflow.ApiClient;
import io.argoproj.workflow.ApiException;
import io.argoproj.workflow.Configuration;
import io.argoproj.workflow.models.*;
import io.argoproj.workflow.apis.ArchivedWorkflowServiceApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http:https://localhost:2746");
ArchivedWorkflowServiceApi apiInstance = new ArchivedWorkflowServiceApi(defaultClient);
String uid = "uid_example"; // String |
try {
Object result = apiInstance.deleteArchivedWorkflow(uid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArchivedWorkflowServiceApi#deleteArchivedWorkflow");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}All URIs are relative to http:https://localhost:2746
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ArchivedWorkflowServiceApi | deleteArchivedWorkflow | DELETE /api/v1/archived-workflows/{uid} | |
| ArchivedWorkflowServiceApi | getArchivedWorkflow | GET /api/v1/archived-workflows/{uid} | |
| ArchivedWorkflowServiceApi | listArchivedWorkflows | GET /api/v1/archived-workflows | |
| ClusterWorkflowTemplateServiceApi | createClusterWorkflowTemplate | POST /api/v1/cluster-workflow-templates | |
| ClusterWorkflowTemplateServiceApi | deleteClusterWorkflowTemplate | DELETE /api/v1/cluster-workflow-templates/{name} | |
| ClusterWorkflowTemplateServiceApi | getClusterWorkflowTemplate | GET /api/v1/cluster-workflow-templates/{name} | |
| ClusterWorkflowTemplateServiceApi | lintClusterWorkflowTemplate | POST /api/v1/cluster-workflow-templates/lint | |
| ClusterWorkflowTemplateServiceApi | listClusterWorkflowTemplates | GET /api/v1/cluster-workflow-templates | |
| ClusterWorkflowTemplateServiceApi | updateClusterWorkflowTemplate | PUT /api/v1/cluster-workflow-templates/{name} | |
| CronWorkflowServiceApi | createCronWorkflow | POST /api/v1/cron-workflows/{namespace} | |
| CronWorkflowServiceApi | deleteCronWorkflow | DELETE /api/v1/cron-workflows/{namespace}/{name} | |
| CronWorkflowServiceApi | getCronWorkflow | GET /api/v1/cron-workflows/{namespace}/{name} | |
| CronWorkflowServiceApi | lintCronWorkflow | POST /api/v1/cron-workflows/{namespace}/lint | |
| CronWorkflowServiceApi | listCronWorkflows | GET /api/v1/cron-workflows/{namespace} | |
| CronWorkflowServiceApi | updateCronWorkflow | PUT /api/v1/cron-workflows/{namespace}/{name} | |
| InfoServiceApi | getInfo | GET /api/v1/info | |
| WorkflowServiceApi | createWorkflow | POST /api/v1/workflows/{namespace} | |
| WorkflowServiceApi | deleteWorkflow | DELETE /api/v1/workflows/{namespace}/{name} | |
| WorkflowServiceApi | getWorkflow | GET /api/v1/workflows/{namespace}/{name} | |
| WorkflowServiceApi | lintWorkflow | POST /api/v1/workflows/{namespace}/lint | |
| WorkflowServiceApi | listWorkflows | GET /api/v1/workflows/{namespace} | |
| WorkflowServiceApi | podLogs | GET /api/v1/workflows/{namespace}/{name}/{podName}/log | |
| WorkflowServiceApi | resubmitWorkflow | PUT /api/v1/workflows/{namespace}/{name}/resubmit | |
| WorkflowServiceApi | resumeWorkflow | PUT /api/v1/workflows/{namespace}/{name}/resume | |
| WorkflowServiceApi | retryWorkflow | PUT /api/v1/workflows/{namespace}/{name}/retry | |
| WorkflowServiceApi | stopWorkflow | PUT /api/v1/workflows/{namespace}/{name}/stop | |
| WorkflowServiceApi | suspendWorkflow | PUT /api/v1/workflows/{namespace}/{name}/suspend | |
| WorkflowServiceApi | terminateWorkflow | PUT /api/v1/workflows/{namespace}/{name}/terminate | |
| WorkflowServiceApi | watchWorkflows | GET /api/v1/workflow-events/{namespace} | |
| WorkflowTemplateServiceApi | createWorkflowTemplate | POST /api/v1/workflow-templates/{namespace} | |
| WorkflowTemplateServiceApi | deleteWorkflowTemplate | DELETE /api/v1/workflow-templates/{namespace}/{name} | |
| WorkflowTemplateServiceApi | getWorkflowTemplate | GET /api/v1/workflow-templates/{namespace}/{name} | |
| WorkflowTemplateServiceApi | lintWorkflowTemplate | POST /api/v1/workflow-templates/{namespace}/lint | |
| WorkflowTemplateServiceApi | listWorkflowTemplates | GET /api/v1/workflow-templates/{namespace} | |
| WorkflowTemplateServiceApi | updateWorkflowTemplate | PUT /api/v1/workflow-templates/{namespace}/{name} |
- AWSElasticBlockStoreVolumeSource
- ArchiveStrategy
- Arguments
- Artifact
- ArtifactLocation
- ArtifactRepositoryRef
- ArtifactoryArtifact
- ArtifactoryAuth
- AzureDiskVolumeSource
- AzureFileVolumeSource
- Backoff
- CSIVolumeSource
- Capabilities
- CephFSVolumeSource
- CinderVolumeSource
- ClusterClusterWorkflowTemplateCreateRequest
- ClusterClusterWorkflowTemplateLintRequest
- ClusterClusterWorkflowTemplateUpdateRequest
- ClusterWorkflowTemplate
- ClusterWorkflowTemplateList
- ConfigMapEnvSource
- ConfigMapProjection
- ConfigMapVolumeSource
- ContinueOn
- Counter
- CreateOptions
- CronCreateCronWorkflowRequest
- CronLintCronWorkflowRequest
- CronUpdateCronWorkflowRequest
- CronWorkflow
- CronWorkflowList
- CronWorkflowSpec
- CronWorkflowStatus
- DAGTask
- DAGTemplate
- DeleteOptions
- DownwardAPIProjection
- DownwardAPIVolumeFile
- DownwardAPIVolumeSource
- EmptyDirVolumeSource
- EnvVarSource
- ExecAction
- ExecutorConfig
- FCVolumeSource
- FieldsV1
- FlexVolumeSource
- FlockerVolumeSource
- GCEPersistentDiskVolumeSource
- GCSArtifact
- GCSBucket
- Gauge
- GetOptions
- GitArtifact
- GitRepoVolumeSource
- GlusterfsVolumeSource
- GoogleProtobufAny
- GrpcGatewayRuntimeStreamError
- HDFSArtifact
- HDFSConfig
- HDFSKrbConfig
- HTTPArtifact
- HTTPGetAction
- HTTPHeader
- Handler
- Histogram
- HostPathVolumeSource
- ISCSIVolumeSource
- InfoResponse
- Inputs
- IntOrString
- Item
- ItemValue
- KeyToPath
- LabelSelector
- LabelSelectorRequirement
- Link
- ListOptions
- LogEntry
- ManagedFieldsEntry
- Metadata
- MetricLabel
- Metrics
- NFSVolumeSource
- NodeAffinity
- NodeSelector
- NodeSelectorRequirement
- NodeSelectorTerm
- NodeStatus
- OSSArtifact
- OSSBucket
- ObjectFieldSelector
- Outputs
- OwnerReference
- ParallelSteps
- Parameter
- PersistentVolumeClaimCondition
- PersistentVolumeClaimSpec
- PersistentVolumeClaimStatus
- PersistentVolumeClaimVolumeSource
- PhotonPersistentDiskVolumeSource
- PodAffinity
- PodAffinityTerm
- PodAntiAffinity
- PodDNSConfigOption
- PodDisruptionBudgetSpec
- PodGC
- PodLogOptions
- PortworxVolumeSource
- Preconditions
- PreferredSchedulingTerm
- ProjectedVolumeSource
- Prometheus
- Quantity
- QuobyteVolumeSource
- RBDVolumeSource
- RawArtifact
- ResourceFieldSelector
- ResourceTemplate
- RetryStrategy
- S3Artifact
- S3Bucket
- SELinuxOptions
- ScaleIOVolumeSource
- ScriptTemplate
- SecretEnvSource
- SecretProjection
- SecretVolumeSource
- Sequence
- ServiceAccountTokenProjection
- StorageOSVolumeSource
- SuspendTemplate
- Sysctl
- TCPSocketAction
- TTLStrategy
- TarStrategy
- Template
- TemplateRef
- TypedLocalObjectReference
- UserContainer
- ValueFrom
- VolumeProjection
- VolumeSource
- VsphereVirtualDiskVolumeSource
- WeightedPodAffinityTerm
- WindowsSecurityContextOptions
- Workflow
- WorkflowCondition
- WorkflowCreateRequest
- WorkflowLintRequest
- WorkflowList
- WorkflowResubmitRequest
- WorkflowResumeRequest
- WorkflowRetryRequest
- WorkflowSpec
- WorkflowStatus
- WorkflowStep
- WorkflowStopRequest
- WorkflowSuspendRequest
- WorkflowTemplate
- WorkflowTemplateCreateRequest
- WorkflowTemplateLintRequest
- WorkflowTemplateList
- WorkflowTemplateSpec
- WorkflowTemplateUpdateRequest
- WorkflowTerminateRequest
- WorkflowWatchEvent
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
- Type: HTTP basic authentication
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.