Skip to content

Latest commit

 

History

History
517 lines (419 loc) · 17.8 KB

File metadata and controls

517 lines (419 loc) · 17.8 KB

ArgoWorkflowsClient.Api.ArtifactServiceApi

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

Method HTTP request Description
ArtifactServiceGetArtifactFile GET /artifact-files/{namespace}/{idDiscriminator}/{id}/{nodeId}/{artifactDiscriminator}/{artifactName} Get an artifact.
ArtifactServiceGetInputArtifact GET /input-artifacts/{namespace}/{name}/{nodeId}/{artifactName} Get an input artifact.
ArtifactServiceGetInputArtifactByUID GET /input-artifacts-by-uid/{uid}/{nodeId}/{artifactName} Get an input artifact by UID.
ArtifactServiceGetOutputArtifact GET /artifacts/{namespace}/{name}/{nodeId}/{artifactName} Get an output artifact.
ArtifactServiceGetOutputArtifactByUID GET /artifacts-by-uid/{uid}/{nodeId}/{artifactName} Get an output artifact by UID.

ArtifactServiceGetArtifactFile

System.IO.Stream ArtifactServiceGetArtifactFile (string varNamespace, string idDiscriminator, string id, string nodeId, string artifactName, string artifactDiscriminator)

Get an artifact.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;

namespace Example
{
    public class ArtifactServiceGetArtifactFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:2746";
            // Configure API key authorization: BearerToken
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ArtifactServiceApi(config);
            var varNamespace = "varNamespace_example";  // string | 
            var idDiscriminator = "workflow";  // string | 
            var id = "id_example";  // string | 
            var nodeId = "nodeId_example";  // string | 
            var artifactName = "artifactName_example";  // string | 
            var artifactDiscriminator = "outputs";  // string | 

            try
            {
                // Get an artifact.
                System.IO.Stream result = apiInstance.ArtifactServiceGetArtifactFile(varNamespace, idDiscriminator, id, nodeId, artifactName, artifactDiscriminator);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetArtifactFile: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArtifactServiceGetArtifactFileWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get an artifact.
    ApiResponse<System.IO.Stream> response = apiInstance.ArtifactServiceGetArtifactFileWithHttpInfo(varNamespace, idDiscriminator, id, nodeId, artifactName, artifactDiscriminator);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetArtifactFileWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
varNamespace string
idDiscriminator string
id string
nodeId string
artifactName string
artifactDiscriminator string

Return type

System.IO.Stream

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An artifact file. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ArtifactServiceGetInputArtifact

System.IO.Stream ArtifactServiceGetInputArtifact (string varNamespace, string name, string nodeId, string artifactName)

Get an input artifact.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;

namespace Example
{
    public class ArtifactServiceGetInputArtifactExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:2746";
            // Configure API key authorization: BearerToken
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ArtifactServiceApi(config);
            var varNamespace = "varNamespace_example";  // string | 
            var name = "name_example";  // string | 
            var nodeId = "nodeId_example";  // string | 
            var artifactName = "artifactName_example";  // string | 

            try
            {
                // Get an input artifact.
                System.IO.Stream result = apiInstance.ArtifactServiceGetInputArtifact(varNamespace, name, nodeId, artifactName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetInputArtifact: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArtifactServiceGetInputArtifactWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get an input artifact.
    ApiResponse<System.IO.Stream> response = apiInstance.ArtifactServiceGetInputArtifactWithHttpInfo(varNamespace, name, nodeId, artifactName);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetInputArtifactWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
varNamespace string
name string
nodeId string
artifactName string

Return type

System.IO.Stream

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An artifact file. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ArtifactServiceGetInputArtifactByUID

System.IO.Stream ArtifactServiceGetInputArtifactByUID (string uid, string nodeId, string artifactName)

Get an input artifact by UID.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;

namespace Example
{
    public class ArtifactServiceGetInputArtifactByUIDExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:2746";
            // Configure API key authorization: BearerToken
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ArtifactServiceApi(config);
            var uid = "uid_example";  // string | 
            var nodeId = "nodeId_example";  // string | 
            var artifactName = "artifactName_example";  // string | 

            try
            {
                // Get an input artifact by UID.
                System.IO.Stream result = apiInstance.ArtifactServiceGetInputArtifactByUID(uid, nodeId, artifactName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetInputArtifactByUID: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArtifactServiceGetInputArtifactByUIDWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get an input artifact by UID.
    ApiResponse<System.IO.Stream> response = apiInstance.ArtifactServiceGetInputArtifactByUIDWithHttpInfo(uid, nodeId, artifactName);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetInputArtifactByUIDWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
uid string
nodeId string
artifactName string

Return type

System.IO.Stream

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An artifact file. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ArtifactServiceGetOutputArtifact

System.IO.Stream ArtifactServiceGetOutputArtifact (string varNamespace, string name, string nodeId, string artifactName)

Get an output artifact.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;

namespace Example
{
    public class ArtifactServiceGetOutputArtifactExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:2746";
            // Configure API key authorization: BearerToken
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ArtifactServiceApi(config);
            var varNamespace = "varNamespace_example";  // string | 
            var name = "name_example";  // string | 
            var nodeId = "nodeId_example";  // string | 
            var artifactName = "artifactName_example";  // string | 

            try
            {
                // Get an output artifact.
                System.IO.Stream result = apiInstance.ArtifactServiceGetOutputArtifact(varNamespace, name, nodeId, artifactName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetOutputArtifact: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArtifactServiceGetOutputArtifactWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get an output artifact.
    ApiResponse<System.IO.Stream> response = apiInstance.ArtifactServiceGetOutputArtifactWithHttpInfo(varNamespace, name, nodeId, artifactName);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetOutputArtifactWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
varNamespace string
name string
nodeId string
artifactName string

Return type

System.IO.Stream

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An artifact file. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ArtifactServiceGetOutputArtifactByUID

System.IO.Stream ArtifactServiceGetOutputArtifactByUID (string uid, string nodeId, string artifactName)

Get an output artifact by UID.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;

namespace Example
{
    public class ArtifactServiceGetOutputArtifactByUIDExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:2746";
            // Configure API key authorization: BearerToken
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ArtifactServiceApi(config);
            var uid = "uid_example";  // string | 
            var nodeId = "nodeId_example";  // string | 
            var artifactName = "artifactName_example";  // string | 

            try
            {
                // Get an output artifact by UID.
                System.IO.Stream result = apiInstance.ArtifactServiceGetOutputArtifactByUID(uid, nodeId, artifactName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetOutputArtifactByUID: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArtifactServiceGetOutputArtifactByUIDWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get an output artifact by UID.
    ApiResponse<System.IO.Stream> response = apiInstance.ArtifactServiceGetOutputArtifactByUIDWithHttpInfo(uid, nodeId, artifactName);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ArtifactServiceApi.ArtifactServiceGetOutputArtifactByUIDWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
uid string
nodeId string
artifactName string

Return type

System.IO.Stream

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An artifact file. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]